ReferStatus Class

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Represents the state of the Refer operation.
This object is created by the application sending the Refer message to track the status of the Refer as carried out by the remote endpoint. The notifications sent by the remote endpoint are reflected in this instance.

public ref class ReferStatus

public class ReferStatus

type ReferStatus = class

Public Class ReferStatus

Inheritance

Object

ReferStatus

Constructors

ReferStatus()	Initializes a new instance of the class.
ReferStatus(Object)	Initializes this instance with the given application context.

Properties

ApplicationContext	Gets the application context.
IsSubscriptionActive	Gets the flag indicating whether the subscription for notification is active or not.
Session	Gets the signaling session that is tracking this Refer status. This property can be null if it is not associated with any session.
State	Gets the current state of the Refer operation as carried out by the remote endpoint.

Methods

BeginTerminateSubscription(AsyncCallback, Object)	Terminates this refer subscription. The subscription is active until terminating Notify message is received. If the application is not interested in waiting for the notification messages, this method can be used to terminate the underlying subscription for these notification messages. The refer state will not be affected by this operation.
EndTerminateSubscription(IAsyncResult)	Waits for the pending TerminateSubscription operation to complete.
TerminateSubscription()	Terminates this refer subscription. The subscription is active until terminating Notify message is received. If the application is not interested in waiting for the notification messages, this method can be used to terminate the underlying subscription for these notification messages. The refer state will not be affected by this operation.

Events

StateChanged

Raised when the state of the session changes.