sip.js.subscription.md

Home > sip.js > Subscription

Subscription class

A subscription provides Notification of events.

Signature:

export declare abstract class Subscription 

Remarks

See Subscriber for details on establishing a subscription.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Subscription class.

Properties

Property	Modifiers	Type	Description
data		unknown	Property reserved for use by instance owner.
delegate		SubscriptionDelegate | undefined	Subscription delegate. See SubscriptionDelegate for details.
dialog		SubscriptionDialog | undefined	The subscribed subscription dialog.
state		SubscriptionState	Subscription state. See SubscriptionState for details.
stateChange		Emitter<SubscriptionState>	Emits when the subscription state property changes.

Methods

Method	Modifiers	Description
dispose()		Destructor.
subscribe(options)		Sends a re-SUBSCRIBE request if the subscription is "active".
unsubscribe(options)		Unsubscribe from event notifications.