@genesislcap/foundation-fdc3 14.302.0 → 14.302.1-alpha-d11831b.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 (56) hide show
  1. package/dist/dts/fdc3-channel-event.d.ts +264 -223
  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 +264 -223
  5. package/dist/dts/util/fdc3-intent-listener.d.ts.map +1 -1
  6. package/dist/dts/util/fdc3-raise-intent.d.ts +264 -223
  7. package/dist/dts/util/fdc3-raise-intent.d.ts.map +1 -1
  8. package/dist/dts/util/fdc3-system-channel-listener.d.ts +264 -223
  9. package/dist/dts/util/fdc3-system-channel-listener.d.ts.map +1 -1
  10. package/dist/dts/util/fdc3-util.d.ts.map +1 -1
  11. package/dist/esm/fdc3.js +4 -4
  12. package/dist/foundation-fdc3.api.json +845 -178
  13. package/dist/foundation-fdc3.d.ts +1056 -892
  14. package/docs/api/foundation-fdc3.appchannellistenerconfig.channelname.md +14 -0
  15. package/docs/api/foundation-fdc3.appchannellistenerconfig.md +62 -0
  16. package/docs/api/foundation-fdc3.fdc3.addchannellistener.md +65 -5
  17. package/docs/api/foundation-fdc3.fdc3.addintentlisteners.md +33 -3
  18. package/docs/api/foundation-fdc3.fdc3.addsystemchannellistener.md +49 -4
  19. package/docs/api/foundation-fdc3.fdc3.broadcastonchannel.md +65 -5
  20. package/docs/api/foundation-fdc3.fdc3.broadcastonchanneleventhandler.md +49 -4
  21. package/docs/api/foundation-fdc3.fdc3.broadcastoncurrentchannel.md +49 -4
  22. package/docs/api/foundation-fdc3.fdc3.findintent.md +49 -4
  23. package/docs/api/foundation-fdc3.fdc3.findintentsbycontext.md +33 -3
  24. package/docs/api/foundation-fdc3.fdc3.getorcreatechannel.md +33 -3
  25. package/docs/api/foundation-fdc3.fdc3.handlechannelcurrentcontext.md +65 -5
  26. package/docs/api/foundation-fdc3.fdc3.joinchannel.md +33 -3
  27. package/docs/api/foundation-fdc3.fdc3.md +264 -22
  28. package/docs/api/foundation-fdc3.fdc3.raiseintent.md +49 -4
  29. package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.md +33 -3
  30. package/docs/api/foundation-fdc3.fdc3contextlistener.config.md +14 -0
  31. package/docs/api/foundation-fdc3.fdc3contextlistener.md +62 -0
  32. package/docs/api/foundation-fdc3.fdc3intentlistener.fdc3.md +14 -0
  33. package/docs/api/foundation-fdc3.fdc3intentlistener.intentconfig.md +14 -0
  34. package/docs/api/foundation-fdc3.fdc3intentlistener.md +81 -0
  35. package/docs/api/foundation-fdc3.fdc3raiseintent.eventname.md +14 -0
  36. package/docs/api/foundation-fdc3.fdc3raiseintent.fdc3.md +14 -0
  37. package/docs/api/foundation-fdc3.fdc3raiseintent.intentname.md +14 -0
  38. package/docs/api/foundation-fdc3.fdc3raiseintent.intenttype.md +14 -0
  39. package/docs/api/foundation-fdc3.fdc3raiseintent.mappingfunction.md +14 -0
  40. package/docs/api/foundation-fdc3.fdc3raiseintent.md +138 -0
  41. package/docs/api/foundation-fdc3.fdc3systemchannellistener.config.md +14 -0
  42. package/docs/api/foundation-fdc3.fdc3systemchannellistener.fdc3.md +14 -0
  43. package/docs/api/foundation-fdc3.fdc3systemchannellistener.md +81 -0
  44. package/docs/api/foundation-fdc3.intentconfig.callback.md +14 -0
  45. package/docs/api/foundation-fdc3.intentconfig.intent.md +14 -0
  46. package/docs/api/foundation-fdc3.intentconfig.md +80 -0
  47. package/docs/api/foundation-fdc3.interopfoundationnotificationlistener.md +41 -1
  48. package/docs/api/foundation-fdc3.interopnotificationslistener.md +70 -6
  49. package/docs/api/foundation-fdc3.interopnotificationslistener.shownotificationtoast.md +31 -3
  50. package/docs/api/foundation-fdc3.md +236 -18
  51. package/docs/api/foundation-fdc3.systemchannellistenerconfig.callback.md +14 -0
  52. package/docs/api/foundation-fdc3.systemchannellistenerconfig.channeltype.md +14 -0
  53. package/docs/api/foundation-fdc3.systemchannellistenerconfig.md +80 -0
  54. package/docs/api/index.md +21 -3
  55. package/docs/api-report.md.api.md +281 -0
  56. package/package.json +15 -15
@@ -0,0 +1,14 @@
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
+ ```
@@ -0,0 +1,138 @@
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
+ <table><thead><tr><th>
22
+
23
+ Property
24
+
25
+
26
+ </th><th>
27
+
28
+ Modifiers
29
+
30
+
31
+ </th><th>
32
+
33
+ Type
34
+
35
+
36
+ </th><th>
37
+
38
+ Description
39
+
40
+
41
+ </th></tr></thead>
42
+ <tbody><tr><td>
43
+
44
+ [eventName](./foundation-fdc3.fdc3raiseintent.eventname.md)
45
+
46
+
47
+ </td><td>
48
+
49
+
50
+ </td><td>
51
+
52
+ string
53
+
54
+
55
+ </td><td>
56
+
57
+ **_(ALPHA)_**
58
+
59
+
60
+ </td></tr>
61
+ <tr><td>
62
+
63
+ [fdc3](./foundation-fdc3.fdc3raiseintent.fdc3.md)
64
+
65
+
66
+ </td><td>
67
+
68
+
69
+ </td><td>
70
+
71
+ [FDC3](./foundation-fdc3.fdc3.md)
72
+
73
+
74
+ </td><td>
75
+
76
+ **_(ALPHA)_**
77
+
78
+
79
+ </td></tr>
80
+ <tr><td>
81
+
82
+ [intentName](./foundation-fdc3.fdc3raiseintent.intentname.md)
83
+
84
+
85
+ </td><td>
86
+
87
+
88
+ </td><td>
89
+
90
+ string
91
+
92
+
93
+ </td><td>
94
+
95
+ **_(ALPHA)_**
96
+
97
+
98
+ </td></tr>
99
+ <tr><td>
100
+
101
+ [intentType](./foundation-fdc3.fdc3raiseintent.intenttype.md)
102
+
103
+
104
+ </td><td>
105
+
106
+
107
+ </td><td>
108
+
109
+ string
110
+
111
+
112
+ </td><td>
113
+
114
+ **_(ALPHA)_**
115
+
116
+
117
+ </td></tr>
118
+ <tr><td>
119
+
120
+ [mappingFunction](./foundation-fdc3.fdc3raiseintent.mappingfunction.md)
121
+
122
+
123
+ </td><td>
124
+
125
+
126
+ </td><td>
127
+
128
+ (any: any) =&gt; any
129
+
130
+
131
+ </td><td>
132
+
133
+ **_(ALPHA)_**
134
+
135
+
136
+ </td></tr>
137
+ </tbody></table>
138
+
@@ -0,0 +1,14 @@
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
+ ```
@@ -0,0 +1,14 @@
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
+ ```
@@ -0,0 +1,81 @@
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
+ <table><thead><tr><th>
22
+
23
+ Property
24
+
25
+
26
+ </th><th>
27
+
28
+ Modifiers
29
+
30
+
31
+ </th><th>
32
+
33
+ Type
34
+
35
+
36
+ </th><th>
37
+
38
+ Description
39
+
40
+
41
+ </th></tr></thead>
42
+ <tbody><tr><td>
43
+
44
+ [config](./foundation-fdc3.fdc3systemchannellistener.config.md)
45
+
46
+
47
+ </td><td>
48
+
49
+
50
+ </td><td>
51
+
52
+ [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)<!-- -->\[\]
53
+
54
+
55
+ </td><td>
56
+
57
+ **_(ALPHA)_**
58
+
59
+
60
+ </td></tr>
61
+ <tr><td>
62
+
63
+ [fdc3](./foundation-fdc3.fdc3systemchannellistener.fdc3.md)
64
+
65
+
66
+ </td><td>
67
+
68
+
69
+ </td><td>
70
+
71
+ [FDC3](./foundation-fdc3.fdc3.md)
72
+
73
+
74
+ </td><td>
75
+
76
+ **_(ALPHA)_**
77
+
78
+
79
+ </td></tr>
80
+ </tbody></table>
81
+
@@ -0,0 +1,14 @@
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
+ ```
@@ -0,0 +1,14 @@
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
+ ```
@@ -0,0 +1,80 @@
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
+ <table><thead><tr><th>
21
+
22
+ Property
23
+
24
+
25
+ </th><th>
26
+
27
+ Modifiers
28
+
29
+
30
+ </th><th>
31
+
32
+ Type
33
+
34
+
35
+ </th><th>
36
+
37
+ Description
38
+
39
+
40
+ </th></tr></thead>
41
+ <tbody><tr><td>
42
+
43
+ [callback](./foundation-fdc3.intentconfig.callback.md)
44
+
45
+
46
+ </td><td>
47
+
48
+
49
+ </td><td>
50
+
51
+ (FDC3Context: any) =&gt; void
52
+
53
+
54
+ </td><td>
55
+
56
+ **_(ALPHA)_**
57
+
58
+
59
+ </td></tr>
60
+ <tr><td>
61
+
62
+ [intent](./foundation-fdc3.intentconfig.intent.md)
63
+
64
+
65
+ </td><td>
66
+
67
+
68
+ </td><td>
69
+
70
+ string
71
+
72
+
73
+ </td><td>
74
+
75
+ **_(ALPHA)_**
76
+
77
+
78
+ </td></tr>
79
+ </tbody></table>
80
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md)
4
4
 
5
- ## interopFoundationNotificationListener variable
5
+ ## interopFoundationNotificationListener() function
6
6
 
7
7
  The Foundation Interop Notification Listener
8
8
 
@@ -20,6 +20,46 @@ interopFoundationNotificationListener: (overrideDefinition?: import("@microsoft/
20
20
  }, typeof InteropNotificationsListener>
21
21
  ```
22
22
 
23
+ ## Parameters
24
+
25
+ <table><thead><tr><th>
26
+
27
+ Parameter
28
+
29
+
30
+ </th><th>
31
+
32
+ Type
33
+
34
+
35
+ </th><th>
36
+
37
+ Description
38
+
39
+
40
+ </th></tr></thead>
41
+ <tbody><tr><td>
42
+
43
+ overrideDefinition
44
+
45
+
46
+ </td><td>
47
+
48
+ import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate&lt;NotificationListener, any&gt;; shadowOptions: ShadowRootInit; }&gt;
49
+
50
+
51
+ </td><td>
52
+
53
+ _(Optional)_
54
+
55
+
56
+ </td></tr>
57
+ </tbody></table>
58
+
59
+ **Returns:**
60
+
61
+ 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;
62
+
23
63
  ## Remarks
24
64
 
25
65
  HTML Element: &lt;<!-- -->foundation-interop-notification-listener<!-- -->&gt;
@@ -17,13 +17,77 @@ This component extends the notification listener class and overrides the logic f
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Modifiers | Type | Description |
21
- | --- | --- | --- | --- |
22
- | [iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md) | | IOConnectDesktop.Notifications.IOConnectNotificationOptions | |
20
+ <table><thead><tr><th>
21
+
22
+ Property
23
+
24
+
25
+ </th><th>
26
+
27
+ Modifiers
28
+
29
+
30
+ </th><th>
31
+
32
+ Type
33
+
34
+
35
+ </th><th>
36
+
37
+ Description
38
+
39
+
40
+ </th></tr></thead>
41
+ <tbody><tr><td>
42
+
43
+ [iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md)
44
+
45
+
46
+ </td><td>
47
+
48
+
49
+ </td><td>
50
+
51
+ IOConnectDesktop.Notifications.IOConnectNotificationOptions
52
+
53
+
54
+ </td><td>
55
+
56
+
57
+ </td></tr>
58
+ </tbody></table>
23
59
 
24
60
  ## Methods
25
61
 
26
- | Method | Modifiers | Description |
27
- | --- | --- | --- |
28
- | [showNotificationToast(row)](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md) | <code>protected</code> | |
62
+ <table><thead><tr><th>
63
+
64
+ Method
65
+
66
+
67
+ </th><th>
68
+
69
+ Modifiers
70
+
71
+
72
+ </th><th>
73
+
74
+ Description
75
+
76
+
77
+ </th></tr></thead>
78
+ <tbody><tr><td>
79
+
80
+ [showNotificationToast(row)](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md)
81
+
82
+
83
+ </td><td>
84
+
85
+ `protected`
86
+
87
+
88
+ </td><td>
89
+
90
+
91
+ </td></tr>
92
+ </tbody></table>
29
93
 
@@ -12,9 +12,37 @@ protected showNotificationToast(row: NotificationDataRow): void;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | row | NotificationDataRow | |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ row
34
+
35
+
36
+ </td><td>
37
+
38
+ NotificationDataRow
39
+
40
+
41
+ </td><td>
42
+
43
+
44
+ </td></tr>
45
+ </tbody></table>
18
46
 
19
47
  **Returns:**
20
48