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

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

@@ -14,9 +14,39 @@ joinChannel(channelId: string): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  channelId | string | The ID of the channel to join. |
+<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 join.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -14,29 +14,271 @@ export interface FDC3
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md) |  | Observable&lt;[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->&gt; | Observable which emits the current channel When a new channel is joined a new value is emitted |
-|  [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md) |  | () =&gt; boolean | Check if the interop global is available. |
-|  [isReady](./foundation-fdc3.fdc3.isready.md) |  | boolean | Whether the FDC3 API is ready. |
-|  [isReady$](./foundation-fdc3.fdc3.isready_.md) |  | Observable&lt;true&gt; | Observable indicating the FDC3 API is ready. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Observable&lt;[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->&gt;
+
+
+</td><td>
+
+Observable which emits the current channel When a new channel is joined a new value is emitted
+
+
+</td></tr>
+<tr><td>
+
+[isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; boolean
+
+
+</td><td>
+
+Check if the interop global is available.
+
+
+</td></tr>
+<tr><td>
+
+[isReady](./foundation-fdc3.fdc3.isready.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the FDC3 API is ready.
+
+
+</td></tr>
+<tr><td>
+
+[isReady$](./foundation-fdc3.fdc3.isready_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Observable&lt;true&gt;
+
+
+</td><td>
+
+Observable indicating the FDC3 API is ready.
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [addChannelListener(channelName, channelType, callback)](./foundation-fdc3.fdc3.addchannellistener.md) | Helper function to add a context listener on a channel with a handler for channel messages |
-|  [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
-|  [addSystemChannelListener(channelType, callback)](./foundation-fdc3.fdc3.addsystemchannellistener.md) | Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages |
-|  [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
-|  [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md) | Helper function to broadcast message on channel in response to dispatched event |
-|  [broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md) | Broadcasts a message on the current app channel |
-|  [findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md) | Finds an app that supports the specified intent. |
-|  [findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md) | Finds all the intents supported by the specified context. |
-|  [getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md) | Helper function to get the current channel of the application |
-|  [getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md) | Gets or creates the specified channel. |
-|  [handleChannelCurrentContext(channel, contextType, listenerCallback)](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md) | Helper function to add a context listener on a channel with a handler for channel messages |
-|  [joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md) | Joins the specified channel. |
-|  [raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md) | Raises the specified intent with the specified context. |
-|  [raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md) | Raises an intent against an application based purely on the context data. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addChannelListener(channelName, channelType, callback)](./foundation-fdc3.fdc3.addchannellistener.md)
+
+
+</td><td>
+
+Helper function to add a context listener on a channel with a handler for channel messages
+
+
+</td></tr>
+<tr><td>
+
+[addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md)
+
+
+</td><td>
+
+Adds intent listeners for the specified intents.
+
+
+</td></tr>
+<tr><td>
+
+[addSystemChannelListener(channelType, callback)](./foundation-fdc3.fdc3.addsystemchannellistener.md)
+
+
+</td><td>
+
+Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages
+
+
+</td></tr>
+<tr><td>
+
+[broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md)
+
+
+</td><td>
+
+Broadcasts a message on a given channel with a given type
+
+
+</td></tr>
+<tr><td>
+
+[broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md)
+
+
+</td><td>
+
+Helper function to broadcast message on channel in response to dispatched event
+
+
+</td></tr>
+<tr><td>
+
+[broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md)
+
+
+</td><td>
+
+Broadcasts a message on the current app channel
+
+
+</td></tr>
+<tr><td>
+
+[findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md)
+
+
+</td><td>
+
+Finds an app that supports the specified intent.
+
+
+</td></tr>
+<tr><td>
+
+[findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md)
+
+
+</td><td>
+
+Finds all the intents supported by the specified context.
+
+
+</td></tr>
+<tr><td>
+
+[getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md)
+
+
+</td><td>
+
+Helper function to get the current channel of the application
+
+
+</td></tr>
+<tr><td>
+
+[getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md)
+
+
+</td><td>
+
+Gets or creates the specified channel.
+
+
+</td></tr>
+<tr><td>
+
+[handleChannelCurrentContext(channel, contextType, listenerCallback)](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md)
+
+
+</td><td>
+
+Helper function to add a context listener on a channel with a handler for channel messages
+
+
+</td></tr>
+<tr><td>
+
+[joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md)
+
+
+</td><td>
+
+Joins the specified channel.
+
+
+</td></tr>
+<tr><td>
+
+[raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md)
+
+
+</td><td>
+
+Raises the specified intent with the specified context.
+
+
+</td></tr>
+<tr><td>
+
+[raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md)
+
+
+</td><td>
+
+Raises an intent against an application based purely on the context data.
+
+
+</td></tr>
+</tbody></table>
 

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

@@ -14,10 +14,55 @@ raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResol
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
-|  intent | [FDC3Intents](./foundation-fdc3.fdc3intents.md) | _(Optional)_ The intent to raise. |
+<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>
+<tr><td>
+
+intent
+
+
+</td><td>
+
+[FDC3Intents](./foundation-fdc3.fdc3intents.md)
+
+
+</td><td>
+
+_(Optional)_ The intent to raise.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -14,9 +14,39 @@ raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
 
 ## 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.fdc3contextlistener.config.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; [Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md) &gt; [config](./foundation-fdc3.fdc3contextlistener.config.md)
+
+## Fdc3ContextListener.config 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
+config: AppChannelListenerConfig[];
+```

package/docs/api/foundation-fdc3.fdc3contextlistener.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; [Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md)
+
+## Fdc3ContextListener class
+
+> 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 to app channel context
+
+**Signature:**
+
+```typescript
+export declare class Fdc3ContextListener extends Fdc3SystemChannelListener 
+```
+**Extends:** [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[config](./foundation-fdc3.fdc3contextlistener.config.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-fdc3.fdc3intentlistener.fdc3.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; [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md) &gt; [fdc3](./foundation-fdc3.fdc3intentlistener.fdc3.md)
+
+## Fdc3IntentListener.fdc3 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
+fdc3: FDC3;
+```

package/docs/api/foundation-fdc3.fdc3intentlistener.intentconfig.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; [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md) &gt; [intentConfig](./foundation-fdc3.fdc3intentlistener.intentconfig.md)
+
+## Fdc3IntentListener.intentConfig 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
+intentConfig: IntentConfig[];
+```

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

@@ -0,0 +1,81 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md)
+
+## Fdc3IntentListener class
+
+> 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-system-channel-listener Util element to listen to the context on a fdc3 app channel
+
+**Signature:**
+
+```typescript
+export declare class Fdc3IntentListener extends Fdc3IntentListener_base 
+```
+**Extends:** Fdc3IntentListener\_base
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fdc3](./foundation-fdc3.fdc3intentlistener.fdc3.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FDC3](./foundation-fdc3.fdc3.md)
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[intentConfig](./foundation-fdc3.fdc3intentlistener.intentconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[IntentConfig](./foundation-fdc3.intentconfig.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-fdc3.fdc3raiseintent.eventname.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; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [eventName](./foundation-fdc3.fdc3raiseintent.eventname.md)
+
+## Fdc3RaiseIntent.eventName 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
+eventName: string;
+```

package/docs/api/foundation-fdc3.fdc3raiseintent.fdc3.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; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [fdc3](./foundation-fdc3.fdc3raiseintent.fdc3.md)
+
+## Fdc3RaiseIntent.fdc3 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
+fdc3: FDC3;
+```

package/docs/api/foundation-fdc3.fdc3raiseintent.intentname.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; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [intentName](./foundation-fdc3.fdc3raiseintent.intentname.md)
+
+## Fdc3RaiseIntent.intentName 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
+intentName: string;
+```

package/docs/api/foundation-fdc3.fdc3raiseintent.intenttype.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; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [intentType](./foundation-fdc3.fdc3raiseintent.intenttype.md)
+
+## Fdc3RaiseIntent.intentType 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
+intentType: string;
+```