Home > sip.js > SubscriptionDialog
Subscription Dialog.
Signature:
export declare class SubscriptionDialog extends Dialog implements Subscription SIP-Specific Event Notification
Abstract
This document describes an extension to the Session Initiation Protocol (SIP) defined by RFC 3261. The purpose of this extension is to provide an extensible framework by which SIP nodes can request notification from remote nodes indicating that certain events have occurred.
Note that the event notification mechanisms defined herein are NOT intended to be a general-purpose infrastructure for all classes of event subscription and notification.
This document represents a backwards-compatible improvement on the original mechanism described by RFC 3265, taking into account several years of implementation experience. Accordingly, this document obsoletes RFC 3265. This document also updates RFC 4660 slightly to accommodate some small changes to the mechanism that were discussed in that document.
https://tools.ietf.org/html/rfc6665
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(subscriptionEvent, subscriptionExpires, subscriptionState, core, state, delegate) | Constructs a new instance of the SubscriptionDialog class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| autoRefresh | boolean |
||
| delegate | SubscriptionDelegate | undefined |
||
| subscriptionEvent | string |
||
| subscriptionExpires | number |
Number of seconds until subscription expires. | |
| subscriptionExpiresInitial | number |
||
| subscriptionRefresh | number | undefined |
Number of seconds until subscription auto refresh. | |
| subscriptionState | SubscriptionState |
| Method | Modifiers | Description |
|---|---|---|
| dispose() | ||
| initialDialogStateForSubscription(outgoingSubscribeRequestMessage, incomingNotifyRequestMessage) | static |
When a UAC receives a response that establishes a dialog, it constructs the state of the dialog. This state MUST be maintained for the duration of the dialog. https://tools.ietf.org/html/rfc3261\#section-12.1.2 |
| receiveRequest(message) | Receive in dialog request message from transport. | |
| refresh() | 4.1.2.2. Refreshing of Subscriptions https://tools.ietf.org/html/rfc6665\#section-4.1.2.2 | |
| subscribe(delegate, options) | 4.1.2.2. Refreshing of Subscriptions https://tools.ietf.org/html/rfc6665\#section-4.1.2.2 | |
| terminate() | 4.4.1. Dialog Creation and Termination A subscription is destroyed after a notifier sends a NOTIFY request with a "Subscription-State" of "terminated", or in certain error situations described elsewhere in this document. https://tools.ietf.org/html/rfc6665\#section-4.4.1 | |
| unsubscribe() | 4.1.2.3. Unsubscribing https://tools.ietf.org/html/rfc6665\#section-4.1.2.3 |