sip.js.session.md
September 26, 2022 ยท View on GitHub
Session interface
Session.
Signature:
export interface Session
Remarks
https://tools.ietf.org/html/rfc3261\#section-13
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| answer | Body | undefined | The current answer if signalingState is stable. Otherwise undefined. | |
| callId | string | Call Id. | |
| delegate | SessionDelegate | undefined | Session delegate. | |
| id | string | The session id. Equal to callId + localTag + remoteTag. | |
| localTag | string | Local Tag. | |
| localURI | URI | Local URI. | |
| offer | Body | undefined | The current offer if signalingState is not initial or closed. Otherwise undefined. | |
| remoteTag | string | Remote Tag. | |
| remoteTarget | URI | Remote Target. | |
| remoteURI | URI | Remote URI. | |
| sessionState | SessionState | Session state. | |
| signalingState | SignalingState | Current state of the offer/answer exchange. |
Methods
| Method | Description |
|---|---|
| bye(delegate, options) | Send a BYE request. Terminating a session. https://tools.ietf.org/html/rfc3261\#section-15 |
| dispose() | Destroy session. |
| info(delegate, options) | Send an INFO request. Exchange information during a session. https://tools.ietf.org/html/rfc6086\#section-4.2.1 |
| invite(delegate, options) | Send re-INVITE request. Modifying a session. https://tools.ietf.org/html/rfc3261\#section-14.1 |
| message(delegate, options) | Send MESSAGE request. Deliver a message during a session. https://tools.ietf.org/html/rfc3428\#section-4 |
| notify(delegate, options) | Send NOTIFY request. Inform referrer of transfer progress. The use of this is limited to the implicit creation of subscription by REFER (historical). Otherwise, notifiers MUST NOT create subscriptions except upon receipt of a SUBSCRIBE request. https://tools.ietf.org/html/rfc3515\#section-3.7 |
| prack(delegate, options) | Send PRACK request. Acknowledge a reliable provisional response. https://tools.ietf.org/html/rfc3262\#section-4 |
| refer(delegate, options) | Send REFER request. Transfer a session. https://tools.ietf.org/html/rfc3515\#section-2.4.1 |