Documentation

InviteReply
in package
implements NotificationInterface

This class represents the cs:invite-reply notification element.

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Evert Pot (http://evertpot.com/)

license

http://sabre.io/license/ Modified BSD License

Interfaces, Classes and Traits

NotificationInterface
This interface reflects a single notification type.

Table of Contents

$dtStamp  : DateTime
Timestamp of the notification.
$etag  : string
Notification Etag.
$hostUrl  : string
A url to the shared calendar.
$href  : string
A url to the recipient of the original (!) notification.
$id  : string
A unique id for the message.
$inReplyTo  : string
The unique id of the notification this was a reply to.
$summary  : string
A description of the share request.
$type  : int
The type of message, see the SharingPlugin::STATUS_ constants.
__construct()  : mixed
Creates the Invite Reply Notification.
getETag()  : string
Returns the ETag for this notification.
getId()  : string
Returns a unique id for this notification.
xmlSerialize()  : mixed
The xmlSerialize method is called during xml writing.
xmlSerializeFull()  : mixed
This method serializes the entire notification, as it is used in the response body.

Properties

$dtStamp

Timestamp of the notification.

protected DateTime $dtStamp

$hostUrl

A url to the shared calendar.

protected string $hostUrl

$href

A url to the recipient of the original (!) notification.

protected string $href

$id

A unique id for the message.

protected string $id

$inReplyTo

The unique id of the notification this was a reply to.

protected string $inReplyTo

$summary

A description of the share request.

protected string $summary

$type

The type of message, see the SharingPlugin::STATUS_ constants.

protected int $type

Methods

__construct()

Creates the Invite Reply Notification.

public __construct(array<string|int, mixed> $values) : mixed

This constructor receives an array with the following elements:

  • id - A unique id
  • etag - The etag
  • dtStamp - A DateTime object with a timestamp for the notification.
  • inReplyTo - This should refer to the 'id' of the notification this is a reply to.
  • type - The type of notification, see SharingPlugin::STATUS_* constants for details.
  • hostUrl - A url to the shared calendar.
  • summary - Description of the share, can be the same as the calendar, but may also be modified (optional).
Parameters
$values : array<string|int, mixed>
Return values
mixed —

getETag()

Returns the ETag for this notification.

public getETag() : string

The ETag must be surrounded by literal double-quotes.

Return values
string —

getId()

Returns a unique id for this notification.

public getId() : string

This is just the base url. This should generally be some kind of unique id.

Return values
string —

xmlSerialize()

The xmlSerialize method is called during xml writing.

public xmlSerialize(Writer $writer) : mixed

Use the $writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializable should only ever write what's considered its 'inner xml'.

The parent of the current element is responsible for writing a containing element.

This allows serializers to be re-used for different element names.

If you are opening new elements, you must also close them again.

Parameters
$writer : Writer
Return values
mixed —

xmlSerializeFull()

This method serializes the entire notification, as it is used in the response body.

public xmlSerializeFull(Writer $writer) : mixed
Parameters
$writer : Writer
Return values
mixed —

Search results