sip.js.subscription.md
September 26, 2022 ยท View on GitHub
Home > sip.js > Subscription
Subscription interface
Subscription.
Signature:
export interface Subscription
Remarks
https://tools.ietf.org/html/rfc6665
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| autoRefresh | boolean | If true, refresh subscription prior to expiration. Default is false. | |
| delegate | SubscriptionDelegate | undefined | Subscription delegate. | |
| id | string | The subscription id. | |
| subscriptionExpires | number | Subscription expires. Number of seconds until the subscription expires. | |
| subscriptionState | SubscriptionState | Subscription state. |
Methods
| Method | Description |
|---|---|
| dispose() | Destroy subscription. |
| refresh() | 4.1.2.2. Refreshing of Subscriptions https://tools.ietf.org/html/rfc6665\#section-4.1.2.2 |
| subscribe(delegate, options) | Send re-SUBSCRIBE request. Refreshing a subscription and unsubscribing. https://tools.ietf.org/html/rfc6665\#section-4.1.2.2 |
| unsubscribe() | 4.1.2.3. Unsubscribing https://tools.ietf.org/html/rfc6665\#section-4.1.2.3 |