New API - update docs

zxcpoiu · Apr 23, 2020 · 3e58f1a · 3e58f1a
1 parent c61e02d
commit 3e58f1a
Show file tree

Hide file tree

Showing 14 changed files with 17 additions and 17 deletions.
diff --git a/docs/api/sip.js.sessiondelegate.md b/docs/api/sip.js.sessiondelegate.md
@@ -19,7 +19,7 @@ export interface SessionDelegate
 |  [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. |
-|  [onMessage(message)](./sip.js.sessiondelegate.onmessage.md) | Called upon receiving an incoming in dialog MESAGE request. |
+|  [onMessage(message)](./sip.js.sessiondelegate.onmessage.md) | Called upon receiving an incoming in dialog MESSAGE request. |
 |  [onNotify(notification)](./sip.js.sessiondelegate.onnotify.md) | Called upon receiving an incoming in dialog NOTIFY request. |
 |  [onRefer(referral)](./sip.js.sessiondelegate.onrefer.md) | Called upon receiving an incoming in dialog REFER request. |
 
diff --git a/docs/api/sip.js.sessiondelegate.onmessage.md b/docs/api/sip.js.sessiondelegate.onmessage.md
@@ -4,7 +4,7 @@
 
 ## SessionDelegate.onMessage() method
 
-Called upon receiving an incoming in dialog MESAGE request.
+Called upon receiving an incoming in dialog MESSAGE request.
 
 <b>Signature:</b>
 

diff --git a/docs/core/sip.js.noninviteclienttransaction.md b/docs/core/sip.js.noninviteclienttransaction.md
@@ -33,7 +33,7 @@ Non-INVITE transactions do not make use of ACK. They are simple request-response
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [dispose()](./sip.js.noninviteclienttransaction.dispose.md) |  | Destructor. |
-|  [onTransportError(error)](./sip.js.noninviteclienttransaction.ontransporterror.md) |  | The client transaction SHOULD inform the TU that a transport failure has occurred, and the client transaction SHOULD transition directly to the "Terminated" state. The TU will handle the failover mechanisms described in \[4\]. https://tools.ietf.org/html/rfc3261\#section-17.1.4 |
+|  [onTransportError(error)](./sip.js.noninviteclienttransaction.ontransporterror.md) |  | The client transaction SHOULD inform the TU that a transport failure has occurred, and the client transaction SHOULD transition directly to the "Terminated" state. The TU will handle the fail over mechanisms described in \[4\]. https://tools.ietf.org/html/rfc3261\#section-17.1.4 |
 |  [receiveResponse(response)](./sip.js.noninviteclienttransaction.receiveresponse.md) |  | Handler for incoming responses from the transport which match this transaction. |
 |  [typeToString()](./sip.js.noninviteclienttransaction.typetostring.md) |  | For logging. |
 
diff --git a/docs/core/sip.js.noninviteclienttransaction.ontransporterror.md b/docs/core/sip.js.noninviteclienttransaction.ontransporterror.md
@@ -4,7 +4,7 @@
 
 ## NonInviteClientTransaction.onTransportError() method
 
-The client transaction SHOULD inform the TU that a transport failure has occurred, and the client transaction SHOULD transition directly to the "Terminated" state. The TU will handle the failover mechanisms described in \[4\]. https://tools.ietf.org/html/rfc3261\#section-17.1.4
+The client transaction SHOULD inform the TU that a transport failure has occurred, and the client transaction SHOULD transition directly to the "Terminated" state. The TU will handle the fail over mechanisms described in \[4\]. https://tools.ietf.org/html/rfc3261\#section-17.1.4
 
 <b>Signature:</b>
 
@@ -16,7 +16,7 @@ protected onTransportError(error: Error): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  error | <code>Error</code> | Trasnsport error |
+|  error | <code>Error</code> | Transport error |
 
 <b>Returns:</b>
 

diff --git a/docs/core/sip.js.noninviteservertransaction.receiveresponse.md b/docs/core/sip.js.noninviteservertransaction.receiveresponse.md
@@ -16,7 +16,7 @@ receiveResponse(statusCode: number, response: string): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  statusCode | <code>number</code> | Status code of repsonse. 101-199 not allowed per RFC 4320. |
+|  statusCode | <code>number</code> | Status code of response. 101-199 not allowed per RFC 4320. |
 |  response | <code>string</code> | Response to send. |
 
 <b>Returns:</b>

diff --git a/docs/core/sip.js.subscribeuseragentclient.md b/docs/core/sip.js.subscribeuseragentclient.md
@@ -16,7 +16,7 @@ export declare class SubscribeUserAgentClient extends UserAgentClient implements
 
 4.1. Subscriber Behavior https://tools.ietf.org/html/rfc6665\#section-4.1
 
-User agent client for installation of a single subscription per SUBSCRIBE request. TODO: Support for installation of multiple subscriptions on forked SUBSCRIBE reqeuests.
+User agent client for installation of a single subscription per SUBSCRIBE request. TODO: Support for installation of multiple subscriptions on forked SUBSCRIBE requests.
 
 ## Constructors
 
@@ -35,7 +35,7 @@ User agent client for installation of a single subscription per SUBSCRIBE reques
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [dispose()](./sip.js.subscribeuseragentclient.dispose.md) |  | Destructor. Note that Timer N may live on waiting for an initial NOTIFY and the delegate may still receive that NOTIFY. If you don't want that behavior then either clear the delegate so the delegate doesn't get called (a 200 will be sent in response to the NOTIFY) or call <code>waitNotifyStop</code> which will clear Timer N and remove this UAC from the core (a 481 will be sent in response to the NOTIFY). |
-|  [onNotify(uas)](./sip.js.subscribeuseragentclient.onnotify.md) |  | Handle out of dialog NOTIFY assoicated with SUBSCRIBE request. This is the first NOTIFY received after the SUBSCRIBE request. |
+|  [onNotify(uas)](./sip.js.subscribeuseragentclient.onnotify.md) |  | Handle out of dialog NOTIFY associated with SUBSCRIBE request. This is the first NOTIFY received after the SUBSCRIBE request. |
 |  [receiveResponse(message)](./sip.js.subscribeuseragentclient.receiveresponse.md) |  | Receive a response from the transaction layer. |
 |  [waitNotifyStart()](./sip.js.subscribeuseragentclient.waitnotifystart.md) |  |  |
 |  [waitNotifyStop()](./sip.js.subscribeuseragentclient.waitnotifystop.md) |  |  |

diff --git a/docs/core/sip.js.subscribeuseragentclient.onnotify.md b/docs/core/sip.js.subscribeuseragentclient.onnotify.md
@@ -4,7 +4,7 @@
 
 ## SubscribeUserAgentClient.onNotify() method
 
-Handle out of dialog NOTIFY assoicated with SUBSCRIBE request. This is the first NOTIFY received after the SUBSCRIBE request.
+Handle out of dialog NOTIFY associated with SUBSCRIBE request. This is the first NOTIFY received after the SUBSCRIBE request.
 
 <b>Signature:</b>
 

diff --git a/docs/core/sip.js.useragentcoreconfiguration.md b/docs/core/sip.js.useragentcoreconfiguration.md
@@ -23,8 +23,8 @@ export interface UserAgentCoreConfiguration
 |  [loggerFactory](./sip.js.useragentcoreconfiguration.loggerfactory.md) | <code>LoggerFactory</code> | Logger factory. |
 |  [routeSet](./sip.js.useragentcoreconfiguration.routeset.md) | <code>Array&lt;string&gt;</code> | Preloaded route set. |
 |  [sipjsId](./sip.js.useragentcoreconfiguration.sipjsid.md) | <code>string</code> | Unique instance id. |
-|  [supportedOptionTags](./sip.js.useragentcoreconfiguration.supportedoptiontags.md) | <code>Array&lt;string&gt;</code> | Option tags of supported SIP extenstions. |
-|  [supportedOptionTagsResponse](./sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md) | <code>Array&lt;string&gt;</code> | Option tags of supported SIP extenstions. Used in resposnes. |
+|  [supportedOptionTags](./sip.js.useragentcoreconfiguration.supportedoptiontags.md) | <code>Array&lt;string&gt;</code> | Option tags of supported SIP extensions. |
+|  [supportedOptionTagsResponse](./sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md) | <code>Array&lt;string&gt;</code> | Option tags of supported SIP extensions. Used in responses. |
 |  [userAgentHeaderFieldValue](./sip.js.useragentcoreconfiguration.useragentheaderfieldvalue.md) | <code>string &#124; undefined</code> | User-Agent header field value. |
 |  [viaForceRport](./sip.js.useragentcoreconfiguration.viaforcerport.md) | <code>boolean</code> | Force use of "rport" Via header field parameter. |
 |  [viaHost](./sip.js.useragentcoreconfiguration.viahost.md) | <code>string</code> | Via header field host name or network address. |

diff --git a/docs/core/sip.js.useragentcoreconfiguration.supportedoptiontags.md b/docs/core/sip.js.useragentcoreconfiguration.supportedoptiontags.md
@@ -4,7 +4,7 @@
 
 ## UserAgentCoreConfiguration.supportedOptionTags property
 
-Option tags of supported SIP extenstions.
+Option tags of supported SIP extensions.
 
 <b>Signature:</b>
 

diff --git a/docs/core/sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md b/docs/core/sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md
@@ -4,7 +4,7 @@
 
 ## UserAgentCoreConfiguration.supportedOptionTagsResponse property
 
-Option tags of supported SIP extenstions. Used in resposnes.
+Option tags of supported SIP extensions. Used in responses.
 
 <b>Signature:</b>
 

diff --git a/docs/simple-user/sip.js.md b/docs/simple-user/sip.js.md
@@ -18,7 +18,7 @@ A simple SIP user implementation for web browsers.
 |  --- | --- |
 |  [SimpleUserDelegate](./sip.js.simpleuserdelegate.md) | Delegate for [SimpleUser](./sip.js.simpleuser.md)<!-- -->. |
 |  [SimpleUserMedia](./sip.js.simpleusermedia.md) | Media for [SimpleUserOptions](./sip.js.simpleuseroptions.md)<!-- -->. |
-|  [SimpleUserMediaConstraints](./sip.js.simpleusermediaconstraints.md) | Contraints for [SimpleUserMedia](./sip.js.simpleusermedia.md)<!-- -->. |
+|  [SimpleUserMediaConstraints](./sip.js.simpleusermediaconstraints.md) | Constraints for [SimpleUserMedia](./sip.js.simpleusermedia.md)<!-- -->. |
 |  [SimpleUserMediaLocal](./sip.js.simpleusermedialocal.md) | Local media elements for [SimpleUserMedia](./sip.js.simpleusermedia.md)<!-- -->. |
 |  [SimpleUserMediaRemote](./sip.js.simpleusermediaremote.md) | Remote media elements for [SimpleUserMedia](./sip.js.simpleusermedia.md)<!-- -->. |
 |  [SimpleUserOptions](./sip.js.simpleuseroptions.md) | Options for [SimpleUser](./sip.js.simpleuser.md)<!-- -->. |

diff --git a/docs/simple-user/sip.js.simpleuser.call.md b/docs/simple-user/sip.js.simpleuser.call.md
@@ -4,7 +4,7 @@
 
 ## SimpleUser.call() method
 
-Make an outoing call.
+Make an outgoing call.
 
 <b>Signature:</b>
 

diff --git a/docs/simple-user/sip.js.simpleuser.md b/docs/simple-user/sip.js.simpleuser.md
@@ -37,7 +37,7 @@ While this class is completely functional for simple use cases, it is not intend
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [answer(invitationAcceptOptions)](./sip.js.simpleuser.answer.md) |  | Answer an incoming call. |
-|  [call(destination, inviterOptions, inviterInviteOptions)](./sip.js.simpleuser.call.md) |  | Make an outoing call. |
+|  [call(destination, inviterOptions, inviterInviteOptions)](./sip.js.simpleuser.call.md) |  | Make an outgoing call. |
 |  [connect()](./sip.js.simpleuser.connect.md) |  | Connect. |
 |  [decline()](./sip.js.simpleuser.decline.md) |  | Decline an incoming call. |
 |  [disconnect()](./sip.js.simpleuser.disconnect.md) |  | Disconnect. |

diff --git a/docs/simple-user/sip.js.simpleusermediaconstraints.md b/docs/simple-user/sip.js.simpleusermediaconstraints.md
@@ -4,7 +4,7 @@
 
 ## SimpleUserMediaConstraints interface
 
-Contraints for [SimpleUserMedia](./sip.js.simpleusermedia.md)<!-- -->.
+Constraints for [SimpleUserMedia](./sip.js.simpleusermedia.md)<!-- -->.
 
 <b>Signature:</b>