PublishSubscribeSession 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.

The PublishSubscribeSession class provides a simplified wrapper to establish and terminate subscription and to process the SipSubscription events. It also handles service requests asynchronously.

public ref class PublishSubscribeSession abstract

public abstract class PublishSubscribeSession

type PublishSubscribeSession = class

Public MustInherit Class PublishSubscribeSession

Inheritance: Object
PublishSubscribeSession

Derived: Microsoft.Rtc.Collaboration.ContactsGroups.ContactGroupServices

Microsoft.Rtc.Collaboration.Presence.LocalOwnerPresence

Remarks

This is the base class for the LocalOwnerPresence and ContactGroupServices classes. PublishSubscribeSession provides common operations to create, refresh, and terminate subscriptions. It internally creates and manages a SipSubscription dialog to the Microsoft Communications Server server.

Properties

CurrentState	Gets the state of the subscription.
IsSubscriptionActive	Obsolete. Gets whether the session has an active underlying subscription.
SubscriberEndpoint	Gets the endpoint that the subscription belongs to.

Methods

BeginRefresh(AsyncCallback, Object)	Begins an asynchronous operation to refresh the underlying subscription.
BeginSubscribe(AsyncCallback, Object)	Begins an asynchronous operation to subscribe to the presence session.
BeginUnsubscribe(AsyncCallback, Object)	Begins an asynchronous operation to unsubscribe the underlying subscription.
EndRefresh(IAsyncResult)	Ends the Refresh Operation initiated by BeginRefresh.
EndSubscribe(IAsyncResult)	Ends the Subscribe operation initiated by BeginSubscribe.
EndUnsubscribe(IAsyncResult)	Ends the asynchronous operation started by BeginUnsubscribe method.

Events

SubscriptionStateChange

Raised when there are changes in the underlying subscription state.

Applies to