sip.js.useragentclient.cancel.md

Home > sip.js > UserAgentClient > cancel

UserAgentClient.cancel() method

Since requests other than INVITE are responded to immediately, sending a CANCEL for a non-INVITE request would always create a race condition. A CANCEL request SHOULD NOT be sent to cancel a request other than INVITE. https://tools.ietf.org/html/rfc3261\#section-9.1

Signature:

cancel(reason?: string, options?: RequestOptions): OutgoingRequestMessage;

Parameters

Parameter	Type	Description
reason	string
options	RequestOptions	Cancel options bucket.

Returns:

OutgoingRequestMessage