@genesislcap/foundation-fdc3 14.301.0 → 14.302.1-alpha-d11831b.0

package/docs/api/foundation-fdc3.appchannellistenerconfig.channelname.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md) &gt; [channelName](./foundation-fdc3.appchannellistenerconfig.channelname.md)
+
+## AppChannelListenerConfig.channelName property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+channelName: string;
+```

package/docs/api/foundation-fdc3.appchannellistenerconfig.md

@@ -0,0 +1,62 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)
+
+## AppChannelListenerConfig interface
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+fdc3-context-listener listen channel config
+
+**Signature:**
+
+```typescript
+export interface AppChannelListenerConfig extends SystemChannelListenerConfig 
+```
+**Extends:** [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[channelName](./foundation-fdc3.appchannellistenerconfig.channelname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-fdc3.fdc3.addchannellistener.md

@@ -14,11 +14,71 @@ addChannelListener(channelName: string, channelType: string, callback: (any: any
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channelName | string | name of the channel |
-|  channelType | string | type of the channel |
-|  callback | (any: any) => void | handler to for the channel context listener |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+channelName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+name of the channel
+
+
+</td></tr>
+<tr><td>
+
+channelType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+type of the channel
+
+
+</td></tr>
+<tr><td>
+
+callback
+
+
+</td><td>
+
+(any: any) =&gt; void
+
+
+</td><td>
+
+handler to for the channel context listener
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.addintentlisteners.md

@@ -14,9 +14,39 @@ addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listeners | Map&lt;[FDC3Intents](./foundation-fdc3.fdc3intents.md)<!-- -->, [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)<!-- -->&gt; | The intent listeners to add. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+listeners
+
+
+</td><td>
+
+Map&lt;[FDC3Intents](./foundation-fdc3.fdc3intents.md)<!-- -->, [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)<!-- -->&gt;
+
+
+</td><td>
+
+The intent listeners to add.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.addsystemchannellistener.md

@@ -14,10 +14,55 @@ addSystemChannelListener(channelType: string, callback: (any: any) => void): Pro
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channelType | string | type of the channel |
-|  callback | (any: any) => void | handler to for the channel context listener |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+channelType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+type of the channel
+
+
+</td></tr>
+<tr><td>
+
+callback
+
+
+</td><td>
+
+(any: any) =&gt; void
+
+
+</td><td>
+
+handler to for the channel context listener
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.broadcastonchannel.md

@@ -14,11 +14,71 @@ broadcastOnChannel(channelName: string, type: string, payload: any): Promise<voi
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channelName | string | name of the channel |
-|  type | string | type of the channel |
-|  payload | any | payload sent to the channel |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+channelName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+name of the channel
+
+
+</td></tr>
+<tr><td>
+
+type
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+type of the channel
+
+
+</td></tr>
+<tr><td>
+
+payload
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+payload sent to the channel
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.broadcastonchanneleventhandler.md

@@ -14,10 +14,55 @@ broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: a
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channelName | string | name of the channel |
-|  type | string | type of the channel |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+channelName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+name of the channel
+
+
+</td></tr>
+<tr><td>
+
+type
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+type of the channel
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.broadcastoncurrentchannel.md

@@ -14,10 +14,55 @@ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  payload | any | payload sent to the channel |
-|  type | string | _(Optional)_ type of the channel |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+payload
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+payload sent to the channel
+
+
+</td></tr>
+<tr><td>
+
+type
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ type of the channel
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.findintent.md

@@ -14,10 +14,55 @@ findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  intent | [FDC3Intents](./foundation-fdc3.fdc3intents.md) | The intent to find an app for. |
-|  context | [FDC3Context](./foundation-fdc3.fdc3context.md) | _(Optional)_ The context to use. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+intent
+
+
+</td><td>
+
+[FDC3Intents](./foundation-fdc3.fdc3intents.md)
+
+
+</td><td>
+
+The intent to find an app for.
+
+
+</td></tr>
+<tr><td>
+
+context
+
+
+</td><td>
+
+[FDC3Context](./foundation-fdc3.fdc3context.md)
+
+
+</td><td>
+
+_(Optional)_ The context to use.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.findintentsbycontext.md

@@ -14,9 +14,39 @@ findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+[FDC3Context](./foundation-fdc3.fdc3context.md)
+
+
+</td><td>
+
+The context to use.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.getorcreatechannel.md

@@ -14,9 +14,39 @@ getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channelId | string | The ID of the channel to get or create. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+channelId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The ID of the channel to get or create.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-fdc3.fdc3.handlechannelcurrentcontext.md

@@ -14,11 +14,71 @@ handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string,
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channel | Channel \| [FDC3Channel](./foundation-fdc3.fdc3channel.md) | channel instance for getting for getting current context |
-|  contextType | string | context type of the channel to listen to |
-|  listenerCallback | (FDC3Context: any) => any | handler to for the channel context listener |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+channel
+
+
+</td><td>
+
+Channel \| [FDC3Channel](./foundation-fdc3.fdc3channel.md)
+
+
+</td><td>
+
+channel instance for getting for getting current context
+
+
+</td></tr>
+<tr><td>
+
+contextType
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+context type of the channel to listen to
+
+
+</td></tr>
+<tr><td>
+
+listenerCallback
+
+
+</td><td>
+
+(FDC3Context: any) =&gt; any
+
+
+</td><td>
+
+handler to for the channel context listener
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**