npm - @genesislcap/foundation-fdc3 - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-fdc3 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

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

@@ -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; [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md)
-## Fdc3SystemChannelListener 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 system channel
-**Signature:**
-```typescript
-export declare class Fdc3SystemChannelListener extends Fdc3SystemChannelListener_base
-```
-**Extends:** Fdc3SystemChannelListener\_base
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[config](./foundation-fdc3.fdc3systemchannellistener.config.md)
-</td><td>
-</td><td>
-[SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)<!-- -->\[\]
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-<tr><td>
-[fdc3](./foundation-fdc3.fdc3systemchannellistener.fdc3.md)
-</td><td>
-</td><td>
-[FDC3](./foundation-fdc3.fdc3.md)
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-</tbody></table>

package/docs/api/foundation-fdc3.intentconfig.callback.md DELETED Viewed

@@ -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; [IntentConfig](./foundation-fdc3.intentconfig.md) &gt; [callback](./foundation-fdc3.intentconfig.callback.md)
-## IntentConfig.callback 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
-callback: (FDC3Context: any) => void;
-```

package/docs/api/foundation-fdc3.intentconfig.intent.md DELETED Viewed

@@ -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; [IntentConfig](./foundation-fdc3.intentconfig.md) &gt; [intent](./foundation-fdc3.intentconfig.intent.md)
-## IntentConfig.intent 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
-intent: string;
-```

package/docs/api/foundation-fdc3.intentconfig.md DELETED Viewed

@@ -1,80 +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; [IntentConfig](./foundation-fdc3.intentconfig.md)
-## IntentConfig 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-intent-listener listen intent config
-**Signature:**
-```typescript
-export interface IntentConfig
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[callback](./foundation-fdc3.intentconfig.callback.md)
-</td><td>
-</td><td>
-(FDC3Context: any) =&gt; void
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-<tr><td>
-[intent](./foundation-fdc3.intentconfig.intent.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-</tbody></table>

package/docs/api/foundation-fdc3.interopfoundationnotificationlistener.md DELETED Viewed

@@ -1,66 +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; [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md)
-## interopFoundationNotificationListener() function
-The Foundation Interop Notification Listener
-**Signature:**
-```typescript
-interopFoundationNotificationListener: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-    baseName: string;
-    template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>;
-    shadowOptions: ShadowRootInit;
-}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-    baseName: string;
-    template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>;
-    shadowOptions: ShadowRootInit;
-}, typeof InteropNotificationsListener>
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-overrideDefinition
-</td><td>
-import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate&lt;NotificationListener, any&gt;; shadowOptions: ShadowRootInit; }&gt;
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate&lt;NotificationListener, any&gt;; shadowOptions: ShadowRootInit; }, typeof [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md)<!-- -->&gt;
-## Remarks
-HTML Element: &lt;<!-- -->foundation-interop-notification-listener<!-- -->&gt;

package/docs/api/foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md DELETED Viewed

@@ -1,11 +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; [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) &gt; [iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md)
-## InteropNotificationsListener.iOConnectNotificationOptions property
-**Signature:**
-```typescript
-iOConnectNotificationOptions: IOConnectDesktop.Notifications.IOConnectNotificationOptions;
-```

package/docs/api/foundation-fdc3.interopnotificationslistener.md DELETED Viewed

@@ -1,93 +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; [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md)
-## InteropNotificationsListener class
-**Signature:**
-```typescript
-export declare class InteropNotificationsListener extends NotificationListener
-```
-**Extends:** NotificationListener
-## Remarks
-This component extends the notification listener class and overrides the logic for showing the toast message to instead dispatch the event to the interop notifications bus.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md)
-</td><td>
-</td><td>
-IOConnectDesktop.Notifications.IOConnectNotificationOptions
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[showNotificationToast(row)](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md)
-</td><td>
-`protected`
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-fdc3.interopnotificationslistener.shownotificationtoast.md DELETED Viewed

@@ -1,50 +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; [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) &gt; [showNotificationToast](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md)
-## InteropNotificationsListener.showNotificationToast() method
-**Signature:**
-```typescript
-protected showNotificationToast(row: NotificationDataRow): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-row
-</td><td>
-NotificationDataRow
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-fdc3.logger.md DELETED Viewed

@@ -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; [logger](./foundation-fdc3.logger.md)
-## logger variable
-Logger for the foundation-fdc3 package
-**Signature:**
-```typescript
-logger: import("@genesislcap/foundation-logger").Logger
-```

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

@@ -1,254 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md)
-## foundation-fdc3 package
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md)
-</td><td>
-**_(ALPHA)_** fdc3-context-listener listen to app channel context
-</td></tr>
-<tr><td>
-[Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md)
-</td><td>
-**_(ALPHA)_** fdc3-system-channel-listener Util element to listen to the context on a fdc3 app channel
-</td></tr>
-<tr><td>
-[Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md)
-</td><td>
-**_(ALPHA)_** fdc3-raise-intent
-</td></tr>
-<tr><td>
-[Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md)
-</td><td>
-**_(ALPHA)_** fdc3-system-channel-listener Util element to listen to the context on a fdc3 system channel
-</td></tr>
-<tr><td>
-[InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[interopFoundationNotificationListener(overrideDefinition)](./foundation-fdc3.interopfoundationnotificationlistener.md)
-</td><td>
-The Foundation Interop Notification Listener
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)
-</td><td>
-**_(ALPHA)_** fdc3-context-listener listen channel config
-</td></tr>
-<tr><td>
-[FDC3](./foundation-fdc3.fdc3.md)
-</td><td>
-The FDC3 API interface.
-</td></tr>
-<tr><td>
-[FDC3AppIntent](./foundation-fdc3.fdc3appintent.md)
-</td><td>
-</td></tr>
-<tr><td>
-[FDC3Channel](./foundation-fdc3.fdc3channel.md)
-</td><td>
-</td></tr>
-<tr><td>
-[FDC3Context](./foundation-fdc3.fdc3context.md)
-</td><td>
-</td></tr>
-<tr><td>
-[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)
-</td><td>
-</td></tr>
-<tr><td>
-[IntentConfig](./foundation-fdc3.intentconfig.md)
-</td><td>
-**_(ALPHA)_** fdc3-intent-listener listen intent config
-</td></tr>
-<tr><td>
-[SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
-</td><td>
-**_(ALPHA)_** System channel listener config. System channels are also known as color channels
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[logger](./foundation-fdc3.logger.md)
-</td><td>
-Logger for the foundation-fdc3 package
-</td></tr>
-</tbody></table>
-## Type Aliases
-<table><thead><tr><th>
-Type Alias
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)
-</td><td>
-</td></tr>
-<tr><td>
-[FDC3Intents](./foundation-fdc3.fdc3intents.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-fdc3.systemchannellistenerconfig.callback.md DELETED Viewed

@@ -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; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) &gt; [callback](./foundation-fdc3.systemchannellistenerconfig.callback.md)
-## SystemChannelListenerConfig.callback 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
-callback: (any: any) => void;
-```

package/docs/api/foundation-fdc3.systemchannellistenerconfig.channeltype.md DELETED Viewed

@@ -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; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) &gt; [channelType](./foundation-fdc3.systemchannellistenerconfig.channeltype.md)
-## SystemChannelListenerConfig.channelType 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
-channelType: string;
-```