From 3e58f1a71292bb0b9a89b48930bb88f51b216dc7 Mon Sep 17 00:00:00 2001 From: John Riordan Date: Thu, 23 Apr 2020 09:15:13 -0400 Subject: [PATCH] New API - update docs --- docs/api/sip.js.sessiondelegate.md | 2 +- docs/api/sip.js.sessiondelegate.onmessage.md | 2 +- docs/core/sip.js.noninviteclienttransaction.md | 2 +- .../sip.js.noninviteclienttransaction.ontransporterror.md | 4 ++-- .../core/sip.js.noninviteservertransaction.receiveresponse.md | 2 +- docs/core/sip.js.subscribeuseragentclient.md | 4 ++-- docs/core/sip.js.subscribeuseragentclient.onnotify.md | 2 +- docs/core/sip.js.useragentcoreconfiguration.md | 4 ++-- .../sip.js.useragentcoreconfiguration.supportedoptiontags.md | 2 +- ....useragentcoreconfiguration.supportedoptiontagsresponse.md | 2 +- docs/simple-user/sip.js.md | 2 +- docs/simple-user/sip.js.simpleuser.call.md | 2 +- docs/simple-user/sip.js.simpleuser.md | 2 +- docs/simple-user/sip.js.simpleusermediaconstraints.md | 2 +- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/api/sip.js.sessiondelegate.md b/docs/api/sip.js.sessiondelegate.md index 1e76b3907..2a9692315 100644 --- 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 index b7d98e985..7a876232f 100644 --- 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. Signature: diff --git a/docs/core/sip.js.noninviteclienttransaction.md b/docs/core/sip.js.noninviteclienttransaction.md index 162a255ae..99da36f7f 100644 --- 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 index 70eeac825..5c465f983 100644 --- 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 Signature: @@ -16,7 +16,7 @@ protected onTransportError(error: Error): void; | Parameter | Type | Description | | --- | --- | --- | -| error | Error | Trasnsport error | +| error | Error | Transport error | Returns: diff --git a/docs/core/sip.js.noninviteservertransaction.receiveresponse.md b/docs/core/sip.js.noninviteservertransaction.receiveresponse.md index 6f302e945..c1cdd92ce 100644 --- 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 | number | Status code of repsonse. 101-199 not allowed per RFC 4320. | +| statusCode | number | Status code of response. 101-199 not allowed per RFC 4320. | | response | string | Response to send. | Returns: diff --git a/docs/core/sip.js.subscribeuseragentclient.md b/docs/core/sip.js.subscribeuseragentclient.md index b9a0d9269..7fd784290 100644 --- 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 waitNotifyStop 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 index 6040e57d2..c1523c893 100644 --- 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. Signature: diff --git a/docs/core/sip.js.useragentcoreconfiguration.md b/docs/core/sip.js.useragentcoreconfiguration.md index d2fbe1b69..de5b6af98 100644 --- 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) | LoggerFactory | Logger factory. | | [routeSet](./sip.js.useragentcoreconfiguration.routeset.md) | Array<string> | Preloaded route set. | | [sipjsId](./sip.js.useragentcoreconfiguration.sipjsid.md) | string | Unique instance id. | -| [supportedOptionTags](./sip.js.useragentcoreconfiguration.supportedoptiontags.md) | Array<string> | Option tags of supported SIP extenstions. | -| [supportedOptionTagsResponse](./sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md) | Array<string> | Option tags of supported SIP extenstions. Used in resposnes. | +| [supportedOptionTags](./sip.js.useragentcoreconfiguration.supportedoptiontags.md) | Array<string> | Option tags of supported SIP extensions. | +| [supportedOptionTagsResponse](./sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md) | Array<string> | Option tags of supported SIP extensions. Used in responses. | | [userAgentHeaderFieldValue](./sip.js.useragentcoreconfiguration.useragentheaderfieldvalue.md) | string | undefined | User-Agent header field value. | | [viaForceRport](./sip.js.useragentcoreconfiguration.viaforcerport.md) | boolean | Force use of "rport" Via header field parameter. | | [viaHost](./sip.js.useragentcoreconfiguration.viahost.md) | string | 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 index b776b4876..83295707e 100644 --- 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. Signature: diff --git a/docs/core/sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md b/docs/core/sip.js.useragentcoreconfiguration.supportedoptiontagsresponse.md index fbae5e749..07111b6a4 100644 --- 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. Signature: diff --git a/docs/simple-user/sip.js.md b/docs/simple-user/sip.js.md index d4202a662..9391b45f8 100644 --- 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 index d539990ff..9c3068f05 100644 --- 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. Signature: diff --git a/docs/simple-user/sip.js.simpleuser.md b/docs/simple-user/sip.js.simpleuser.md index c8b345c99..e7c1334aa 100644 --- 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 index f1c26658c..93ee6a5bc 100644 --- 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). Signature: