@genesislcap/foundation-fdc3 14.192.0 → 14.192.2-fdc3-enhancements.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,25 @@
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; [FDC3](./foundation-fdc3.fdc3.md) &gt; [broadcastOnCurrentChannel](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md)
4
+
5
+ ## FDC3.broadcastOnCurrentChannel() method
6
+
7
+ Broadcasts a message on the current app channel
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | payload | any | payload sent to the channel |
20
+ | type | string | _(Optional)_ type of the channel |
21
+
22
+ **Returns:**
23
+
24
+ Promise&lt;void&gt;
25
+
@@ -26,6 +26,7 @@ export interface FDC3
26
26
  | [addIntentListeners(listeners)](./foundation-fdc3.fdc3.addintentlisteners.md) | Adds intent listeners for the specified intents. |
27
27
  | [broadcastOnChannel(channelName, type, payload)](./foundation-fdc3.fdc3.broadcastonchannel.md) | Broadcasts a message on a given channel with a given type |
28
28
  | [broadcastOnChannelEventHandler(channelName, type)](./foundation-fdc3.fdc3.broadcastonchanneleventhandler.md) | Helper function to broadcast message on channel in response to dispatched event |
29
+ | [broadcastOnCurrentChannel(payload, type)](./foundation-fdc3.fdc3.broadcastoncurrentchannel.md) | Broadcasts a message on the current app channel |
29
30
  | [findIntent(intent, context)](./foundation-fdc3.fdc3.findintent.md) | Finds an app that supports the specified intent. |
30
31
  | [findIntentsByContext(context)](./foundation-fdc3.fdc3.findintentsbycontext.md) | Finds all the intents supported by the specified context. |
31
32
  | [getCurrentChannel()](./foundation-fdc3.fdc3.getcurrentchannel.md) | Helper function to get the current channel of the application |
@@ -10,7 +10,6 @@ import { Context } from '@finos/fdc3';
10
10
  import { ContextHandler } from '@finos/fdc3';
11
11
  import { Controller } from '@microsoft/fast-element';
12
12
  import { DOMContainer } from '@genesislcap/foundation-utils';
13
- import { FASTElement } from '@genesislcap/web-core';
14
13
  import { FoundationElement } from '@genesislcap/web-core';
15
14
  import { FoundationElementRegistry } from '@microsoft/fast-foundation';
16
15
  import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
@@ -21,6 +20,7 @@ import { IOConnectDesktop } from '@interopio/desktop';
21
20
  import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
22
21
  import { NotificationDataRow } from '@genesislcap/foundation-notifications';
23
22
  import { NotificationListener } from '@genesislcap/foundation-ui';
23
+ import { Observable } from 'rxjs';
24
24
  import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
25
25
  import { ViewTemplate } from '@microsoft/fast-element';
26
26
 
@@ -48,6 +48,10 @@ export class DefaultFDC3 implements FDC3 {
48
48
  // (undocumented)
49
49
  broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
50
50
  // (undocumented)
51
+ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
52
+ // (undocumented)
53
+ currentChannel$: Observable<Channel>;
54
+ // (undocumented)
51
55
  findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
52
56
  // (undocumented)
53
57
  findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
@@ -71,6 +75,7 @@ export interface FDC3 {
71
75
  addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
72
76
  broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
73
77
  broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
78
+ broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
74
79
  findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
75
80
  findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
76
81
  getCurrentChannel(): Promise<Channel>;
@@ -128,23 +133,31 @@ export interface FDC3IntentResolution extends IntentResolution {
128
133
  // @public (undocumented)
129
134
  export type FDC3Intents = Intents;
130
135
 
136
+ // Warning: (ae-forgotten-export) The symbol "Fdc3Listener_base" needs to be exported by the entry point index.d.ts
137
+ //
131
138
  // @alpha
132
- export class Fdc3Listener extends FASTElement {
139
+ export class Fdc3Listener extends Fdc3Listener_base {
133
140
  // (undocumented)
134
141
  channelConfig: ChannelConfig[];
135
142
  // (undocumented)
136
143
  connectedCallback(): void;
137
144
  // (undocumented)
145
+ deepClone(): Node;
146
+ // (undocumented)
138
147
  fdc3: FDC3;
139
148
  // (undocumented)
140
149
  intentConfig: IntentConfig[];
141
150
  }
142
151
 
152
+ // Warning: (ae-forgotten-export) The symbol "Fdc3RaiseIntent_base" needs to be exported by the entry point index.d.ts
153
+ //
143
154
  // @alpha
144
- export class Fdc3RaiseIntent extends FASTElement {
155
+ export class Fdc3RaiseIntent extends Fdc3RaiseIntent_base {
145
156
  // (undocumented)
146
157
  connectedCallback(): void;
147
158
  // (undocumented)
159
+ deepClone(): Node;
160
+ // (undocumented)
148
161
  disconnectedCallback(): void;
149
162
  // (undocumented)
150
163
  eventName: string;
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.192.0",
4
+ "version": "14.192.2-fdc3-enhancements.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -59,25 +59,26 @@
59
59
  }
60
60
  },
61
61
  "devDependencies": {
62
- "@genesislcap/foundation-testing": "14.192.0",
63
- "@genesislcap/genx": "14.192.0",
64
- "@genesislcap/rollup-builder": "14.192.0",
65
- "@genesislcap/ts-builder": "14.192.0",
66
- "@genesislcap/uvu-playwright-builder": "14.192.0",
67
- "@genesislcap/vite-builder": "14.192.0",
68
- "@genesislcap/webpack-builder": "14.192.0",
62
+ "@genesislcap/foundation-testing": "14.192.2-fdc3-enhancements.1",
63
+ "@genesislcap/genx": "14.192.2-fdc3-enhancements.1",
64
+ "@genesislcap/rollup-builder": "14.192.2-fdc3-enhancements.1",
65
+ "@genesislcap/ts-builder": "14.192.2-fdc3-enhancements.1",
66
+ "@genesislcap/uvu-playwright-builder": "14.192.2-fdc3-enhancements.1",
67
+ "@genesislcap/vite-builder": "14.192.2-fdc3-enhancements.1",
68
+ "@genesislcap/webpack-builder": "14.192.2-fdc3-enhancements.1",
69
69
  "rimraf": "^5.0.0"
70
70
  },
71
71
  "dependencies": {
72
72
  "@finos/fdc3": "^1.2.0",
73
- "@genesislcap/foundation-logger": "14.192.0",
74
- "@genesislcap/foundation-notifications": "14.192.0",
75
- "@genesislcap/foundation-ui": "14.192.0",
76
- "@genesislcap/foundation-utils": "14.192.0",
77
- "@genesislcap/web-core": "14.192.0",
73
+ "@genesislcap/foundation-logger": "14.192.2-fdc3-enhancements.1",
74
+ "@genesislcap/foundation-notifications": "14.192.2-fdc3-enhancements.1",
75
+ "@genesislcap/foundation-ui": "14.192.2-fdc3-enhancements.1",
76
+ "@genesislcap/foundation-utils": "14.192.2-fdc3-enhancements.1",
77
+ "@genesislcap/web-core": "14.192.2-fdc3-enhancements.1",
78
78
  "@interopio/desktop": "^6.3.1",
79
79
  "@microsoft/fast-element": "^1.12.0",
80
80
  "@microsoft/fast-foundation": "^2.49.4",
81
+ "rxjs": "^7.8.1",
81
82
  "tslib": "^2.3.1"
82
83
  },
83
84
  "repository": {
@@ -88,5 +89,5 @@
88
89
  "publishConfig": {
89
90
  "access": "public"
90
91
  },
91
- "gitHead": "655e23ada5211eb8986f1bead581ea9d0b772732"
92
+ "gitHead": "36d9c2f775b72deb81a4b53074e24f463e841d32"
92
93
  }