ExchangeService.SubscribeToPushNotifications Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, EventType[]) |
Initiates a request for a client to receive push notifications. The SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, EventType[]) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2010. |
| SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, String, EventType[]) |
Initiates a request to receive push notifications that includes a request for additional information to be returned in the push notification response. The SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, String, EventType[]) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013. |
SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, EventType[])
Initiates a request for a client to receive push notifications. The SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, EventType[]) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2010.
public:
Microsoft::Exchange::WebServices::Data::PushSubscription ^ SubscribeToPushNotifications(System::Collections::Generic::IEnumerable<Microsoft::Exchange::WebServices::Data::FolderId ^> ^ folderIds, Uri ^ url, int frequency, System::String ^ watermark, ... cli::array <Microsoft::Exchange::WebServices::Data::EventType> ^ eventTypes);public Microsoft.Exchange.WebServices.Data.PushSubscription SubscribeToPushNotifications (System.Collections.Generic.IEnumerable<Microsoft.Exchange.WebServices.Data.FolderId> folderIds, Uri url, int frequency, string watermark, params Microsoft.Exchange.WebServices.Data.EventType[] eventTypes);Public Function SubscribeToPushNotifications (folderIds As IEnumerable(Of FolderId), url As Uri, frequency As Integer, watermark As String, ParamArray eventTypes As EventType()) As PushSubscriptionParameters
- folderIds
- IEnumerable<FolderId>
The IDs of the folders to subscribe to.
- url
- Uri
The URL of the web service endpoint to which the server should push events.
- frequency
- Int32
The interval, in minutes, at which the server is to contact the web service endpoint. The value of this parameter must be in the range from 1 to 1440.
- watermark
- String
An optional watermark that represents a previously opened subscription.
- eventTypes
- EventType[]
The types of events to subscribe to.
Returns
A subscription response object.
Remarks
Calling this method results in a call to Exchange Web Services (EWS).
Applies to
SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, String, EventType[])
Initiates a request to receive push notifications that includes a request for additional information to be returned in the push notification response. The SubscribeToPushNotifications(IEnumerable<FolderId>, Uri, Int32, String, String, EventType[]) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.
public:
Microsoft::Exchange::WebServices::Data::PushSubscription ^ SubscribeToPushNotifications(System::Collections::Generic::IEnumerable<Microsoft::Exchange::WebServices::Data::FolderId ^> ^ folderIds, Uri ^ url, int frequency, System::String ^ watermark, System::String ^ callerData, ... cli::array <Microsoft::Exchange::WebServices::Data::EventType> ^ eventTypes);public Microsoft.Exchange.WebServices.Data.PushSubscription SubscribeToPushNotifications (System.Collections.Generic.IEnumerable<Microsoft.Exchange.WebServices.Data.FolderId> folderIds, Uri url, int frequency, string watermark, string callerData, params Microsoft.Exchange.WebServices.Data.EventType[] eventTypes);Public Function SubscribeToPushNotifications (folderIds As IEnumerable(Of FolderId), url As Uri, frequency As Integer, watermark As String, callerData As String, ParamArray eventTypes As EventType()) As PushSubscriptionParameters
- folderIds
- IEnumerable<FolderId>
The IDs of the folder to subscribe to.
- url
- Uri
The URL of the web service endpoint the Exchange server should push events to.
- frequency
- Int32
The frequency, in minutes, at which the Exchange server should contact the web service endpoint. This value must be between 1 and 1440.
- watermark
- String
An optional watermark representing a previously opened subscription.
- callerData
- String
Optional information that the caller requests be returned in the push notification response.
- eventTypes
- EventType[]
The types of event to subscribe to.
Returns
A collection of notification objects.
Remarks
Calling this method results in a call to Exchange Web Services (EWS).