RemotePresenceView Class

Definition

Namespace:

Microsoft.Rtc.Collaboration.Presence

Assembly:

Microsoft.Rtc.Collaboration.dll

This class is used to fetch presence information for remote presentities from LocalEndpoint.

public ref class RemotePresenceView

public class RemotePresenceView

type RemotePresenceView = class

Public Class RemotePresenceView

Inheritance

Object

RemotePresenceView

Remarks

Choosing Polling results in each presentity's presence queried at fixed intervals specified by the PollingInterval parameter. The list of categories to poll for can be set using the method SetPresenceSubscriptionCategoriesForPolling(IEnumerable<String>).

Default results in the persistent subscription to presentities. The endpoint is then informed of any real-times changes to their presence information. In addition network optimizations are provided where if the subscription limit is reached on any presentity or the remote presentity is an automaton or a bot, then their presence is automatically polled for. This conserves network traffic and in the case of automatons, allow them to have more subscribers. Application who desire persistent subscription are strongly advised to use this mode.

Choosing Persistent is very similar to choosing Default except that the optimizations indicated in the end are not provided.

Multiple instances of RemotePresenceView can be created on an endpoint. The ApplicationContext can be used to differentiate one view from another. The same presentity can be added to different views and operations one each view is considered independent of other views.

Constructors

RemotePresenceView(LocalEndpoint)	Creates an instance of the RemotePresenceView class.
RemotePresenceView(LocalEndpoint, RemotePresenceViewSettings)	Creates an instance of the RemotePresenceView class.

Properties

ApplicationContext	Gets or sets an application-defined context.
PollingInterval	Gets the polling interval.
PresenceSubscriptionCategories	Gets the list of categories for which presence information will be returned.
SubscriberEndpoint	Gets the instance of endpoint to which this RemotePresenceView belongs.
SubscriptionMode	Gets the mode of subscription in this view.

Methods

BeginTerminate(AsyncCallback, Object)	Begins an asynchronous operation to dispose this view.
EndTerminate(IAsyncResult)	Ends the asynchronous operation started by BeginTerminate(AsyncCallback, Object).
GetPresentities()	Returns a snapshot of the list of targets in this view.
SetPresenceSubscriptionCategoriesForPolling(IEnumerable<String>)	Sets the presence subscription categories for polling.
StartSubscribingToPresentities(IEnumerable<RemotePresentitySubscriptionTarget>)	Start the operation to subscribe to the specified list of targets.
StartUnsubscribingToPresentities(IEnumerable<String>)	Start the operation to unsubscribe to the specified list of targets.

Events

PresenceNotificationReceived	Raised when presence notifications arrive for participants in this view.
SubscriptionStateChanged	Raised when subscription state changes for participants in this view.

Extension Methods

GetPresentitiesAddresses(RemotePresenceView)

GetPresentityCount(RemotePresenceView)