New API - update docs

John Riordan · John Riordan · commit 791170921f07 · 2019-12-13T14:21:24.000-05:00
diff --git a/docs/api.md b/docs/api.md
@@ -60,7 +60,7 @@ userAgent.delegate = {
     };
 
     // Handle incoming session state changes.
-    incomingSession.stateChange.on((newState: SessionState) => {
+    incomingSession.stateChange.addListener((newState: SessionState) => {
       switch (newState) {
         case SessionState.Establishing:
           // Session is establishing.
@@ -114,7 +114,7 @@ userAgent.start().then(() => {
   };
 
   // Handle outgoing session state changes.
-  outgoingSession.stateChange.on((newState: SessionState) => {
+  outgoingSession.stateChange.addListener((newState: SessionState) => {
     switch (newState) {
       case SessionState.Establishing:
         // Session is establishing.
diff --git a/docs/api/sip.js.emitter.addlistener.md b/docs/api/sip.js.emitter.addlistener.md
@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [Emitter](./sip.js.emitter.md) &gt; [addListener](./sip.js.emitter.addlistener.md)
+
+## Emitter.addListener() method
+
+Sets up a function that will be called whenever the target changes.
+
+<b>Signature:</b>
+
+```typescript
+addListener(listener: (data: T) => void, options?: {
+        once?: boolean;
+    }): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | <code>(data: T) =&gt; void</code> | Callback function. |
+|  options | <code>{</code><br/><code>        once?: boolean;</code><br/><code>    }</code> | An options object that specifies characteristics about the listener. If once true, indicates that the listener should be invoked at most once after being added. If once true, the listener would be automatically removed when invoked. |
+
+<b>Returns:</b>
+
+`void`
+
diff --git a/docs/api/sip.js.emitter.md b/docs/api/sip.js.emitter.md
@@ -16,7 +16,9 @@ export interface Emitter<T>
 
 |  Method | Description |
 |  --- | --- |
+|  [addListener(listener, options)](./sip.js.emitter.addlistener.md) | Sets up a function that will be called whenever the target changes. |
 |  [off(listener)](./sip.js.emitter.off.md) | Unregisters a listener. |
 |  [on(listener)](./sip.js.emitter.on.md) | Registers a listener. |
 |  [once(listener)](./sip.js.emitter.once.md) | Registers a listener then unregisters the listener after one event emission. |
+|  [removeListener(listener)](./sip.js.emitter.removelistener.md) | Removes from the listener previously registered with addListener. |
 
diff --git a/docs/api/sip.js.emitter.off.md b/docs/api/sip.js.emitter.off.md
@@ -4,6 +4,11 @@
 
 ## Emitter.off() method
 
+> Warning: This API is now obsolete.
+> 
+> Use removeListener.
+> 
+
 Unregisters a listener.
 
 <b>Signature:</b>
diff --git a/docs/api/sip.js.emitter.on.md b/docs/api/sip.js.emitter.on.md
@@ -4,6 +4,11 @@
 
 ## Emitter.on() method
 
+> Warning: This API is now obsolete.
+> 
+> Use addListener.
+> 
+
 Registers a listener.
 
 <b>Signature:</b>
diff --git a/docs/api/sip.js.emitter.once.md b/docs/api/sip.js.emitter.once.md
@@ -4,6 +4,11 @@
 
 ## Emitter.once() method
 
+> Warning: This API is now obsolete.
+> 
+> Use addListener.
+> 
+
 Registers a listener then unregisters the listener after one event emission.
 
 <b>Signature:</b>
diff --git a/docs/api/sip.js.emitter.removelistener.md b/docs/api/sip.js.emitter.removelistener.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; [Emitter](./sip.js.emitter.md) &gt; [removeListener](./sip.js.emitter.removelistener.md)
+
+## Emitter.removeListener() method
+
+Removes from the listener previously registered with addListener.
+
+<b>Signature:</b>
+
+```typescript
+removeListener(listener: (data: T) => void): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | <code>(data: T) =&gt; void</code> | Callback function. |
+
+<b>Returns:</b>
+
+`void`
+
diff --git a/docs/api/sip.js.inviter.invite.md b/docs/api/sip.js.inviter.invite.md
@@ -58,5 +58,5 @@ The upshot is that if you want "early media", you must not put the initial offer
 
 3) If "early media" and the initial offer is in an INVITE, no INVITE forking.
 
-The default behaviour may be altered and "early media" utilized if the initial offer is in the an INVITE by setting the `earlyMedia` options. However in that case the INVITE request MUST NOT fork. This allows for "early media" in environments where the forking behaviour of the SIP servers being utilized is configured to disallow forking.
+The default behavior may be altered and "early media" utilized if the initial offer is in the an INVITE by setting the `earlyMedia` options. However in that case the INVITE request MUST NOT fork. This allows for "early media" in environments where the forking behavior of the SIP servers being utilized is configured to disallow forking.
 
diff --git a/docs/api/sip.js.inviteroptions.earlymedia.md b/docs/api/sip.js.inviteroptions.earlymedia.md
@@ -4,7 +4,7 @@
 
 ## InviterOptions.earlyMedia property
 
-If true, the first answer to the local offer is immediately utilized for media. Requires that the INVITE request MUST NOT fork. Has no effect if `inviteWtihoutSdp` is true. Default is false.
+If true, the first answer to the local offer is immediately utilized for media. Requires that the INVITE request MUST NOT fork. Has no effect if `inviteWithoutSdp` is true. Default is false.
 
 <b>Signature:</b>
 
diff --git a/docs/api/sip.js.inviteroptions.md b/docs/api/sip.js.inviteroptions.md
@@ -17,7 +17,7 @@ export interface InviterOptions extends SessionOptions
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [anonymous](./sip.js.inviteroptions.anonymous.md) | <code>boolean</code> | If true, an anonymous call. |
-|  [earlyMedia](./sip.js.inviteroptions.earlymedia.md) | <code>boolean</code> | If true, the first answer to the local offer is immediately utilized for media. Requires that the INVITE request MUST NOT fork. Has no effect if <code>inviteWtihoutSdp</code> is true. Default is false. |
+|  [earlyMedia](./sip.js.inviteroptions.earlymedia.md) | <code>boolean</code> | If true, the first answer to the local offer is immediately utilized for media. Requires that the INVITE request MUST NOT fork. Has no effect if <code>inviteWithoutSdp</code> is true. Default is false. |
 |  [extraHeaders](./sip.js.inviteroptions.extraheaders.md) | <code>Array&lt;string&gt;</code> | Array of extra headers added to the INVITE. |
 |  [inviteWithoutSdp](./sip.js.inviteroptions.invitewithoutsdp.md) | <code>boolean</code> | If true, send INVITE without SDP. Default is false. |
 |  [params](./sip.js.inviteroptions.params.md) | <code>{</code><br/><code>        fromDisplayName?: string;</code><br/><code>        fromTag?: string;</code><br/><code>        fromUri?: string &#124; URI;</code><br/><code>        toDisplayName?: string;</code><br/><code>        toUri?: string &#124; URI;</code><br/><code>    }</code> |  |
diff --git a/docs/api/sip.js.registerer.md b/docs/api/sip.js.registerer.md
@@ -32,5 +32,5 @@ export declare class Registerer
 |  --- | --- | --- |
 |  [dispose()](./sip.js.registerer.dispose.md) |  | Destructor. |
 |  [register(options)](./sip.js.registerer.register.md) |  | Sends the REGISTER request. |
-|  [unregister(options)](./sip.js.registerer.unregister.md) |  | Sends the REGISTER request with expires equal to zero. Rejects with <code>RequestPendingError</code> if a REGISTER request is alreadly in progress. |
+|  [unregister(options)](./sip.js.registerer.unregister.md) |  | Sends the REGISTER request with expires equal to zero. Rejects with <code>RequestPendingError</code> if a REGISTER request is already in progress. |
 
diff --git a/docs/api/sip.js.registerer.register.md b/docs/api/sip.js.registerer.register.md
@@ -24,5 +24,5 @@ register(options?: RegistererRegisterOptions): Promise<OutgoingRegisterRequest>;
 
 ## Remarks
 
-If successfull, sends re-REGISTER requests prior to registration expiration until `unsubscribe()` is called. Rejects with `RequestPendingError` if a REGISTER request is alreadly in progress.
+If successful, sends re-REGISTER requests prior to registration expiration until `unsubscribe()` is called. Rejects with `RequestPendingError` if a REGISTER request is already in progress.
 
diff --git a/docs/api/sip.js.registerer.unregister.md b/docs/api/sip.js.registerer.unregister.md
@@ -4,7 +4,7 @@
 
 ## Registerer.unregister() method
 
-Sends the REGISTER request with expires equal to zero. Rejects with `RequestPendingError` if a REGISTER request is alreadly in progress.
+Sends the REGISTER request with expires equal to zero. Rejects with `RequestPendingError` if a REGISTER request is already in progress.
 
 <b>Signature:</b>
 
diff --git a/docs/api/sip.js.session.md b/docs/api/sip.js.session.md
@@ -30,7 +30,7 @@ The constructor for this class is marked as internal. Third-party code should no
 |  [localIdentity](./sip.js.session.localidentity.md) |  | <code>NameAddrHeader</code> | The identity of the local user. |
 |  [logger](./sip.js.session.logger.md) |  | <code>Logger</code> | Logger. |
 |  [remoteIdentity](./sip.js.session.remoteidentity.md) |  | <code>NameAddrHeader</code> | The identity of the remote user. |
-|  [replacee](./sip.js.session.replacee.md) |  | <code>Session &#124; undefined</code> | The sesion being replace by this one. |
+|  [replacee](./sip.js.session.replacee.md) |  | <code>Session &#124; undefined</code> | The session being replace by this one. |
 |  [sessionDescriptionHandler](./sip.js.session.sessiondescriptionhandler.md) |  | <code>SessionDescriptionHandler &#124; undefined</code> | Session description handler. |
 |  [sessionDescriptionHandlerFactory](./sip.js.session.sessiondescriptionhandlerfactory.md) |  | <code>SessionDescriptionHandlerFactory</code> | Session description handler factory. |
 |  [state](./sip.js.session.state.md) |  | <code>SessionState</code> | Session state. |
diff --git a/docs/api/sip.js.session.replacee.md b/docs/api/sip.js.session.replacee.md
@@ -4,7 +4,7 @@
 
 ## Session.replacee property
 
-The sesion being replace by this one.
+The session being replace by this one.
 
 <b>Signature:</b>
 
diff --git a/docs/api/sip.js.subscriber.md b/docs/api/sip.js.subscriber.md
@@ -33,7 +33,7 @@ subscriber.delegate = {
 };
 
 // Monitor subscription state changes.
-subscriber.stateChange.on((newState: SubscriptionState) => {
+subscriber.stateChange.addListener((newState: SubscriptionState) => {
   if (newState === SubscriptionState.Terminated) {
     // handle state change here
   }
diff --git a/docs/api/sip.js.transport.isconnected.md b/docs/api/sip.js.transport.isconnected.md
@@ -24,7 +24,7 @@ This is equivalent to `state === TransportState.Connected`<!-- -->. It is conven
 
 ```ts
 // Monitor transport connectivity
-userAgent.transport.stateChange.on(() => {
+userAgent.transport.stateChange.addListener(() => {
   if (userAgent.transport.isConnected()) {
     // handle transport connect
   } else {
diff --git a/docs/api/sip.js.transport.md b/docs/api/sip.js.transport.md
@@ -20,7 +20,7 @@ The "Connecting" state is ONLY entered in response to the user calling `connect(
 
 Adherence to the state machine by the transport implementation is critical as the UserAgent depends on this behavior. Furthermore it is critical that the transport transition to the "Disconnected" state in all instances where network connectivity is lost as the UserAgent, API, and application layer more generally depend on knowing network was lost. For example, from a practical standpoint registrations and subscriptions are invalidated when network is lost - particularly in the case of connection oriented transport protocols such as a secure WebSocket transport.
 
-Proper handling the application level protocol recovery must be left to the application layer, thus the transport MUST NOT attempt to "auto-recover" from or otherwise hide loss of network. Note that callbacks and emitters such as `onConnect` and `onDisconnect` MUST NOT call methods `connect()` and `direct()` synchronously (state change handlers must not loop back). They may however do so asychronously using a Promise resolution, `setTimeout`<!-- -->, or some other method. For example...
+Proper handling the application level protocol recovery must be left to the application layer, thus the transport MUST NOT attempt to "auto-recover" from or otherwise hide loss of network. Note that callbacks and emitters such as `onConnect` and `onDisconnect` MUST NOT call methods `connect()` and `direct()` synchronously (state change handlers must not loop back). They may however do so asynchronously using a Promise resolution, `setTimeout`<!-- -->, or some other method. For example...
 
 ```ts
 transport.onDisconnect = () => {
diff --git a/docs/api/sip.js.transportstate.md b/docs/api/sip.js.transportstate.md
@@ -16,7 +16,7 @@ export declare enum TransportState
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  Connected | <code>&quot;Connected&quot;</code> | The <code>connect()</code> method resovled. |
+|  Connected | <code>&quot;Connected&quot;</code> | The <code>connect()</code> method resolved. |
 |  Connecting | <code>&quot;Connecting&quot;</code> | The <code>connect()</code> method was called. |
 |  Disconnected | <code>&quot;Disconnected&quot;</code> | The <code>connect()</code> method was rejected, or the <code>disconnect()</code> method completed, or network connectivity was lost. |
 |  Disconnecting | <code>&quot;Disconnecting&quot;</code> | The <code>disconnect()</code> method was called. |
diff --git a/docs/api/sip.js.useragent.stop.md b/docs/api/sip.js.useragent.stop.md
@@ -28,7 +28,7 @@ Resolves when the user agent has completed a graceful shutdown.
 6) User Agent Core resets.
 
 ```
-NOTE: While this is a "graceful shutdown", it can also be very slow one if you are waiting for the returned Promise to resolve. The disposal of the clients and dialogs is done serially - waiting on one to finish before moving on to the next. This can be slow if there are lot of subsciptions to unsubscribe for example.
+NOTE: While this is a "graceful shutdown", it can also be very slow one if you are waiting for the returned Promise to resolve. The disposal of the clients and dialogs is done serially - waiting on one to finish before moving on to the next. This can be slow if there are lot of subscriptions to unsubscribe for example.
 
 THE SLOW PACE IS INTENTIONAL! While one could spin them all down in parallel, this could slam the remote server. It is bad practice to denial of service attack (DoS attack) servers!!! Moreover, production servers will automatically blacklist clients which send too many requests in too short a period of time - dropping any additional requests.
 
diff --git a/docs/api/sip.js.useragentoptions.autostart.md b/docs/api/sip.js.useragentoptions.autostart.md
@@ -17,5 +17,5 @@ autoStart?: boolean;
 
 ## Remarks
 
-The call to start() resovles when the user agent connects, so if this option is set to `true` an alternative method of connection detection must be used.
+The call to start() resolves when the user agent connects, so if this option is set to `true` an alternative method of connection detection must be used.
 
diff --git a/docs/api/sip.js.useragentoptions.logconnector.md b/docs/api/sip.js.useragentoptions.logconnector.md
@@ -4,7 +4,7 @@
 
 ## UserAgentOptions.logConnector property
 
-A function which will be called everytime a log is generated.
+A function which will be called every time a log is generated.
 
 <b>Signature:</b>
 
diff --git a/docs/api/sip.js.useragentoptions.md b/docs/api/sip.js.useragentoptions.md
@@ -31,7 +31,7 @@ export interface UserAgentOptions
 |  [hackWssInTransport](./sip.js.useragentoptions.hackwssintransport.md) | <code>boolean</code> | Hack |
 |  [logBuiltinEnabled](./sip.js.useragentoptions.logbuiltinenabled.md) | <code>boolean</code> | Indicates whether log messages should be written to the browser console. |
 |  [logConfiguration](./sip.js.useragentoptions.logconfiguration.md) | <code>boolean</code> | If true, constructor logs the user agent configuration. |
-|  [logConnector](./sip.js.useragentoptions.logconnector.md) | <code>LogConnector</code> | A function which will be called everytime a log is generated. |
+|  [logConnector](./sip.js.useragentoptions.logconnector.md) | <code>LogConnector</code> | A function which will be called every time a log is generated. |
 |  [logLevel](./sip.js.useragentoptions.loglevel.md) | <code>LogLevel</code> | Indicates the verbosity level of the log messages. |
 |  [noAnswerTimeout](./sip.js.useragentoptions.noanswertimeout.md) | <code>number</code> | Number of seconds after which an incoming call is rejected if not answered. |
 |  [preloadedRouteSet](./sip.js.useragentoptions.preloadedrouteset.md) | <code>Array&lt;string&gt;</code> | Adds a Route header(s) to outgoing requests. |
diff --git a/docs/api/sip.js.useragentoptions.sessiondescriptionhandlerfactoryoptions.md b/docs/api/sip.js.useragentoptions.sessiondescriptionhandlerfactoryoptions.md
@@ -14,5 +14,5 @@ sessionDescriptionHandlerFactoryOptions?: object;
 
 ## Remarks
 
-See `Web.SessionDesecriptionHandlerOptions` for details.
+See `Web.SessionDescriptionHandlerOptions` for details.
 
diff --git a/docs/migration-0.15-0.16.md b/docs/migration-0.15-0.16.md
@@ -131,7 +131,7 @@ const userAgent = new UserAgent(options);
 const registerer = new Registerer(userAgent);
 
 // Setup registerer state change handler
-registerer.stateChange.on((newState) => {
+registerer.stateChange.addListener((newState) => {
   switch (newState) {
     case RegistererState.Registered:
       console.log("Registered");
@@ -239,7 +239,7 @@ const uri = UserAgent.makeURI("sip:alice@example.com");
 const session = new Inviter(userAgent, uri);
 
 // Setup session state change handler
-session.stateChange.on((newState: SessionState) => {
+session.stateChange.addListener((newState: SessionState) => {
   switch (newState) {
     case SessionState.Establishing:
       console.log("Ringing");
diff --git a/docs/simple-user/sip.js.simpleuser._constructor_.md b/docs/simple-user/sip.js.simpleuser._constructor_.md
@@ -9,13 +9,13 @@ Constructs a new instance of the `SimpleUser` class.
 <b>Signature:</b>
 
 ```typescript
-constructor(webSocketServerURL: string, options?: SimpleUserOptions);
+constructor(server: string, options?: SimpleUserOptions);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  webSocketServerURL | <code>string</code> | SIP WebSocket Server URL. |
+|  server | <code>string</code> | SIP WebSocket Server URL. |
 |  options | <code>SimpleUserOptions</code> | Options bucket. See [SimpleUserOptions](./sip.js.simpleuseroptions.md) for details. |
 
diff --git a/docs/simple-user/sip.js.simpleuser.md b/docs/simple-user/sip.js.simpleuser.md
@@ -20,7 +20,7 @@ While this class is completely functional for simple use cases, it is not intend
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(webSocketServerURL, options)](./sip.js.simpleuser._constructor_.md) |  | Constructs a new instance of the <code>SimpleUser</code> class. |
+|  [(constructor)(server, options)](./sip.js.simpleuser._constructor_.md) |  | Constructs a new instance of the <code>SimpleUser</code> class. |
 
 ## Properties
 
diff --git a/etc/api/sip.js.api.md b/etc/api/sip.js.api.md
diff --git a/etc/simple-user/sip.js.api.md b/etc/simple-user/sip.js.api.md

Original file line number	Diff line number	Diff line change
`@@ -58,5 +58,5 @@ The upshot is that if you want "early media", you must not put the initial offer`
`58`	`58`
`59`	`59`	`3) If "early media" and the initial offer is in an INVITE, no INVITE forking.`
`60`	`60`
`61`		-The default behaviour may be altered and "early media" utilized if the initial offer is in the an INVITE by setting the `earlyMedia` options. However in that case the INVITE request MUST NOT fork. This allows for "early media" in environments where the forking behaviour of the SIP servers being utilized is configured to disallow forking.
	`61`	+The default behavior may be altered and "early media" utilized if the initial offer is in the an INVITE by setting the `earlyMedia` options. However in that case the INVITE request MUST NOT fork. This allows for "early media" in environments where the forking behavior of the SIP servers being utilized is configured to disallow forking.
`62`	`62`