@genesislcap/foundation-comms 14.302.0 → 14.302.1-alpha-945e484.0

package/docs/api/foundation-comms.defaultconnectevents.md

@@ -15,16 +15,161 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md) |  | Add a commit listener. |
-|  [addCommitResponseListener(listener)](./foundation-comms.defaultconnectevents.addcommitresponselistener.md) |  | Add a commit response listener (fires for both ack and nack). |
-|  [addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md) |  | Add a metadata listener. |
-|  [addStreamListener(listener, complete, error)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
-|  [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) |  | Called by Connect. |
-|  [onCommitResponseEvent(eventName, response)](./foundation-comms.defaultconnectevents.oncommitresponseevent.md) |  | Called by Connect when a commit response (ack or nack) is received. |
-|  [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) |  | Called by Connect. |
-|  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
-|  [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.defaultconnectevents.onstreamerrorevent.md) |  | Called by Connect. |
-|  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md) |  | Called by Connect. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Add a commit listener.
+
+
+</td></tr>
+<tr><td>
+
+[addCommitResponseListener(listener)](./foundation-comms.defaultconnectevents.addcommitresponselistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Add a commit response listener (fires for both ack and nack).
+
+
+</td></tr>
+<tr><td>
+
+[addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Add a metadata listener.
+
+
+</td></tr>
+<tr><td>
+
+[addStreamListener(listener, complete, error)](./foundation-comms.defaultconnectevents.addstreamlistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Add a stream listener.
+
+
+</td></tr>
+<tr><td>
+
+[onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called by Connect.
+
+
+</td></tr>
+<tr><td>
+
+[onCommitResponseEvent(eventName, response)](./foundation-comms.defaultconnectevents.oncommitresponseevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called by Connect when a commit response (ack or nack) is received.
+
+
+</td></tr>
+<tr><td>
+
+[onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called by Connect.
+
+
+</td></tr>
+<tr><td>
+
+[onStreamCompleteEvent(resourceName, stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called by Connect.
+
+
+</td></tr>
+<tr><td>
+
+[onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.defaultconnectevents.onstreamerrorevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called by Connect.
+
+
+</td></tr>
+<tr><td>
+
+[onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called by Connect.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.defaultconnectevents.oncommitevent.md

@@ -14,10 +14,53 @@ onCommitEvent(eventName: string, message: Message): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | string |  |
-|  message | [Message](./foundation-comms.message.md) | The message. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+message
+
+
+</td><td>
+
+[Message](./foundation-comms.message.md)
+
+
+</td><td>
+
+The message.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.defaultconnectevents.oncommitresponseevent.md

@@ -14,10 +14,55 @@ onCommitResponseEvent(eventName: string, response: Message): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | string | The name of the event. |
-|  response | [Message](./foundation-comms.message.md) | The response message from the server (ack or nack). |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the event.
+
+
+</td></tr>
+<tr><td>
+
+response
+
+
+</td><td>
+
+[Message](./foundation-comms.message.md)
+
+
+</td><td>
+
+The response message from the server (ack or nack).
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.defaultconnectevents.onmetadataevent.md

@@ -14,11 +14,71 @@ onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaReques
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
-|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)<!-- -->&gt; | The message. |
-|  error | any | _(Optional)_ Optional error. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+<tr><td>
+
+message
+
+
+</td><td>
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)<!-- -->&gt;
+
+
+</td><td>
+
+The message.
+
+
+</td></tr>
+<tr><td>
+
+error
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+_(Optional)_ Optional error.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.defaultconnectevents.onstreamcompleteevent.md

@@ -14,10 +14,55 @@ onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
-|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+<tr><td>
+
+stream
+
+
+</td><td>
+
+[SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt;
+
+
+</td><td>
+
+The actual stream itself.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.defaultconnectevents.onstreamerrorevent.md

@@ -14,11 +14,71 @@ onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: a
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
-|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
-|  error | any | The error that occurred. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+<tr><td>
+
+stream
+
+
+</td><td>
+
+[SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt;
+
+
+</td><td>
+
+The actual stream itself.
+
+
+</td></tr>
+<tr><td>
+
+error
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+The error that occurred.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md

@@ -14,12 +14,87 @@ onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRe
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
-|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->&gt; | The message. |
-|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
-|  functions | [StreamEventFunctions](./foundation-comms.streameventfunctions.md) | Any functions provided. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+<tr><td>
+
+message
+
+
+</td><td>
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->&gt;
+
+
+</td><td>
+
+The message.
+
+
+</td></tr>
+<tr><td>
+
+stream
+
+
+</td><td>
+
+[SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt;
+
+
+</td><td>
+
+The actual stream itself.
+
+
+</td></tr>
+<tr><td>
+
+functions
+
+
+</td><td>
+
+[StreamEventFunctions](./foundation-comms.streameventfunctions.md)
+
+
+</td><td>
+
+Any functions provided.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.defaultcredentialmanager._constructor_.md

@@ -14,8 +14,51 @@ constructor(session: Session, config?: CredentialManagerConfig);
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  session | [Session](./foundation-comms.session.md) |  |
-|  config | [CredentialManagerConfig](./foundation-comms.credentialmanagerconfig.md) | _(Optional)_ |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+session
+
+
+</td><td>
+
+[Session](./foundation-comms.session.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+config
+
+
+</td><td>
+
+[CredentialManagerConfig](./foundation-comms.credentialmanagerconfig.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.defaultcredentialmanager.createbasiccredentials.md

@@ -12,9 +12,37 @@ createBasicCredentials(inputs: BasicCredentialsInput): BasicAuthInfo;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  inputs | [BasicCredentialsInput](./foundation-comms.basiccredentialsinput.md) |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+inputs
+
+
+</td><td>
+
+[BasicCredentialsInput](./foundation-comms.basiccredentialsinput.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**