diff --git a/docs/api/sip.js.useragentoptions.authorizationha1.md b/docs/api/sip.js.useragentoptions.authorizationha1.md new file mode 100644 index 000000000..48dc5bba5 --- /dev/null +++ b/docs/api/sip.js.useragentoptions.authorizationha1.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sip.js](./sip.js.md) > [UserAgentOptions](./sip.js.useragentoptions.md) > [authorizationHa1](./sip.js.useragentoptions.authorizationha1.md) + +## UserAgentOptions.authorizationHa1 property + +Authorization ha1. + +Signature: + +```typescript +authorizationHa1?: string; +``` diff --git a/docs/api/sip.js.useragentoptions.md b/docs/api/sip.js.useragentoptions.md index 793d29d47..1c81d8ea3 100644 --- a/docs/api/sip.js.useragentoptions.md +++ b/docs/api/sip.js.useragentoptions.md @@ -17,6 +17,7 @@ export interface UserAgentOptions | Property | Type | Description | | --- | --- | --- | | [allowLegacyNotifications](./sip.js.useragentoptions.allowlegacynotifications.md) | boolean | If true, the user agent will accept out of dialog NOTIFY. | +| [authorizationHa1](./sip.js.useragentoptions.authorizationha1.md) | string | Authorization ha1. | | [authorizationPassword](./sip.js.useragentoptions.authorizationpassword.md) | string | Authorization password. | | [authorizationUsername](./sip.js.useragentoptions.authorizationusername.md) | string | Authorization username. | | [autoStart](./sip.js.useragentoptions.autostart.md) | boolean | | diff --git a/docs/core/sip.js.sessiondialog.md b/docs/core/sip.js.sessiondialog.md index a96200306..ab9bea98f 100644 --- a/docs/core/sip.js.sessiondialog.md +++ b/docs/core/sip.js.sessiondialog.md @@ -46,7 +46,7 @@ export declare class SessionDialog extends Dialog implements Session | [receiveRequest(message)](./sip.js.sessiondialog.receiverequest.md) | | Requests sent within a dialog, as any other requests, are atomic. If a particular request is accepted by the UAS, all the state changes associated with it are performed. If the request is rejected, none of the state changes are performed. https://tools.ietf.org/html/rfc3261\#section-12.2.2 | | [reConfirm()](./sip.js.sessiondialog.reconfirm.md) | | Re-confirm the dialog. Only matters if handling re-INVITE request. | | [refer(delegate, options)](./sip.js.sessiondialog.refer.md) | | REFER is a SIP request and is constructed as defined in \[1\]. A REFER request MUST contain exactly one Refer-To header field value. https://tools.ietf.org/html/rfc3515\#section-2.4.1 | -| [reliableSequenceGuard(message)](./sip.js.sessiondialog.reliablesequenceguard.md) | | | +| [reliableSequenceGuard(message)](./sip.js.sessiondialog.reliablesequenceguard.md) | | Guard against out of order reliable provisional responses and retransmissions. Returns false if the response should be discarded, otherwise true. | | [signalingStateRollback()](./sip.js.sessiondialog.signalingstaterollback.md) | | If not in a stable signaling state, rollback to prior stable signaling state. | | [signalingStateTransition(message)](./sip.js.sessiondialog.signalingstatetransition.md) | | Update the signaling state of the dialog. | diff --git a/docs/core/sip.js.sessiondialog.reliablesequenceguard.md b/docs/core/sip.js.sessiondialog.reliablesequenceguard.md index e430fac2a..a189c540a 100644 --- a/docs/core/sip.js.sessiondialog.reliablesequenceguard.md +++ b/docs/core/sip.js.sessiondialog.reliablesequenceguard.md @@ -4,6 +4,8 @@ ## SessionDialog.reliableSequenceGuard() method +Guard against out of order reliable provisional responses and retransmissions. Returns false if the response should be discarded, otherwise true. + Signature: ```typescript @@ -14,7 +16,7 @@ reliableSequenceGuard(message: IncomingResponseMessage): boolean; | Parameter | Type | Description | | --- | --- | --- | -| message | IncomingResponseMessage | | +| message | IncomingResponseMessage | Incoming response message within this dialog. | Returns: diff --git a/etc/api/sip.js.api.md b/etc/api/sip.js.api.md index e53ca2f25..99ff188a6 100644 --- a/etc/api/sip.js.api.md +++ b/etc/api/sip.js.api.md @@ -805,6 +805,7 @@ export interface UserAgentDelegate { // @public export interface UserAgentOptions { allowLegacyNotifications?: boolean; + authorizationHa1?: string; authorizationPassword?: string; authorizationUsername?: string; // @deprecated (undocumented) diff --git a/etc/core/sip.js.api.md b/etc/core/sip.js.api.md index 4ae67d404..2d2c83514 100644 --- a/etc/core/sip.js.api.md +++ b/etc/core/sip.js.api.md @@ -170,7 +170,7 @@ export interface DialogState { // // @internal export class DigestAuthentication { - constructor(loggerFactory: LoggerFactory, username: string | undefined, password: string | undefined); + constructor(loggerFactory: LoggerFactory, ha1: string | undefined, username: string | undefined, password: string | undefined); authenticate(request: OutgoingRequestMessage, challenge: any, body?: string): boolean; // (undocumented) stale: boolean | undefined; @@ -921,7 +921,6 @@ export class SessionDialog extends Dialog implements Session { reinviteUserAgentClient: ReInviteUserAgentClient | undefined; // (undocumented) reinviteUserAgentServer: ReInviteUserAgentServer | undefined; - // (undocumented) reliableSequenceGuard(message: IncomingResponseMessage): boolean; // (undocumented) get sessionState(): SessionState;