@genesislcap/foundation-fdc3 14.302.1-alpha-945e484.0 → 14.302.1-alpha-ecc0cfb.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 +223 -264
  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 +223 -264
  5. package/dist/dts/util/fdc3-intent-listener.d.ts.map +1 -1
  6. package/dist/dts/util/fdc3-raise-intent.d.ts +223 -264
  7. package/dist/dts/util/fdc3-raise-intent.d.ts.map +1 -1
  8. package/dist/dts/util/fdc3-system-channel-listener.d.ts +223 -264
  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 +167 -834
  13. package/dist/foundation-fdc3.d.ts +892 -1056
  14. package/docs/api/foundation-fdc3.fdc3.addchannellistener.md +5 -65
  15. package/docs/api/foundation-fdc3.fdc3.addintentlisteners.md +3 -33
  16. package/docs/api/foundation-fdc3.fdc3.addsystemchannellistener.md +4 -49
  17. package/docs/api/foundation-fdc3.fdc3.broadcastonchannel.md +5 -65
  18. package/docs/api/foundation-fdc3.fdc3.broadcastonchanneleventhandler.md +4 -49
  19. package/docs/api/foundation-fdc3.fdc3.broadcastoncurrentchannel.md +4 -49
  20. package/docs/api/foundation-fdc3.fdc3.findintent.md +4 -49
  21. package/docs/api/foundation-fdc3.fdc3.findintentsbycontext.md +3 -33
  22. package/docs/api/foundation-fdc3.fdc3.getorcreatechannel.md +3 -33
  23. package/docs/api/foundation-fdc3.fdc3.handlechannelcurrentcontext.md +5 -65
  24. package/docs/api/foundation-fdc3.fdc3.joinchannel.md +3 -33
  25. package/docs/api/foundation-fdc3.fdc3.md +22 -264
  26. package/docs/api/foundation-fdc3.fdc3.raiseintent.md +4 -49
  27. package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.md +3 -33
  28. package/docs/api/foundation-fdc3.interopfoundationnotificationlistener.md +1 -41
  29. package/docs/api/foundation-fdc3.interopnotificationslistener.md +6 -70
  30. package/docs/api/foundation-fdc3.interopnotificationslistener.shownotificationtoast.md +3 -31
  31. package/docs/api/foundation-fdc3.md +18 -236
  32. package/docs/api/index.md +3 -21
  33. package/package.json +15 -15
  34. package/docs/api/foundation-fdc3.appchannellistenerconfig.channelname.md +0 -14
  35. package/docs/api/foundation-fdc3.appchannellistenerconfig.md +0 -62
  36. package/docs/api/foundation-fdc3.fdc3contextlistener.config.md +0 -14
  37. package/docs/api/foundation-fdc3.fdc3contextlistener.md +0 -62
  38. package/docs/api/foundation-fdc3.fdc3intentlistener.fdc3.md +0 -14
  39. package/docs/api/foundation-fdc3.fdc3intentlistener.intentconfig.md +0 -14
  40. package/docs/api/foundation-fdc3.fdc3intentlistener.md +0 -81
  41. package/docs/api/foundation-fdc3.fdc3raiseintent.eventname.md +0 -14
  42. package/docs/api/foundation-fdc3.fdc3raiseintent.fdc3.md +0 -14
  43. package/docs/api/foundation-fdc3.fdc3raiseintent.intentname.md +0 -14
  44. package/docs/api/foundation-fdc3.fdc3raiseintent.intenttype.md +0 -14
  45. package/docs/api/foundation-fdc3.fdc3raiseintent.mappingfunction.md +0 -14
  46. package/docs/api/foundation-fdc3.fdc3raiseintent.md +0 -138
  47. package/docs/api/foundation-fdc3.fdc3systemchannellistener.config.md +0 -14
  48. package/docs/api/foundation-fdc3.fdc3systemchannellistener.fdc3.md +0 -14
  49. package/docs/api/foundation-fdc3.fdc3systemchannellistener.md +0 -81
  50. package/docs/api/foundation-fdc3.intentconfig.callback.md +0 -14
  51. package/docs/api/foundation-fdc3.intentconfig.intent.md +0 -14
  52. package/docs/api/foundation-fdc3.intentconfig.md +0 -80
  53. package/docs/api/foundation-fdc3.systemchannellistenerconfig.callback.md +0 -14
  54. package/docs/api/foundation-fdc3.systemchannellistenerconfig.channeltype.md +0 -14
  55. package/docs/api/foundation-fdc3.systemchannellistenerconfig.md +0 -80
  56. package/docs/api-report.md.api.md +0 -281
@@ -14,271 +14,29 @@ export interface FDC3
14
14
 
15
15
  ## Properties
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Property
20
-
21
-
22
- </th><th>
23
-
24
- Modifiers
25
-
26
-
27
- </th><th>
28
-
29
- Type
30
-
31
-
32
- </th><th>
33
-
34
- Description
35
-
36
-
37
- </th></tr></thead>
38
- <tbody><tr><td>
39
-
40
- [currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md)
41
-
42
-
43
- </td><td>
44
-
45
-
46
- </td><td>
47
-
48
- Observable&lt;[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->&gt;
49
-
50
-
51
- </td><td>
52
-
53
- Observable which emits the current channel When a new channel is joined a new value is emitted
54
-
55
-
56
- </td></tr>
57
- <tr><td>
58
-
59
- [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md)
60
-
61
-
62
- </td><td>
63
-
64
-
65
- </td><td>
66
-
67
- () =&gt; boolean
68
-
69
-
70
- </td><td>
71
-
72
- Check if the interop global is available.
73
-
74
-
75
- </td></tr>
76
- <tr><td>
77
-
78
- [isReady](./foundation-fdc3.fdc3.isready.md)
79
-
80
-
81
- </td><td>
82
-
83
-
84
- </td><td>
85
-
86
- boolean
87
-
88
-
89
- </td><td>
90
-
91
- Whether the FDC3 API is ready.
92
-
93
-
94
- </td></tr>
95
- <tr><td>
96
-
97
- [isReady$](./foundation-fdc3.fdc3.isready_.md)
98
-
99
-
100
- </td><td>
101
-
102
-
103
- </td><td>
104
-
105
- Observable&lt;true&gt;
106
-
107
-
108
- </td><td>
109
-
110
- Observable indicating the FDC3 API is ready.
111
-
112
-
113
- </td></tr>
114
- </tbody></table>
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [currentChannel$](./foundation-fdc3.fdc3.currentchannel_.md) | | Observable&lt;[FDC3Channel](./foundation-fdc3.fdc3channel.md)<!-- -->&gt; | Observable which emits the current channel When a new channel is joined a new value is emitted |
20
+ | [isInteropFdc3](./foundation-fdc3.fdc3.isinteropfdc3.md) | | () =&gt; boolean | Check if the interop global is available. |
21
+ | [isReady](./foundation-fdc3.fdc3.isready.md) | | boolean | Whether the FDC3 API is ready. |
22
+ | [isReady$](./foundation-fdc3.fdc3.isready_.md) | | Observable&lt;true&gt; | Observable indicating the FDC3 API is ready. |
115
23
 
116
24
  ## Methods
117
25
 
118
- <table><thead><tr><th>
119
-
120
- Method
121
-
122
-
123
- </th><th>
124
-
125
- Description
126
-
127
-
128
- </th></tr></thead>
129
- <tbody><tr><td>
130
-
131
- [addChannelListener(channelName, channelType, callback)](./foundation-fdc3.fdc3.addchannellistener.md)
132
-
133
-
134
- </td><td>
135
-
136
- Helper function to add a context listener on a channel with a handler for channel messages
137
-
138
-
139
- </td></tr>
140
- <tr><td>
141
-
142
- [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md)
143
-
144
-
145
- </td><td>
146
-
147
- Adds intent listeners for the specified intents.
148
-
149
-
150
- </td></tr>
151
- <tr><td>
152
-
153
- [addSystemChannelListener(channelType, callback)](./foundation-fdc3.fdc3.addsystemchannellistener.md)
154
-
155
-
156
- </td><td>
157
-
158
- Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages
159
-
160
-
161
- </td></tr>
162
- <tr><td>
163
-
164
- [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md)
165
-
166
-
167
- </td><td>
168
-
169
- Broadcasts a message on a given channel with a given type
170
-
171
-
172
- </td></tr>
173
- <tr><td>
174
-
175
- [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md)
176
-
177
-
178
- </td><td>
179
-
180
- Helper function to broadcast message on channel in response to dispatched event
181
-
182
-
183
- </td></tr>
184
- <tr><td>
185
-
186
- [broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md)
187
-
188
-
189
- </td><td>
190
-
191
- Broadcasts a message on the current app channel
192
-
193
-
194
- </td></tr>
195
- <tr><td>
196
-
197
- [findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md)
198
-
199
-
200
- </td><td>
201
-
202
- Finds an app that supports the specified intent.
203
-
204
-
205
- </td></tr>
206
- <tr><td>
207
-
208
- [findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md)
209
-
210
-
211
- </td><td>
212
-
213
- Finds all the intents supported by the specified context.
214
-
215
-
216
- </td></tr>
217
- <tr><td>
218
-
219
- [getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md)
220
-
221
-
222
- </td><td>
223
-
224
- Helper function to get the current channel of the application
225
-
226
-
227
- </td></tr>
228
- <tr><td>
229
-
230
- [getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md)
231
-
232
-
233
- </td><td>
234
-
235
- Gets or creates the specified channel.
236
-
237
-
238
- </td></tr>
239
- <tr><td>
240
-
241
- [handleChannelCurrentContext(channel, contextType, listenerCallback)](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md)
242
-
243
-
244
- </td><td>
245
-
246
- Helper function to add a context listener on a channel with a handler for channel messages
247
-
248
-
249
- </td></tr>
250
- <tr><td>
251
-
252
- [joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md)
253
-
254
-
255
- </td><td>
256
-
257
- Joins the specified channel.
258
-
259
-
260
- </td></tr>
261
- <tr><td>
262
-
263
- [raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md)
264
-
265
-
266
- </td><td>
267
-
268
- Raises the specified intent with the specified context.
269
-
270
-
271
- </td></tr>
272
- <tr><td>
273
-
274
- [raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md)
275
-
276
-
277
- </td><td>
278
-
279
- Raises an intent against an application based purely on the context data.
280
-
281
-
282
- </td></tr>
283
- </tbody></table>
26
+ | Method | Description |
27
+ | --- | --- |
28
+ | [addChannelListener(channelName, channelType, callback)](./foundation-fdc3.fdc3.addchannellistener.md) | Helper function to add a context listener on a channel with a handler for channel messages |
29
+ | [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
30
+ | [addSystemChannelListener(channelType, callback)](./foundation-fdc3.fdc3.addsystemchannellistener.md) | Helper function to add a context listener on to the system, aka 'color', channel with a handler for channel messages |
31
+ | [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
32
+ | [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md) | Helper function to broadcast message on channel in response to dispatched event |
33
+ | [broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md) | Broadcasts a message on the current app channel |
34
+ | [findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md) | Finds an app that supports the specified intent. |
35
+ | [findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md) | Finds all the intents supported by the specified context. |
36
+ | [getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md) | Helper function to get the current channel of the application |
37
+ | [getOrCreateChannel(channelId)](./foundation-fdc3.fdc3.getorcreatechannel.md) | Gets or creates the specified channel. |
38
+ | [handleChannelCurrentContext(channel, contextType, listenerCallback)](./foundation-fdc3.fdc3.handlechannelcurrentcontext.md) | Helper function to add a context listener on a channel with a handler for channel messages |
39
+ | [joinChannel(channelId)](./foundation-fdc3.fdc3.joinchannel.md) | Joins the specified channel. |
40
+ | [raiseIntent(context, intent)](./foundation-fdc3.fdc3.raiseintent.md) | Raises the specified intent with the specified context. |
41
+ | [raiseIntentForContext(context)](./foundation-fdc3.fdc3.raiseintentforcontext.md) | Raises an intent against an application based purely on the context data. |
284
42
 
@@ -14,55 +14,10 @@ raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResol
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- context
36
-
37
-
38
- </td><td>
39
-
40
- [FDC3Context](./foundation-fdc3.fdc3context.md)
41
-
42
-
43
- </td><td>
44
-
45
- The context to use.
46
-
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- intent
52
-
53
-
54
- </td><td>
55
-
56
- [FDC3Intents](./foundation-fdc3.fdc3intents.md)
57
-
58
-
59
- </td><td>
60
-
61
- _(Optional)_ The intent to raise.
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
20
+ | intent | [FDC3Intents](./foundation-fdc3.fdc3intents.md) | _(Optional)_ The intent to raise. |
66
21
 
67
22
  **Returns:**
68
23
 
@@ -14,39 +14,9 @@ raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
14
14
 
15
15
  ## Parameters
16
16
 
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- context
36
-
37
-
38
- </td><td>
39
-
40
- [FDC3Context](./foundation-fdc3.fdc3context.md)
41
-
42
-
43
- </td><td>
44
-
45
- The context to use.
46
-
47
-
48
- </td></tr>
49
- </tbody></table>
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | context | [FDC3Context](./foundation-fdc3.fdc3context.md) | The context to use. |
50
20
 
51
21
  **Returns:**
52
22
 
@@ -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() function
5
+ ## interopFoundationNotificationListener variable
6
6
 
7
7
  The Foundation Interop Notification Listener
8
8
 
@@ -20,46 +20,6 @@ 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
-
63
23
  ## Remarks
64
24
 
65
25
  HTML Element: &lt;<!-- -->foundation-interop-notification-listener<!-- -->&gt;
@@ -17,77 +17,13 @@ This component extends the notification listener class and overrides the logic f
17
17
 
18
18
  ## Properties
19
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
- [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>
20
+ | Property | Modifiers | Type | Description |
21
+ | --- | --- | --- | --- |
22
+ | [iOConnectNotificationOptions](./foundation-fdc3.interopnotificationslistener.ioconnectnotificationoptions.md) | | IOConnectDesktop.Notifications.IOConnectNotificationOptions | |
59
23
 
60
24
  ## Methods
61
25
 
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>
26
+ | Method | Modifiers | Description |
27
+ | --- | --- | --- |
28
+ | [showNotificationToast(row)](./foundation-fdc3.interopnotificationslistener.shownotificationtoast.md) | <code>protected</code> | |
93
29
 
@@ -12,37 +12,9 @@ protected showNotificationToast(row: NotificationDataRow): void;
12
12
 
13
13
  ## Parameters
14
14
 
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>
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | row | NotificationDataRow | |
46
18
 
47
19
  **Returns:**
48
20