PublishSubscribeSession Members

PublishSubscribeSession class provides a simplified wrapped implementation of ISipSubscriptionProcessor to establish, terminate subscription, processing the SipSubscription event.

The PublishSubscribeSession type exposes the following members.


Name Description
Public property IsSubscriptionActive Returns true if session has an active underlying subscription, else returns false.
Public property SubscriberEndpoint Endpoint of the subscriber, to be used in From address for subscription and publishing.
Protected property Subscription Returns the instance of the underlying subscription object.



Name Description
Protected method BeginPublishServiceRequest(String, ContentType, String, AsyncCallback, Object) This method will create a SipService Request for the given contentType and messageBody, service operation started with this method should be completed via calling the EndPublishServiceRequest method.
Protected method BeginPublishServiceRequest(String, ContentType, IEnumerable<(Of <<'(SignalingHeader>)>>), String, AsyncCallback, Object) This method will create a SipService Request for the given contentType, messageBody and additional custom headers.
Public method BeginRefresh
Public method BeginSubscribe Create the SipSubscriptionProcessor and invoke BeginSubscribe on the subscription.
Public method BeginUnsubscribe Invoke BeginTerminate on the subscription, if no underlying subscription exists, then completed as no operation.
Protected method EndPublishServiceRequest End the publish service request operation, which was initiated with StartPublishServiceRequest call.
Public method EndRefresh Complete the Refresh Operation initiated by BeginRefresh.
Public method EndSubscribe Complete the Subscribe operation initiated by BeginSubscribe.
Public method EndUnsubscribe End the async operation started by BeginUnSubscribe method call.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetEventPackageName All derived implementation classes should implement this method, the event package will be used for the subscription for this PublishSubscribeSession.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method RaiseEventViaEndpointQueue<(Of <<'(T>)>>)
Protected method ThrowIfEndpointAndSessionStateNotValid
Protected method ThrowIfEndpointNotEstablished [Value Needed].
Protected method ThrowIfSessionStateNotValid [Value Needed].
Public method ToString (Inherited from Object.)
Protected method Unbind Dispose of the processor so that subscribe may be called again.



Name Description
Public event SignalingSubscriptionStateChange SubscriptionStateChange event handler notes the change in underlying subscription states.


See Also


PublishSubscribeSession Class

Microsoft.Rtc.Collaboration.Presence Namespace