@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.
- package/dist/dts/fdc3-channel-event.d.ts +223 -264
- package/dist/dts/fdc3-channel-event.d.ts.map +1 -1
- package/dist/dts/tsdoc-metadata.json +1 -1
- package/dist/dts/util/fdc3-intent-listener.d.ts +223 -264
- package/dist/dts/util/fdc3-intent-listener.d.ts.map +1 -1
- package/dist/dts/util/fdc3-raise-intent.d.ts +223 -264
- package/dist/dts/util/fdc3-raise-intent.d.ts.map +1 -1
- package/dist/dts/util/fdc3-system-channel-listener.d.ts +223 -264
- package/dist/dts/util/fdc3-system-channel-listener.d.ts.map +1 -1
- package/dist/dts/util/fdc3-util.d.ts.map +1 -1
- package/dist/esm/fdc3.js +4 -4
- package/dist/foundation-fdc3.api.json +167 -834
- package/dist/foundation-fdc3.d.ts +892 -1056
- package/docs/api/foundation-fdc3.fdc3.addchannellistener.md +5 -65
- package/docs/api/foundation-fdc3.fdc3.addintentlisteners.md +3 -33
- package/docs/api/foundation-fdc3.fdc3.addsystemchannellistener.md +4 -49
- package/docs/api/foundation-fdc3.fdc3.broadcastonchannel.md +5 -65
- package/docs/api/foundation-fdc3.fdc3.broadcastonchanneleventhandler.md +4 -49
- package/docs/api/foundation-fdc3.fdc3.broadcastoncurrentchannel.md +4 -49
- package/docs/api/foundation-fdc3.fdc3.findintent.md +4 -49
- package/docs/api/foundation-fdc3.fdc3.findintentsbycontext.md +3 -33
- package/docs/api/foundation-fdc3.fdc3.getorcreatechannel.md +3 -33
- package/docs/api/foundation-fdc3.fdc3.handlechannelcurrentcontext.md +5 -65
- package/docs/api/foundation-fdc3.fdc3.joinchannel.md +3 -33
- package/docs/api/foundation-fdc3.fdc3.md +22 -264
- package/docs/api/foundation-fdc3.fdc3.raiseintent.md +4 -49
- package/docs/api/foundation-fdc3.fdc3.raiseintentforcontext.md +3 -33
- package/docs/api/foundation-fdc3.interopfoundationnotificationlistener.md +1 -41
- package/docs/api/foundation-fdc3.interopnotificationslistener.md +6 -70
- package/docs/api/foundation-fdc3.interopnotificationslistener.shownotificationtoast.md +3 -31
- package/docs/api/foundation-fdc3.md +18 -236
- package/docs/api/index.md +3 -21
- package/package.json +15 -15
- package/docs/api/foundation-fdc3.appchannellistenerconfig.channelname.md +0 -14
- package/docs/api/foundation-fdc3.appchannellistenerconfig.md +0 -62
- package/docs/api/foundation-fdc3.fdc3contextlistener.config.md +0 -14
- package/docs/api/foundation-fdc3.fdc3contextlistener.md +0 -62
- package/docs/api/foundation-fdc3.fdc3intentlistener.fdc3.md +0 -14
- package/docs/api/foundation-fdc3.fdc3intentlistener.intentconfig.md +0 -14
- package/docs/api/foundation-fdc3.fdc3intentlistener.md +0 -81
- package/docs/api/foundation-fdc3.fdc3raiseintent.eventname.md +0 -14
- package/docs/api/foundation-fdc3.fdc3raiseintent.fdc3.md +0 -14
- package/docs/api/foundation-fdc3.fdc3raiseintent.intentname.md +0 -14
- package/docs/api/foundation-fdc3.fdc3raiseintent.intenttype.md +0 -14
- package/docs/api/foundation-fdc3.fdc3raiseintent.mappingfunction.md +0 -14
- package/docs/api/foundation-fdc3.fdc3raiseintent.md +0 -138
- package/docs/api/foundation-fdc3.fdc3systemchannellistener.config.md +0 -14
- package/docs/api/foundation-fdc3.fdc3systemchannellistener.fdc3.md +0 -14
- package/docs/api/foundation-fdc3.fdc3systemchannellistener.md +0 -81
- package/docs/api/foundation-fdc3.intentconfig.callback.md +0 -14
- package/docs/api/foundation-fdc3.intentconfig.intent.md +0 -14
- package/docs/api/foundation-fdc3.intentconfig.md +0 -80
- package/docs/api/foundation-fdc3.systemchannellistenerconfig.callback.md +0 -14
- package/docs/api/foundation-fdc3.systemchannellistenerconfig.channeltype.md +0 -14
- package/docs/api/foundation-fdc3.systemchannellistenerconfig.md +0 -80
- package/docs/api-report.md.api.md +0 -281
@@ -14,71 +14,11 @@ addChannelListener(channelName: string, channelType: string, callback: (any: any
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channelName
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
string
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
name of the channel
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
channelType
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
string
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
type of the channel
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
<tr><td>
|
66
|
-
|
67
|
-
callback
|
68
|
-
|
69
|
-
|
70
|
-
</td><td>
|
71
|
-
|
72
|
-
(any: any) => void
|
73
|
-
|
74
|
-
|
75
|
-
</td><td>
|
76
|
-
|
77
|
-
handler to for the channel context listener
|
78
|
-
|
79
|
-
|
80
|
-
</td></tr>
|
81
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channelName | string | name of the channel |
|
20
|
+
| channelType | string | type of the channel |
|
21
|
+
| callback | (any: any) => void | handler to for the channel context listener |
|
82
22
|
|
83
23
|
**Returns:**
|
84
24
|
|
@@ -14,39 +14,9 @@ addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
listeners
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
Map<[FDC3Intents](./foundation-fdc3.fdc3intents.md)<!-- -->, [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)<!-- -->>
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
The intent listeners to add.
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| listeners | Map<[FDC3Intents](./foundation-fdc3.fdc3intents.md)<!-- -->, [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)<!-- -->> | The intent listeners to add. |
|
50
20
|
|
51
21
|
**Returns:**
|
52
22
|
|
@@ -14,55 +14,10 @@ addSystemChannelListener(channelType: string, callback: (any: any) => void): Pro
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channelType
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
string
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
type of the channel
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
callback
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
(any: any) => void
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
handler to for the channel context listener
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channelType | string | type of the channel |
|
20
|
+
| callback | (any: any) => void | handler to for the channel context listener |
|
66
21
|
|
67
22
|
**Returns:**
|
68
23
|
|
@@ -14,71 +14,11 @@ broadcastOnChannel(channelName: string, type: string, payload: any): Promise<voi
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channelName
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
string
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
name of the channel
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
type
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
string
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
type of the channel
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
<tr><td>
|
66
|
-
|
67
|
-
payload
|
68
|
-
|
69
|
-
|
70
|
-
</td><td>
|
71
|
-
|
72
|
-
any
|
73
|
-
|
74
|
-
|
75
|
-
</td><td>
|
76
|
-
|
77
|
-
payload sent to the channel
|
78
|
-
|
79
|
-
|
80
|
-
</td></tr>
|
81
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channelName | string | name of the channel |
|
20
|
+
| type | string | type of the channel |
|
21
|
+
| payload | any | payload sent to the channel |
|
82
22
|
|
83
23
|
**Returns:**
|
84
24
|
|
@@ -14,55 +14,10 @@ broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: a
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channelName
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
string
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
name of the channel
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
type
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
string
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
type of the channel
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channelName | string | name of the channel |
|
20
|
+
| type | string | type of the channel |
|
66
21
|
|
67
22
|
**Returns:**
|
68
23
|
|
@@ -14,55 +14,10 @@ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
payload
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
any
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
payload sent to the channel
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
type
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
string
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
_(Optional)_ type of the channel
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| payload | any | payload sent to the channel |
|
20
|
+
| type | string | _(Optional)_ type of the channel |
|
66
21
|
|
67
22
|
**Returns:**
|
68
23
|
|
@@ -14,55 +14,10 @@ findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
intent
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
[FDC3Intents](./foundation-fdc3.fdc3intents.md)
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
The intent to find an app for.
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
context
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
[FDC3Context](./foundation-fdc3.fdc3context.md)
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
_(Optional)_ The context to use.
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| intent | [FDC3Intents](./foundation-fdc3.fdc3intents.md) | The intent to find an app for. |
|
20
|
+
| context | [FDC3Context](./foundation-fdc3.fdc3context.md) | _(Optional)_ The context to use. |
|
66
21
|
|
67
22
|
**Returns:**
|
68
23
|
|
@@ -14,39 +14,9 @@ findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
|
@@ -14,39 +14,9 @@ getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channelId
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
string
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
The ID of the channel to get or create.
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channelId | string | The ID of the channel to get or create. |
|
50
20
|
|
51
21
|
**Returns:**
|
52
22
|
|
@@ -14,71 +14,11 @@ handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string,
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channel
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
Channel \| [FDC3Channel](./foundation-fdc3.fdc3channel.md)
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
channel instance for getting for getting current context
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
<tr><td>
|
50
|
-
|
51
|
-
contextType
|
52
|
-
|
53
|
-
|
54
|
-
</td><td>
|
55
|
-
|
56
|
-
string
|
57
|
-
|
58
|
-
|
59
|
-
</td><td>
|
60
|
-
|
61
|
-
context type of the channel to listen to
|
62
|
-
|
63
|
-
|
64
|
-
</td></tr>
|
65
|
-
<tr><td>
|
66
|
-
|
67
|
-
listenerCallback
|
68
|
-
|
69
|
-
|
70
|
-
</td><td>
|
71
|
-
|
72
|
-
(FDC3Context: any) => any
|
73
|
-
|
74
|
-
|
75
|
-
</td><td>
|
76
|
-
|
77
|
-
handler to for the channel context listener
|
78
|
-
|
79
|
-
|
80
|
-
</td></tr>
|
81
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channel | Channel \| [FDC3Channel](./foundation-fdc3.fdc3channel.md) | channel instance for getting for getting current context |
|
20
|
+
| contextType | string | context type of the channel to listen to |
|
21
|
+
| listenerCallback | (FDC3Context: any) => any | handler to for the channel context listener |
|
82
22
|
|
83
23
|
**Returns:**
|
84
24
|
|
@@ -14,39 +14,9 @@ joinChannel(channelId: string): Promise<void>;
|
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
-
channelId
|
36
|
-
|
37
|
-
|
38
|
-
</td><td>
|
39
|
-
|
40
|
-
string
|
41
|
-
|
42
|
-
|
43
|
-
</td><td>
|
44
|
-
|
45
|
-
The ID of the channel to join.
|
46
|
-
|
47
|
-
|
48
|
-
</td></tr>
|
49
|
-
</tbody></table>
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| channelId | string | The ID of the channel to join. |
|
50
20
|
|
51
21
|
**Returns:**
|
52
22
|
|