ExchangeService.BeginSubscribeToPushNotifications Method

Definition

Namespace:

Microsoft.Exchange.WebServices.Data

Assembly:

Microsoft.Exchange.WebServices.dll

Overloads

BeginSubscribeToPushNotifications(AsyncCallback, Object, IEnumerable<FolderId>, Uri, Int32, String, EventType[])

Begins an asynchronous request to subscribe to push notifications. The BeginSubscribeToPushNotifications(AsyncCallback, Object, IEnumerable<FolderId>, Uri, Int32, String, EventType[]) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

BeginSubscribeToPushNotifications(AsyncCallback, Object, IEnumerable<FolderId>, Uri, Int32, String, String, EventType[])

Begins an asynchronous request to subscribe to push notifications that includes a request for additional information to be returned in the push notification response. The BeginSubscribeToPushNotifications(AsyncCallback, Object, 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.

BeginSubscribeToPushNotifications(AsyncCallback, Object, IEnumerable<FolderId>, Uri, Int32, String, EventType[])

Begins an asynchronous request to subscribe to push notifications. The BeginSubscribeToPushNotifications(AsyncCallback, Object, IEnumerable<FolderId>, Uri, Int32, String, EventType[]) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

public:
 IAsyncResult ^ BeginSubscribeToPushNotifications(AsyncCallback ^ callback, System::Object ^ state, 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 IAsyncResult BeginSubscribeToPushNotifications (AsyncCallback callback, object state, 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 BeginSubscribeToPushNotifications (callback As AsyncCallback, state As Object, folderIds As IEnumerable(Of FolderId), url As Uri, frequency As Integer, watermark As String, ParamArray eventTypes As EventType()) As IAsyncResult

Parameters

callback

AsyncCallback

A reference to the method to call when the corresponding asynchronous operation completes.

state

Object

An object that contains state information for the specified request.

folderIds

IEnumerable<FolderId>

The folder identifiers of the folder to be subscribed to.

url

Uri

The URL of the web service endpoint to which the Exchange server should push events.

frequency

Int32

The interval, in minutes, at which the Exchange server is to contact the web service endpoint. This value must be in the range from 1 through 1440.

watermark

String

An optional watermark representing a previously opened subscription.

eventTypes

EventType[]

The event types to be subscribed to.

Returns

IAsyncResult

A synchronization result object that references the asynchronous request.

Remarks

Calling this method results in a call to Exchange Web Services (EWS).

BeginSubscribeToPushNotifications(AsyncCallback, Object, IEnumerable<FolderId>, Uri, Int32, String, String, EventType[])

Begins an asynchronous request to subscribe to push notifications that includes a request for additional information to be returned in the push notification response. The BeginSubscribeToPushNotifications(AsyncCallback, Object, 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:
 IAsyncResult ^ BeginSubscribeToPushNotifications(AsyncCallback ^ callback, System::Object ^ state, 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 IAsyncResult BeginSubscribeToPushNotifications (AsyncCallback callback, object state, 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 BeginSubscribeToPushNotifications (callback As AsyncCallback, state As Object, folderIds As IEnumerable(Of FolderId), url As Uri, frequency As Integer, watermark As String, callerData As String, ParamArray eventTypes As EventType()) As IAsyncResult

Parameters

callback

AsyncCallback

A reference to the method to call when the corresponding asynchronous operation completes.

state

Object

An object that contains state information for this request.

folderIds

IEnumerable<FolderId>

The IDs of the folders 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 event types to subscribe to.

Returns

IAsyncResult

An object that references the asynchronous request.

Remarks

Calling this method results in a call to Exchange Web Services (EWS).