RemotePresence Class

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.Presence

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.

Enables the owner endpoint to subscribe to the presence of other unified communications entities identified by their SIP URIs.

public ref class RemotePresence

public class RemotePresence

type RemotePresence = class

Public Class RemotePresence

Inheritance: Object
RemotePresence

Remarks

The unified communications entity being subscribed to can be in the same pool as the endpoint owner, another pool in the same forest, a Public Cloud entity (such as MSN/Yahoo/AOL user), or a Microsoft Lync 2010 user. Subscriptions to these users are handled differently, the. details of which are hidden from the application. All subscriptions to the same server are batched onto a single subscription for better performance. Thus, RemotePresence manages many subscriptions to different servers in an opaque manner.

Applications are notified of subscription failures by the PresenceSubscriptionStateChanged event.

By default, the presence categories subscribed to are "note", "state", "contactCard", "services" and "calendarData". However the application can change this by setting the PresenceSubscriptionCategories property appropriately.

One off presence queries can also be made to SIP URIs without fully subscribing to a unified communications entity by using the BeginPresenceQuery(IEnumerable<String>, String[], EventHandler<RemotePresenceNotificationEventArgs>, AsyncCallback, Object) method.

Properties

PresenceSubscriptionCategories	This property will be removed from future versions. Instead use PresenceSettings.RemotePresenceSubscritionCategories. Gets or sets the list of categories to subscribe for. Categories that are subscribed to by default are: "contactCard", "note", "state", "services", "calendarData".
SubscriberEndpoint	Gets the instance of associated local endpoint.

Methods

BeginAddTargets(ICollection<RemotePresentitySubscriptionTarget>, AsyncCallback, Object)	Begins an asynchronous operation to add a target in the subscription dispatcher and to start the subscription for the given target.
BeginPresenceQuery(IEnumerable<String>, String[], EventHandler<RemotePresenceNotificationEventArgs>, AsyncCallback, Object)	Begins a presence query request for a given list of targets for the given set of presence categories.
BeginRefresh(AsyncCallback, Object)	Begins an asynchronous operation to refresh the notifications.
BeginRemoveAllTargets(AsyncCallback, Object)	Begins an asynchronous operation to unsubscribe to all existing subscriptions that are not already terminating.
BeginRemoveTarget(String, AsyncCallback, Object)	Begins an asynchronous operation to unsubscribe to a target.
EndAddTargets(IAsyncResult)	Ends the asynchronous operation started by BeginAddTargets(ICollection<RemotePresentitySubscriptionTarget>, AsyncCallback, Object).
EndPresenceQuery(IAsyncResult)	Ends the asynchronous operation initiated by the BeginPresenceQuery.
EndRefresh(IAsyncResult)	Ends the asynchronous operation started by BeginRefresh(AsyncCallback, Object).
EndRemoveAllTargets(IAsyncResult)	Ends the asynchronous operation started by BeginRemoveAllTargets(AsyncCallback, Object).
EndRemoveTarget(IAsyncResult)	Ends the asynchronous operation started by BeginRemoveTarget(String, AsyncCallback, Object).
GetCurrentSubscriptionState(String)	Gets the current subscription state for a given target.

Events

PresenceNotificationReceived	Raised when presence state changes for any target on the subscription.
PresenceSubscriptionStateChanged	Raised when subscription state changes for any target.

Applies to

Share via