@genesislcap/foundation-comms 14.167.3-alpha-b40d1e5.0 → 14.167.3-alpha-69ba23f.0

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

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onMetadataEvent](./foundation-comms.connecteventsemitter.onmetadataevent.md)
-
-## ConnectEventsEmitter.onMetadataEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
-```
-
-## 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. |
-
-**Returns:**
-
-void
-

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

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onStreamCompleteEvent](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md)
-
-## ConnectEventsEmitter.onStreamCompleteEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onStreamCompleteEvent(stream: SocketObservable<any>): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
-
-**Returns:**
-
-void
-

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

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onStreamEvent](./foundation-comms.connecteventsemitter.onstreamevent.md)
-
-## ConnectEventsEmitter.onStreamEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
-```
-
-## 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. |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.currentuser.set.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [CurrentUser](./foundation-comms.currentuser.md) &gt; [set](./foundation-comms.currentuser.set.md)
-
-## CurrentUser.set() method
-
-**Signature:**
-
-```typescript
-set(options: UserOptions): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  options | UserOptions |  |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.currentuser.unset.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [CurrentUser](./foundation-comms.currentuser.md) &gt; [unset](./foundation-comms.currentuser.unset.md)
-
-## CurrentUser.unset() method
-
-**Signature:**
-
-```typescript
-unset(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.datasource.destroy.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Datasource](./foundation-comms.datasource.md) &gt; [destroy](./foundation-comms.datasource.destroy.md)
-
-## Datasource.destroy() method
-
-Destroy the datasource.
-
-**Signature:**
-
-```typescript
-destroy(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaultconnect.getmorecolumns.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnect](./foundation-comms.defaultconnect.md) &gt; [getMoreColumns](./foundation-comms.defaultconnect.getmorecolumns.md)
-
-## DefaultConnect.getMoreColumns() method
-
-**Signature:**
-
-```typescript
-getMoreColumns(sourceRef: string): Promise<Message>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  sourceRef | string |  |
-
-**Returns:**
-
-Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-

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

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addCommitListener](./foundation-comms.defaultconnectevents.addcommitlistener.md)
-
-## DefaultConnectEvents.addCommitListener() method
-
-Add a commit listener.
-
-**Signature:**
-
-```typescript
-addCommitListener(listener: Listener<CommitEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[CommitEvent](./foundation-comms.commitevent.md)<!-- -->&gt; | A listener callback function. |
-
-**Returns:**
-
-() =&gt; void
-

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

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addMetadataListener](./foundation-comms.defaultconnectevents.addmetadatalistener.md)
-
-## DefaultConnectEvents.addMetadataListener() method
-
-Add a metadata listener.
-
-**Signature:**
-
-```typescript
-addMetadataListener(listener: Listener<MetadataEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[MetadataEvent](./foundation-comms.metadataevent.md)<!-- -->&gt; | A listener callback function. |
-
-**Returns:**
-
-() =&gt; void
-

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

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addStreamListener](./foundation-comms.defaultconnectevents.addstreamlistener.md)
-
-## DefaultConnectEvents.addStreamListener() method
-
-Add a stream listener.
-
-**Signature:**
-
-```typescript
-addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
-|  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
-
-**Returns:**
-
-() =&gt; void
-

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

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md)
-
-## DefaultConnectEvents class
-
-Default ConnectEvents implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultConnectEvents implements ConnectEventsEmitter 
-```
-**Implements:** [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md)
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md) |  | Add a commit listener. |
-|  [addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md) |  | Add a metadata listener. |
-|  [addStreamListener(listener, complete)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
-|  [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) |  | Called by Connect. |
-|  [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) |  | Called by Connect. |
-|  [onStreamCompleteEvent(stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
-|  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md) |  | Called by Connect. |
-

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

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onCommitEvent](./foundation-comms.defaultconnectevents.oncommitevent.md)
-
-## DefaultConnectEvents.onCommitEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onCommitEvent(eventName: string, message: Message): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | string |  |
-|  message | [Message](./foundation-comms.message.md) | The message. |
-
-**Returns:**
-
-void
-

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

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onMetadataEvent](./foundation-comms.defaultconnectevents.onmetadataevent.md)
-
-## DefaultConnectEvents.onMetadataEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
-```
-
-## 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. |
-
-**Returns:**
-
-void
-

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

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onStreamCompleteEvent](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md)
-
-## DefaultConnectEvents.onStreamCompleteEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onStreamCompleteEvent(stream: SocketObservable<any>): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
-
-**Returns:**
-
-void
-

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

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onStreamEvent](./foundation-comms.defaultconnectevents.onstreamevent.md)
-
-## DefaultConnectEvents.onStreamEvent() method
-
-Called by Connect.
-
-**Signature:**
-
-```typescript
-onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
-```
-
-## 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. |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaultdatasource.destroy.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [destroy](./foundation-comms.defaultdatasource.destroy.md)
-
-## DefaultDatasource.destroy() method
-
-Destroy the datasource.
-
-**Signature:**
-
-```typescript
-destroy(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) &gt; [getMoreColumns](./foundation-comms.defaulthttpconnect.getmorecolumns.md)
-
-## DefaultHttpConnect.getMoreColumns() method
-
-**Signature:**
-
-```typescript
-getMoreColumns(sourceRef: string): Promise<Message>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  sourceRef | string |  |
-
-**Returns:**
-
-Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-

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

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [(constructor)](./foundation-comms.defaultmessagebuilder._constructor_.md)
-
-## DefaultMessageBuilder.(constructor)
-
-UUID will be created in the DI with the App specific requirements. Keeping it encapsulated means messages will always conform.
-
-**Signature:**
-
-```typescript
-constructor(session: Session, uuid: UUID);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  session | [Session](./foundation-comms.session.md) |  |
-|  uuid | UUID |  |
-

package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createChangePasswordMessage](./foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md)
-
-## DefaultMessageBuilder.createChangePasswordMessage() method
-
-**Signature:**
-
-```typescript
-createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  username | string |  |
-|  oldPassword | string |  |
-|  newPassword | string |  |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.ChangePassword](./foundation-comms.messagedetails.changepassword.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createcommitmessage.md

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createCommitMessage](./foundation-comms.defaultmessagebuilder.createcommitmessage.md)
-
-## DefaultMessageBuilder.createCommitMessage() method
-
-**Signature:**
-
-```typescript
-createCommitMessage<T = any>(eventName: string, params?: CommitParams): Message<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | string |  |
-|  params | [CommitParams](./foundation-comms.commitparams.md) | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createDataLogoffMessage](./foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md)
-
-## DefaultMessageBuilder.createDataLogoffMessage() method
-
-**Signature:**
-
-```typescript
-createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  sourceRef | string |  |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createDataLogonMessage](./foundation-comms.defaultmessagebuilder.createdatalogonmessage.md)
-
-## DefaultMessageBuilder.createDataLogonMessage() method
-
-**Signature:**
-
-```typescript
-createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string |  |
-|  params | any | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createForgotPasswordMessage](./foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md)
-
-## DefaultMessageBuilder.createForgotPasswordMessage() method
-
-**Signature:**
-
-```typescript
-createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  username | string |  |
-|  returnUrl | string |  |
-|  requester | string | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.ForgotPassword](./foundation-comms.messagedetails.forgotpassword.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createForgotPasswordTokenMessage](./foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md)
-
-## DefaultMessageBuilder.createForgotPasswordTokenMessage() method
-
-**Signature:**
-
-```typescript
-createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  username | string |  |
-|  resetToken | string |  |
-|  newPassword | string |  |
-|  requester | string | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.ForgotPasswordToken](./foundation-comms.messagedetails.forgotpasswordtoken.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createHTTPHeadersFromMessage](./foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md)
-
-## DefaultMessageBuilder.createHTTPHeadersFromMessage() method
-
-**Signature:**
-
-```typescript
-createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  message | [Message](./foundation-comms.message.md) |  |
-|  contentType | string | _(Optional)_ |
-
-**Returns:**
-
-HeadersInit
-

package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createLoginMessage](./foundation-comms.defaultmessagebuilder.createloginmessage.md)
-
-## DefaultMessageBuilder.createLoginMessage() method
-
-**Signature:**
-
-```typescript
-createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  credentials | [AuthInfo](./foundation-comms.authinfo.md) |  |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.Login](./foundation-comms.messagedetails.login.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createLogoutMessage](./foundation-comms.defaultmessagebuilder.createlogoutmessage.md)
-
-## DefaultMessageBuilder.createLogoutMessage() method
-
-**Signature:**
-
-```typescript
-createLogoutMessage(loginResult?: LoginResult): Message;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  loginResult | [LoginResult](./foundation-comms.loginresult.md) | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)
-