@genesislcap/foundation-fdc3 14.408.0 → 14.409.0-FUI-2495.2

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

@@ -1,72 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [findIntent](./foundation-fdc3.fdc3.findintent.md)
-
-## FDC3.findIntent() method
-
-Finds an app that supports the specified intent.
-
-**Signature:**
-
-```typescript
-findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
-```
-
-## Parameters
-
-<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:**
-
-Promise&lt;[FDC3AppIntent](./foundation-fdc3.fdc3appintent.md)<!-- -->&gt;
-
-A promise that resolves with the app and its metadata.
-

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

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [findIntentsByContext](./foundation-fdc3.fdc3.findintentsbycontext.md)
-
-## FDC3.findIntentsByContext() method
-
-Finds all the intents supported by the specified context.
-
-**Signature:**
-
-```typescript
-findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
-```
-
-## Parameters
-
-<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:**
-
-Promise&lt;[FDC3AppIntent](./foundation-fdc3.fdc3appintent.md)<!-- -->\[\]&gt;
-
-A promise that resolves with an array of all matching intents and their metadata.
-

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [getCurrentChannel](./foundation-fdc3.fdc3.getcurrentchannel.md)
-
-## FDC3.getCurrentChannel() method
-
-Helper function to get the current channel of the application
-
-**Signature:**
-
-```typescript
-getCurrentChannel(): Promise<Channel>;
-```
-**Returns:**
-
-Promise&lt;Channel&gt;
-

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

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [getOrCreateChannel](./foundation-fdc3.fdc3.getorcreatechannel.md)
-
-## FDC3.getOrCreateChannel() method
-
-Gets or creates the specified channel.
-
-**Signature:**
-
-```typescript
-getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
-```
-
-## Parameters
-
-<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:**
-
-Promise&lt;[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->&gt;
-
-A promise that resolves with the channel object.
-

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

@@ -1,86 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [handleChannelCurrentContext](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md)
-
-## FDC3.handleChannelCurrentContext() method
-
-Helper function to add a context listener on a channel with a handler for channel messages
-
-**Signature:**
-
-```typescript
-handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
-```
-
-## Parameters
-
-<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:**
-
-Promise&lt;void&gt;
-

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md)
-
-## FDC3.isInteropFdc3 property
-
-Check if the interop global is available.
-
-**Signature:**
-
-```typescript
-isInteropFdc3: () => boolean;
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isReady](./foundation-fdc3.fdc3.isready.md)
-
-## FDC3.isReady property
-
-Whether the FDC3 API is ready.
-
-**Signature:**
-
-```typescript
-isReady: boolean;
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [isReady$](./foundation-fdc3.fdc3.isready_.md)
-
-## FDC3.isReady$ property
-
-Observable indicating the FDC3 API is ready.
-
-**Signature:**
-
-```typescript
-isReady$: Observable<true>;
-```

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

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md) &gt; [joinChannel](./foundation-fdc3.fdc3.joinchannel.md)
-
-## FDC3.joinChannel() method
-
-Joins the specified channel.
-
-**Signature:**
-
-```typescript
-joinChannel(channelId: string): Promise<void>;
-```
-
-## Parameters
-
-<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:**
-
-Promise&lt;void&gt;
-
-A promise that resolves when the join is successful.
-

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

@@ -1,284 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [FDC3](./foundation-fdc3.fdc3.md)
-
-## FDC3 interface
-
-The FDC3 API interface.
-
-**Signature:**
-
-```typescript
-export interface FDC3 
-```
-
-## Properties
-
-<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
-
-<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>
-