LocalEndpointPresenceServices.BeginPresenceQuery Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration

Assembly:: Microsoft.Rtc.Collaboration.dll

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.

Begins a presence query request for a given list of targets for the given set of presence categories.

public:
 IAsyncResult ^ BeginPresenceQuery(System::Collections::Generic::IEnumerable<System::String ^> ^ targets, cli::array <System::String ^> ^ categories, EventHandler<Microsoft::Rtc::Collaboration::Presence::RemotePresentitiesNotificationEventArgs ^> ^ queryResultHandler, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginPresenceQuery (System.Collections.Generic.IEnumerable<string> targets, string[] categories, EventHandler<Microsoft.Rtc.Collaboration.Presence.RemotePresentitiesNotificationEventArgs> queryResultHandler, AsyncCallback userCallback, object state);

member this.BeginPresenceQuery : seq<string> * string[] * EventHandler<Microsoft.Rtc.Collaboration.Presence.RemotePresentitiesNotificationEventArgs> * AsyncCallback * obj -> IAsyncResult

Public Function BeginPresenceQuery (targets As IEnumerable(Of String), categories As String(), queryResultHandler As EventHandler(Of RemotePresentitiesNotificationEventArgs), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

targets: IEnumerable<String>

The list of target addresses for the query.

categories: String[]

The list of presence categories for the query. Categories that can be set are "contactCard", "note", "state", "services", and "calendarData".

queryResultHandler: EventHandler<RemotePresentitiesNotificationEventArgs>

EventHandler to be invoked as results become available. This value can be null.

userCallback: AsyncCallback

The method to be called when the asynchronous operation is completed. This value can be null.

state: Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentNullException

Thrown when targets is null.

ArgumentException

Thrown when targets is an empty collection, or when it contains a null member, or when there are no new targets to be added or removed.

Remarks

A presence query internally can involve multiple query requests to different single and pool targets. If the user specified a query result handler, then results will be notified on the given event handler as soon as they are available. Calling EndPresenceQuery will return all results for the query.

Applies to