built docs

onsip · Jun 8, 2020 · ec81c7e · ec81c7e
1 parent f8d580c
commit ec81c7e
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 4 deletions.
diff --git a/docs/api/sip.js.useragentoptions.authorizationha1.md b/docs/api/sip.js.useragentoptions.authorizationha1.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [UserAgentOptions](./sip.js.useragentoptions.md) &gt; [authorizationHa1](./sip.js.useragentoptions.authorizationha1.md)
+
+## UserAgentOptions.authorizationHa1 property
+
+Authorization ha1.
+
+<b>Signature:</b>
+
+```typescript
+authorizationHa1?: string;
+```
diff --git 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) | <code>boolean</code> | If <code>true</code>, the user agent will accept out of dialog NOTIFY. |
+|  [authorizationHa1](./sip.js.useragentoptions.authorizationha1.md) | <code>string</code> | Authorization ha1. |
 |  [authorizationPassword](./sip.js.useragentoptions.authorizationpassword.md) | <code>string</code> | Authorization password. |
 |  [authorizationUsername](./sip.js.useragentoptions.authorizationusername.md) | <code>string</code> | Authorization username. |
 |  [autoStart](./sip.js.useragentoptions.autostart.md) | <code>boolean</code> |  |

diff --git 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
@@ -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.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,7 +16,7 @@ reliableSequenceGuard(message: IncomingResponseMessage): boolean;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  message | <code>IncomingResponseMessage</code> |  |
+|  message | <code>IncomingResponseMessage</code> | Incoming response message within this dialog. |
 
 <b>Returns:</b>
 

diff --git 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
@@ -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;