@genesislcap/foundation-fdc3 14.226.0 → 14.226.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. package/dist/dts/fdc3-channel-event.d.ts +29 -46
  2. package/dist/dts/fdc3-channel-event.d.ts.map +1 -1
  3. package/dist/dts/tsdoc-metadata.json +1 -1
  4. package/dist/dts/util/fdc3-intent-listener.d.ts +29 -46
  5. package/dist/dts/util/fdc3-intent-listener.d.ts.map +1 -1
  6. package/dist/dts/util/fdc3-raise-intent.d.ts +29 -46
  7. package/dist/dts/util/fdc3-raise-intent.d.ts.map +1 -1
  8. package/dist/dts/util/fdc3-system-channel-listener.d.ts +29 -46
  9. package/dist/dts/util/fdc3-system-channel-listener.d.ts.map +1 -1
  10. package/dist/esm/fdc3.js +2 -2
  11. package/dist/foundation-fdc3.api.json +167 -834
  12. package/dist/foundation-fdc3.d.ts +116 -182
  13. package/docs/api/foundation-fdc3.interopfoundationnotificationlistener.md +1 -11
  14. package/docs/api/foundation-fdc3.md +1 -13
  15. package/docs/{api-report.md.api.md → api-report.md} +0 -2
  16. package/package.json +15 -15
  17. package/docs/api/foundation-fdc3.appchannellistenerconfig.channelname.md +0 -14
  18. package/docs/api/foundation-fdc3.appchannellistenerconfig.md +0 -24
  19. package/docs/api/foundation-fdc3.fdc3contextlistener.config.md +0 -14
  20. package/docs/api/foundation-fdc3.fdc3contextlistener.md +0 -24
  21. package/docs/api/foundation-fdc3.fdc3intentlistener.fdc3.md +0 -14
  22. package/docs/api/foundation-fdc3.fdc3intentlistener.intentconfig.md +0 -14
  23. package/docs/api/foundation-fdc3.fdc3intentlistener.md +0 -25
  24. package/docs/api/foundation-fdc3.fdc3raiseintent.eventname.md +0 -14
  25. package/docs/api/foundation-fdc3.fdc3raiseintent.fdc3.md +0 -14
  26. package/docs/api/foundation-fdc3.fdc3raiseintent.intentname.md +0 -14
  27. package/docs/api/foundation-fdc3.fdc3raiseintent.intenttype.md +0 -14
  28. package/docs/api/foundation-fdc3.fdc3raiseintent.mappingfunction.md +0 -14
  29. package/docs/api/foundation-fdc3.fdc3raiseintent.md +0 -28
  30. package/docs/api/foundation-fdc3.fdc3systemchannellistener.config.md +0 -14
  31. package/docs/api/foundation-fdc3.fdc3systemchannellistener.fdc3.md +0 -14
  32. package/docs/api/foundation-fdc3.fdc3systemchannellistener.md +0 -25
  33. package/docs/api/foundation-fdc3.intentconfig.callback.md +0 -14
  34. package/docs/api/foundation-fdc3.intentconfig.intent.md +0 -14
  35. package/docs/api/foundation-fdc3.intentconfig.md +0 -24
  36. package/docs/api/foundation-fdc3.systemchannellistenerconfig.callback.md +0 -14
  37. package/docs/api/foundation-fdc3.systemchannellistenerconfig.channeltype.md +0 -14
  38. package/docs/api/foundation-fdc3.systemchannellistenerconfig.md +0 -24
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-fdc3](./foundation-fdc3.md) > [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md)
4
4
 
5
- ## interopFoundationNotificationListener() function
5
+ ## interopFoundationNotificationListener variable
6
6
 
7
7
  The Foundation Interop Notification Listener
8
8
 
@@ -20,16 +20,6 @@ interopFoundationNotificationListener: (overrideDefinition?: import("@microsoft/
20
20
  }, typeof InteropNotificationsListener>
21
21
  ```
22
22
 
23
- ## Parameters
24
-
25
- | Parameter | Type | Description |
26
- | --- | --- | --- |
27
- | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate<NotificationListener, any>; shadowOptions: ShadowRootInit; }> | _(Optional)_ |
28
-
29
- **Returns:**
30
-
31
- 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;
32
-
33
23
  ## Remarks
34
24
 
35
25
  HTML Element: &lt;<!-- -->foundation-interop-notification-listener<!-- -->&gt;
@@ -8,35 +8,23 @@
8
8
 
9
9
  | Class | Description |
10
10
  | --- | --- |
11
- | [Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md) | **_(ALPHA)_** fdc3-context-listener listen to app channel context |
12
- | [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md) | **_(ALPHA)_** fdc3-system-channel-listener Util element to listen to the context on a fdc3 app channel |
13
- | [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) | **_(ALPHA)_** fdc3-raise-intent |
14
- | [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md) | **_(ALPHA)_** fdc3-system-channel-listener Util element to listen to the context on a fdc3 system channel |
15
11
  | [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) | |
16
12
 
17
- ## Functions
18
-
19
- | Function | Description |
20
- | --- | --- |
21
- | [interopFoundationNotificationListener(overrideDefinition)](./foundation-fdc3.interopfoundationnotificationlistener.md) | The Foundation Interop Notification Listener |
22
-
23
13
  ## Interfaces
24
14
 
25
15
  | Interface | Description |
26
16
  | --- | --- |
27
- | [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md) | **_(ALPHA)_** fdc3-context-listener listen channel config |
28
17
  | [FDC3](./foundation-fdc3.fdc3.md) | The FDC3 API interface. |
29
18
  | [FDC3AppIntent](./foundation-fdc3.fdc3appintent.md) | |
30
19
  | [FDC3Channel](./foundation-fdc3.fdc3channel.md) | |
31
20
  | [FDC3Context](./foundation-fdc3.fdc3context.md) | |
32
21
  | [FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md) | |
33
- | [IntentConfig](./foundation-fdc3.intentconfig.md) | **_(ALPHA)_** fdc3-intent-listener listen intent config |
34
- | [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) | **_(ALPHA)_** System channel listener config. System channels are also known as color channels |
35
22
 
36
23
  ## Variables
37
24
 
38
25
  | Variable | Description |
39
26
  | --- | --- |
27
+ | [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md) | The Foundation Interop Notification Listener |
40
28
  | [logger](./foundation-fdc3.logger.md) | Logger for the foundation-fdc3 package |
41
29
 
42
30
  ## Type Aliases
@@ -4,8 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- /// <reference types="node" />
8
-
9
7
  import type { AppIdentifier } from '@finos/fdc3';
10
8
  import type { AppIntent } from '@finos/fdc3';
11
9
  import type { Channel } from '@finos/fdc3';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-fdc3",
3
3
  "description": "Genesis Foundation FDC3",
4
- "version": "14.226.0",
4
+ "version": "14.226.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -59,28 +59,28 @@
59
59
  }
60
60
  },
61
61
  "devDependencies": {
62
- "@genesislcap/foundation-testing": "14.226.0",
63
- "@genesislcap/genx": "14.226.0",
64
- "@genesislcap/rollup-builder": "14.226.0",
65
- "@genesislcap/ts-builder": "14.226.0",
66
- "@genesislcap/uvu-playwright-builder": "14.226.0",
67
- "@genesislcap/vite-builder": "14.226.0",
68
- "@genesislcap/webpack-builder": "14.226.0",
62
+ "@genesislcap/foundation-testing": "14.226.1",
63
+ "@genesislcap/genx": "14.226.1",
64
+ "@genesislcap/rollup-builder": "14.226.1",
65
+ "@genesislcap/ts-builder": "14.226.1",
66
+ "@genesislcap/uvu-playwright-builder": "14.226.1",
67
+ "@genesislcap/vite-builder": "14.226.1",
68
+ "@genesislcap/webpack-builder": "14.226.1",
69
69
  "rimraf": "^5.0.0",
70
70
  "sinon": "^17.0.1"
71
71
  },
72
72
  "dependencies": {
73
73
  "@finos/fdc3": "2.1.1",
74
- "@genesislcap/foundation-logger": "14.226.0",
75
- "@genesislcap/foundation-notifications": "14.226.0",
76
- "@genesislcap/foundation-ui": "14.226.0",
77
- "@genesislcap/foundation-utils": "14.226.0",
78
- "@genesislcap/web-core": "14.226.0",
74
+ "@genesislcap/foundation-logger": "14.226.1",
75
+ "@genesislcap/foundation-notifications": "14.226.1",
76
+ "@genesislcap/foundation-ui": "14.226.1",
77
+ "@genesislcap/foundation-utils": "14.226.1",
78
+ "@genesislcap/web-core": "14.226.1",
79
79
  "@interopio/desktop": "^6.3.1",
80
80
  "@microsoft/fast-element": "1.14.0",
81
81
  "@microsoft/fast-foundation": "2.49.6",
82
82
  "rxjs": "^7.5.4",
83
- "tslib": "2.8.1"
83
+ "tslib": "^2.3.1"
84
84
  },
85
85
  "repository": {
86
86
  "type": "git",
@@ -90,5 +90,5 @@
90
90
  "publishConfig": {
91
91
  "access": "public"
92
92
  },
93
- "gitHead": "92b4d205bf702945dbed4e9c998c4fd000d99e4b"
93
+ "gitHead": "e691c1741d135edca5271f338f62df8154efb99c"
94
94
  }
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md) &gt; [channelName](./foundation-fdc3.appchannellistenerconfig.channelname.md)
4
-
5
- ## AppChannelListenerConfig.channelName property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- channelName: string;
14
- ```
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)
4
-
5
- ## AppChannelListenerConfig interface
6
-
7
- > 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.
8
- >
9
-
10
- fdc3-context-listener listen channel config
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface AppChannelListenerConfig extends SystemChannelListenerConfig
16
- ```
17
- **Extends:** [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
18
-
19
- ## Properties
20
-
21
- | Property | Modifiers | Type | Description |
22
- | --- | --- | --- | --- |
23
- | [channelName](./foundation-fdc3.appchannellistenerconfig.channelname.md) | | string | **_(ALPHA)_** |
24
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md) &gt; [config](./foundation-fdc3.fdc3contextlistener.config.md)
4
-
5
- ## Fdc3ContextListener.config property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- config: AppChannelListenerConfig[];
14
- ```
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md)
4
-
5
- ## Fdc3ContextListener class
6
-
7
- > 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.
8
- >
9
-
10
- fdc3-context-listener listen to app channel context
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class Fdc3ContextListener extends Fdc3SystemChannelListener
16
- ```
17
- **Extends:** [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md)
18
-
19
- ## Properties
20
-
21
- | Property | Modifiers | Type | Description |
22
- | --- | --- | --- | --- |
23
- | [config](./foundation-fdc3.fdc3contextlistener.config.md) | | [AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)<!-- -->\[\] | **_(ALPHA)_** |
24
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md) &gt; [fdc3](./foundation-fdc3.fdc3intentlistener.fdc3.md)
4
-
5
- ## Fdc3IntentListener.fdc3 property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- fdc3: FDC3;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md) &gt; [intentConfig](./foundation-fdc3.fdc3intentlistener.intentconfig.md)
4
-
5
- ## Fdc3IntentListener.intentConfig property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- intentConfig: IntentConfig[];
14
- ```
@@ -1,25 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md)
4
-
5
- ## Fdc3IntentListener class
6
-
7
- > 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.
8
- >
9
-
10
- fdc3-system-channel-listener Util element to listen to the context on a fdc3 app channel
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class Fdc3IntentListener extends Fdc3IntentListener_base
16
- ```
17
- **Extends:** Fdc3IntentListener\_base
18
-
19
- ## Properties
20
-
21
- | Property | Modifiers | Type | Description |
22
- | --- | --- | --- | --- |
23
- | [fdc3](./foundation-fdc3.fdc3intentlistener.fdc3.md) | | [FDC3](./foundation-fdc3.fdc3.md) | **_(ALPHA)_** |
24
- | [intentConfig](./foundation-fdc3.fdc3intentlistener.intentconfig.md) | | [IntentConfig](./foundation-fdc3.intentconfig.md)<!-- -->\[\] | **_(ALPHA)_** |
25
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [eventName](./foundation-fdc3.fdc3raiseintent.eventname.md)
4
-
5
- ## Fdc3RaiseIntent.eventName property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- eventName: string;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [fdc3](./foundation-fdc3.fdc3raiseintent.fdc3.md)
4
-
5
- ## Fdc3RaiseIntent.fdc3 property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- fdc3: FDC3;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [intentName](./foundation-fdc3.fdc3raiseintent.intentname.md)
4
-
5
- ## Fdc3RaiseIntent.intentName property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- intentName: string;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [intentType](./foundation-fdc3.fdc3raiseintent.intenttype.md)
4
-
5
- ## Fdc3RaiseIntent.intentType property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- intentType: string;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md) &gt; [mappingFunction](./foundation-fdc3.fdc3raiseintent.mappingfunction.md)
4
-
5
- ## Fdc3RaiseIntent.mappingFunction property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- mappingFunction: (any: any) => any;
14
- ```
@@ -1,28 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md)
4
-
5
- ## Fdc3RaiseIntent class
6
-
7
- > 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.
8
- >
9
-
10
- fdc3-raise-intent
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class Fdc3RaiseIntent extends Fdc3RaiseIntent_base
16
- ```
17
- **Extends:** Fdc3RaiseIntent\_base
18
-
19
- ## Properties
20
-
21
- | Property | Modifiers | Type | Description |
22
- | --- | --- | --- | --- |
23
- | [eventName](./foundation-fdc3.fdc3raiseintent.eventname.md) | | string | **_(ALPHA)_** |
24
- | [fdc3](./foundation-fdc3.fdc3raiseintent.fdc3.md) | | [FDC3](./foundation-fdc3.fdc3.md) | **_(ALPHA)_** |
25
- | [intentName](./foundation-fdc3.fdc3raiseintent.intentname.md) | | string | **_(ALPHA)_** |
26
- | [intentType](./foundation-fdc3.fdc3raiseintent.intenttype.md) | | string | **_(ALPHA)_** |
27
- | [mappingFunction](./foundation-fdc3.fdc3raiseintent.mappingfunction.md) | | (any: any) =&gt; any | **_(ALPHA)_** |
28
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md) &gt; [config](./foundation-fdc3.fdc3systemchannellistener.config.md)
4
-
5
- ## Fdc3SystemChannelListener.config property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- config: SystemChannelListenerConfig[];
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md) &gt; [fdc3](./foundation-fdc3.fdc3systemchannellistener.fdc3.md)
4
-
5
- ## Fdc3SystemChannelListener.fdc3 property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- fdc3: FDC3;
14
- ```
@@ -1,25 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md)
4
-
5
- ## Fdc3SystemChannelListener class
6
-
7
- > 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.
8
- >
9
-
10
- fdc3-system-channel-listener Util element to listen to the context on a fdc3 system channel
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class Fdc3SystemChannelListener extends Fdc3SystemChannelListener_base
16
- ```
17
- **Extends:** Fdc3SystemChannelListener\_base
18
-
19
- ## Properties
20
-
21
- | Property | Modifiers | Type | Description |
22
- | --- | --- | --- | --- |
23
- | [config](./foundation-fdc3.fdc3systemchannellistener.config.md) | | [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)<!-- -->\[\] | **_(ALPHA)_** |
24
- | [fdc3](./foundation-fdc3.fdc3systemchannellistener.fdc3.md) | | [FDC3](./foundation-fdc3.fdc3.md) | **_(ALPHA)_** |
25
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [IntentConfig](./foundation-fdc3.intentconfig.md) &gt; [callback](./foundation-fdc3.intentconfig.callback.md)
4
-
5
- ## IntentConfig.callback property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- callback: (FDC3Context: any) => void;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [IntentConfig](./foundation-fdc3.intentconfig.md) &gt; [intent](./foundation-fdc3.intentconfig.intent.md)
4
-
5
- ## IntentConfig.intent property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- intent: string;
14
- ```
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [IntentConfig](./foundation-fdc3.intentconfig.md)
4
-
5
- ## IntentConfig interface
6
-
7
- > 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.
8
- >
9
-
10
- fdc3-intent-listener listen intent config
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface IntentConfig
16
- ```
17
-
18
- ## Properties
19
-
20
- | Property | Modifiers | Type | Description |
21
- | --- | --- | --- | --- |
22
- | [callback](./foundation-fdc3.intentconfig.callback.md) | | (FDC3Context: any) =&gt; void | **_(ALPHA)_** |
23
- | [intent](./foundation-fdc3.intentconfig.intent.md) | | string | **_(ALPHA)_** |
24
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) &gt; [callback](./foundation-fdc3.systemchannellistenerconfig.callback.md)
4
-
5
- ## SystemChannelListenerConfig.callback property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- callback: (any: any) => void;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) &gt; [channelType](./foundation-fdc3.systemchannellistenerconfig.channeltype.md)
4
-
5
- ## SystemChannelListenerConfig.channelType property
6
-
7
- > 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.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- channelType: string;
14
- ```
@@ -1,24 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
4
-
5
- ## SystemChannelListenerConfig interface
6
-
7
- > 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.
8
- >
9
-
10
- System channel listener config. System channels are also known as color channels
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface SystemChannelListenerConfig
16
- ```
17
-
18
- ## Properties
19
-
20
- | Property | Modifiers | Type | Description |
21
- | --- | --- | --- | --- |
22
- | [callback](./foundation-fdc3.systemchannellistenerconfig.callback.md) | | (any: any) =&gt; void | **_(ALPHA)_** |
23
- | [channelType](./foundation-fdc3.systemchannellistenerconfig.channeltype.md) | | string | **_(ALPHA)_** |
24
-