@genesislcap/foundation-fdc3 14.408.0 → 14.409.0

package/docs/api/foundation-fdc3.fdc3.raiseintent.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; [raiseIntent](./foundation-fdc3.fdc3.raiseintent.md)
-
-## FDC3.raiseIntent() method
-
-Raises the specified intent with the specified context.
-
-**Signature:**
-
-```typescript
-raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
-```
-
-## 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>
-<tr><td>
-
-intent
-
-
-</td><td>
-
-[FDC3Intents](./foundation-fdc3.fdc3intents.md)
-
-
-</td><td>
-
-_(Optional)_ The intent to raise.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)<!-- -->&gt;
-
-A promise that resolves with the result of the intent resolution.
-

package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.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; [raiseIntentForContext](./foundation-fdc3.fdc3.raiseintentforcontext.md)
-
-## FDC3.raiseIntentForContext() method
-
-Raises an intent against an application based purely on the context data.
-
-**Signature:**
-
-```typescript
-raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
-```
-
-## 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;[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)<!-- -->&gt;
-
-A promise that resolves with the result of the intent resolution.
-

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

@@ -1,18 +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; [FDC3AppIntent](./foundation-fdc3.fdc3appintent.md)
-
-## FDC3AppIntent interface
-
-> Warning: This API is now obsolete.
-> 
-> Use AppIntent from the @<!-- -->finos/fdc3 package instead
-> 
-
-**Signature:**
-
-```typescript
-export interface FDC3AppIntent extends AppIntent 
-```
-**Extends:** AppIntent
-

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

@@ -1,18 +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; [FDC3Channel](./foundation-fdc3.fdc3channel.md)
-
-## FDC3Channel interface
-
-> Warning: This API is now obsolete.
-> 
-> Use Channel from the @<!-- -->finos/fdc3 package instead
-> 
-
-**Signature:**
-
-```typescript
-export interface FDC3Channel extends Channel 
-```
-**Extends:** Channel
-

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

@@ -1,18 +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; [FDC3Context](./foundation-fdc3.fdc3context.md)
-
-## FDC3Context interface
-
-> Warning: This API is now obsolete.
-> 
-> Use Context from the @<!-- -->finos/fdc3 package instead
-> 
-
-**Signature:**
-
-```typescript
-export interface FDC3Context extends Context 
-```
-**Extends:** Context
-

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

@@ -1,16 +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; [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)
-
-## FDC3ContextHandler type
-
-> Warning: This API is now obsolete.
-> 
-> Use ContextHandler from the @<!-- -->finos/fdc3 package instead
-> 
-
-**Signature:**
-
-```typescript
-export type FDC3ContextHandler = ContextHandler;
-```

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

@@ -1,14 +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; [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

@@ -1,62 +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; [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

@@ -1,14 +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; [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

@@ -1,14 +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; [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

@@ -1,81 +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; [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.fdc3intentresolution.md

@@ -1,18 +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; [FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)
-
-## FDC3IntentResolution interface
-
-> Warning: This API is now obsolete.
-> 
-> Use IntentResolution from the @<!-- -->finos/fdc3 package instead
-> 
-
-**Signature:**
-
-```typescript
-export interface FDC3IntentResolution extends IntentResolution 
-```
-**Extends:** IntentResolution
-

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

@@ -1,16 +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; [FDC3Intents](./foundation-fdc3.fdc3intents.md)
-
-## FDC3Intents type
-
-> Warning: This API is now obsolete.
-> 
-> Use Intents from the @<!-- -->finos/fdc3 package instead
-> 
-
-**Signature:**
-
-```typescript
-export type FDC3Intents = Intents;
-```

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

@@ -1,14 +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; [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

@@ -1,14 +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; [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

@@ -1,14 +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; [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

@@ -1,14 +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; [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;
-```

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

@@ -1,14 +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; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [mappingFunction](./foundation-fdc3.fdc3raiseintent.mappingfunction.md)
-
-## Fdc3RaiseIntent.mappingFunction 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
-mappingFunction: (any: any) => any;
-```

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

@@ -1,138 +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; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md)
-
-## Fdc3RaiseIntent 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-raise-intent
-
-**Signature:**
-
-```typescript
-export declare class Fdc3RaiseIntent extends Fdc3RaiseIntent_base 
-```
-**Extends:** Fdc3RaiseIntent\_base
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[eventName](./foundation-fdc3.fdc3raiseintent.eventname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[fdc3](./foundation-fdc3.fdc3raiseintent.fdc3.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FDC3](./foundation-fdc3.fdc3.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[intentName](./foundation-fdc3.fdc3raiseintent.intentname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[intentType](./foundation-fdc3.fdc3raiseintent.intenttype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[mappingFunction](./foundation-fdc3.fdc3raiseintent.mappingfunction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(any: any) =&gt; any
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,14 +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; [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md) &gt; [config](./foundation-fdc3.fdc3systemchannellistener.config.md)
-
-## Fdc3SystemChannelListener.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: SystemChannelListenerConfig[];
-```

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

@@ -1,14 +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; [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md) &gt; [fdc3](./foundation-fdc3.fdc3systemchannellistener.fdc3.md)
-
-## Fdc3SystemChannelListener.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;
-```