sip.js.session.md
September 26, 2022 ยท View on GitHub
Session class
A session provides real time communication between one or more participants.
Signature:
export declare abstract class Session
Remarks
The transport behaves in a deterministic manner according to the the state defined in SessionState.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Session class.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| assertedIdentity | NameAddrHeader | undefined | The asserted identity of the remote user. | |
| data | unknown | Property reserved for use by instance owner. | |
| delegate | SessionDelegate | undefined | The session delegate. | |
| dialog | SessionDialog | undefined | The confirmed session dialog. | |
| id | string | A unique identifier for this session. | |
| localIdentity | NameAddrHeader | The identity of the local user. | |
| logger | Logger | Logger. | |
| remoteIdentity | NameAddrHeader | The identity of the remote user. | |
| replacee | Session | undefined | The session being replace by this one. | |
| sessionDescriptionHandler | SessionDescriptionHandler | undefined | Session description handler. | |
| sessionDescriptionHandlerFactory | SessionDescriptionHandlerFactory | Session description handler factory. | |
| sessionDescriptionHandlerModifiers | Array<SessionDescriptionHandlerModifier> | SDH modifiers for the initial INVITE transaction. | |
| sessionDescriptionHandlerModifiersReInvite | Array<SessionDescriptionHandlerModifier> | SDH modifiers for re-INVITE transactions. | |
| sessionDescriptionHandlerOptions | SessionDescriptionHandlerOptions | SDH options for the initial INVITE transaction. | |
| sessionDescriptionHandlerOptionsReInvite | SessionDescriptionHandlerOptions | SDH options for re-INVITE transactions. | |
| state | SessionState | Session state. | |
| stateChange | Emitter<SessionState> | Session state change emitter. | |
| userAgent | UserAgent | The user agent. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| bye(options) | End the Session. Sends a BYE. | |
| dispose() | Destructor. | |
| info(options) | Share Info with peer. Sends an INFO. | |
| invite(options) | Renegotiate the session. Sends a re-INVITE. | |
| message(options) | Deliver a Message. Sends a MESSAGE. | |
| refer(referTo, options) | Proffer a Referral. Send a REFER. |