sip.js.invitation.md
September 26, 2022 ยท View on GitHub
Home > sip.js > Invitation
Invitation class
An invitation is an offer to establish a Session (incoming INVITE).
Signature:
export declare class Invitation extends Session
Extends: Session
Remarks
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Invitation class.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| autoSendAnInitialProvisionalResponse | boolean | If true, a first provisional response after the 100 Trying will be sent automatically. This is false it the UAC required reliable provisional responses (100rel in Require header) or the user agent configuration has specified to not send an initial response, otherwise it is true. The provisional is sent by calling progress() without any options. | |
| body | string | undefined | Initial incoming INVITE request message body. | |
| localIdentity | NameAddrHeader | The identity of the local user. | |
| logger | Logger | Logger. | |
| remoteIdentity | NameAddrHeader | The identity of the remote user. | |
| request | IncomingRequestMessage | Initial incoming INVITE request message. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| accept(options) | Accept the invitation. | |
| dispose() | Destructor. | |
| progress(options) | Indicate progress processing the invitation. | |
| reject(options) | Reject the invitation. |