PushSubscriptionRequestType
extends BaseSubscriptionRequestType
in package
Represents a subscription to a push-based event notification subscription.
Table of Contents
Properties
- $EventTypes : NonEmptyArrayOfNotificationEventTypesType
- Contains a collection of event notifications that are used to create a subscription.
- $FolderIds : NonEmptyArrayOfBaseFolderIdsType
- Contains an array of folder identifiers that are used to identify folders to monitor for event notifications.
- $StatusFrequency : int
- Represents the frequency, specified in minutes, at which notification messages will be sent to the client when no events have occurred.
- $SubscribeToAllFolders : bool
- Indicates whether to subscribe to all available folders.
- $URL : string
- Represents the location of the client Web service for push notifications.
- $Watermark : string
- Represents an event bookmark in the mailbox events table.
Methods
- __clone() : mixed
- Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
Properties
$EventTypes
Contains a collection of event notifications that are used to create a subscription.
public
NonEmptyArrayOfNotificationEventTypesType
$EventTypes
Tags
$FolderIds
Contains an array of folder identifiers that are used to identify folders to monitor for event notifications.
public
NonEmptyArrayOfBaseFolderIdsType
$FolderIds
Tags
$StatusFrequency
Represents the frequency, specified in minutes, at which notification messages will be sent to the client when no events have occurred.
public
int
$StatusFrequency
Tags
$SubscribeToAllFolders
Indicates whether to subscribe to all available folders.
public
bool
$SubscribeToAllFolders
This attribute is optional.
Tags
$URL
Represents the location of the client Web service for push notifications.
public
string
$URL
Tags
$Watermark
Represents an event bookmark in the mailbox events table.
public
string
$Watermark
This is used to create a subscription starting at an event represented by the watermark.
If the watermark from a Subscribe request is not found, an error response will be returned to the client. This may occur if the watermark is older than 30 days or if the watermark was never present in the mailbox.
Tags
Methods
__clone()
Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
public
__clone() : mixed