Version 0.20.0 (and update docs)

onsip · Mar 16, 2021 · 5555a98 · 5555a98
1 parent 3a47552
commit 5555a98
Show file tree

Hide file tree

Showing 13 changed files with 107 additions and 6 deletions.
diff --git a/docs/api/sip.js.ack.md b/docs/api/sip.js.ack.md
@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [Ack](./sip.js.ack.md)
+
+## Ack class
+
+A request to confirm a [Session](./sip.js.session.md) (incoming ACK).
+
+<b>Signature:</b>
+
+```typescript
+export declare class Ack 
+```
+
+## 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 `Ack` class.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [request](./sip.js.ack.request.md) |  | <code>IncomingRequestMessage</code> | Incoming ACK request message. |
+
diff --git a/docs/api/sip.js.ack.request.md b/docs/api/sip.js.ack.request.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; [Ack](./sip.js.ack.md) &gt; [request](./sip.js.ack.request.md)
+
+## Ack.request property
+
+Incoming ACK request message.
+
+<b>Signature:</b>
+
+```typescript
+get request(): IncomingRequestMessage;
+```
diff --git a/docs/api/sip.js.invitationacceptoptions.extraheaders.md b/docs/api/sip.js.invitationacceptoptions.extraheaders.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; [InvitationAcceptOptions](./sip.js.invitationacceptoptions.md) &gt; [extraHeaders](./sip.js.invitationacceptoptions.extraheaders.md)
+
+## InvitationAcceptOptions.extraHeaders property
+
+Array of extra headers added to the response.
+
+<b>Signature:</b>
+
+```typescript
+extraHeaders?: Array<string>;
+```
diff --git a/docs/api/sip.js.invitationacceptoptions.md b/docs/api/sip.js.invitationacceptoptions.md
@@ -16,6 +16,7 @@ export interface InvitationAcceptOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [extraHeaders](./sip.js.invitationacceptoptions.extraheaders.md) | <code>Array&lt;string&gt;</code> | Array of extra headers added to the response. |
 |  [sessionDescriptionHandlerModifiers](./sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. |
 |  [sessionDescriptionHandlerOptions](./sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. |
 
diff --git a/docs/api/sip.js.md b/docs/api/sip.js.md
@@ -10,6 +10,7 @@ A simple yet powerful API which takes care of SIP signaling and WebRTC media ses
 
 |  Class | Description |
 |  --- | --- |
+|  [Ack](./sip.js.ack.md) | A request to confirm a [Session](./sip.js.session.md) (incoming ACK). |
 |  [Bye](./sip.js.bye.md) | A request to end a [Session](./sip.js.session.md) (incoming BYE). |
 |  [ContentTypeUnsupportedError](./sip.js.contenttypeunsupportederror.md) | An exception indicating an unsupported content type prevented execution. |
 |  [Info](./sip.js.info.md) | An exchange of information (incoming INFO). |

diff --git a/docs/api/sip.js.registereroptions.md b/docs/api/sip.js.registereroptions.md
@@ -22,6 +22,7 @@ export interface RegistererOptions
 |  [instanceId](./sip.js.registereroptions.instanceid.md) | <code>string</code> | UUID to provide with "+sip.instance" Contact parameter. |
 |  [logConfiguration](./sip.js.registereroptions.logconfiguration.md) | <code>boolean</code> | If true, constructor logs the registerer configuration. |
 |  [params](./sip.js.registereroptions.params.md) | <code>{</code><br/><code>        fromDisplayName?: string;</code><br/><code>        fromTag?: string;</code><br/><code>        fromUri?: URI;</code><br/><code>        toDisplayName?: string;</code><br/><code>        toUri?: URI;</code><br/><code>    }</code> |  |
+|  [refreshFrequency](./sip.js.registereroptions.refreshfrequency.md) | <code>number</code> | Determines when a re-REGISTER request is sent. The value should be specified as a percentage of the expiration time (between 50 and 99). |
 |  [regId](./sip.js.registereroptions.regid.md) | <code>number</code> | Value to provide with "reg-id" Contact parameter. |
 |  [registrar](./sip.js.registereroptions.registrar.md) | <code>URI</code> | The URI of the registrar to send the REGISTER requests. |
 
diff --git a/docs/api/sip.js.registereroptions.refreshfrequency.md b/docs/api/sip.js.registereroptions.refreshfrequency.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; [RegistererOptions](./sip.js.registereroptions.md) &gt; [refreshFrequency](./sip.js.registereroptions.refreshfrequency.md)
+
+## RegistererOptions.refreshFrequency property
+
+Determines when a re-REGISTER request is sent. The value should be specified as a percentage of the expiration time (between 50 and 99).
+
+<b>Signature:</b>
+
+```typescript
+refreshFrequency?: number;
+```
diff --git a/docs/api/sip.js.sessiondelegate.md b/docs/api/sip.js.sessiondelegate.md
@@ -16,6 +16,7 @@ export interface SessionDelegate
 
 |  Method | Description |
 |  --- | --- |
+|  [onAck(ack)](./sip.js.sessiondelegate.onack.md) | Called upon receiving an incoming in dialog ACK request. |
 |  [onBye(bye)](./sip.js.sessiondelegate.onbye.md) | Called upon receiving an incoming in dialog BYE request. |
 |  [onInfo(info)](./sip.js.sessiondelegate.oninfo.md) | Called upon receiving an incoming in dialog INFO request. |
 |  [onInvite(request, response, statusCode)](./sip.js.sessiondelegate.oninvite.md) | Called upon receiving an incoming in dialog INVITE request. |

diff --git a/docs/api/sip.js.sessiondelegate.onack.md b/docs/api/sip.js.sessiondelegate.onack.md
@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [SessionDelegate](./sip.js.sessiondelegate.md) &gt; [onAck](./sip.js.sessiondelegate.onack.md)
+
+## SessionDelegate.onAck() method
+
+Called upon receiving an incoming in dialog ACK request.
+
+<b>Signature:</b>
+
+```typescript
+onAck?(ack: Ack): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  ack | <code>Ack</code> | The ack. |
+
+<b>Returns:</b>
+
+`void`
+
diff --git a/etc/api/sip.js.api.md b/etc/api/sip.js.api.md
@@ -4,6 +4,16 @@
 
 ```ts
 
+// @public
+export class Ack {
+    // Warning: (ae-forgotten-export) The symbol "IncomingAckRequest" needs to be exported by the entry point index.d.ts
+    //
+    // @internal
+    constructor(incomingAckRequest: IncomingAckRequest);
+    // Warning: (ae-forgotten-export) The symbol "IncomingRequestMessage" needs to be exported by the entry point index.d.ts
+    get request(): IncomingRequestMessage;
+}
+
 // @public
 export interface BodyAndContentType {
     body: string;
@@ -19,7 +29,6 @@ export class Bye {
     // Warning: (ae-forgotten-export) The symbol "ResponseOptions" needs to be exported by the entry point index.d.ts
     accept(options?: ResponseOptions): Promise<void>;
     reject(options?: ResponseOptions): Promise<void>;
-    // Warning: (ae-forgotten-export) The symbol "IncomingRequestMessage" needs to be exported by the entry point index.d.ts
     get request(): IncomingRequestMessage;
 }
 
@@ -99,6 +108,7 @@ export class Invitation extends Session {
 
 // @public
 export interface InvitationAcceptOptions {
+    extraHeaders?: Array<string>;
     sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
     sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
 }
@@ -349,6 +359,7 @@ export interface RegistererOptions {
         toDisplayName?: string;
         toUri?: URI;
     };
+    refreshFrequency?: number;
     regId?: number;
     registrar?: URI;
 }
@@ -440,8 +451,6 @@ export abstract class Session {
     message(options?: SessionMessageOptions): Promise<OutgoingMessageRequest>;
     // @internal
     _message(delegate?: OutgoingRequestDelegate, options?: RequestOptions): Promise<OutgoingMessageRequest>;
-    // Warning: (ae-forgotten-export) The symbol "IncomingAckRequest" needs to be exported by the entry point index.d.ts
-    //
     // @internal
     protected onAckRequest(request: IncomingAckRequest): Promise<void>;
     // @internal
@@ -517,6 +526,7 @@ export interface SessionByeOptions {
 
 // @public
 export interface SessionDelegate {
+    onAck?(ack: Ack): void;
     onBye?(bye: Bye): void;
     onInfo?(info: Info): void;
     onInvite?(request: IncomingRequestMessage, response: string, statusCode: number): void;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "sip.js",
   "title": "SIP.js",
   "description": "A SIP library for JavaScript",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib/index.js",

diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const LIBRARY_VERSION = "0.19.0";
+export const LIBRARY_VERSION = "0.20.0";
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export const LIBRARY_VERSION = "0.19.0";
		export const LIBRARY_VERSION = "0.20.0";