@openfin/core 37.80.39 → 38.81.8
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/out/mock-alpha.d.ts +295 -460
- package/out/mock-beta.d.ts +295 -460
- package/out/mock-public.d.ts +295 -460
- package/out/mock.d.ts +303 -468
- package/out/mock.js +3169 -1998
- package/package.json +3 -28
package/out/mock.d.ts
CHANGED
@@ -76,14 +76,42 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
|
|
76
76
|
|
77
77
|
declare type AnyStrategy = ChannelStrategy<any>;
|
78
78
|
|
79
|
+
/**
|
80
|
+
* @deprecated Renamed to {@link ApiSettings}.
|
81
|
+
*/
|
82
|
+
declare type Api = ApiSettings;
|
83
|
+
|
84
|
+
declare type ApiCall<Request, Response> = {
|
85
|
+
request: Request;
|
86
|
+
response: Response;
|
87
|
+
};
|
88
|
+
|
89
|
+
declare type ApiClient<T extends Record<any, any>> = {
|
90
|
+
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
91
|
+
};
|
92
|
+
|
93
|
+
/**
|
94
|
+
* @deprecated Renamed to {@link DomainApiSettings}.
|
95
|
+
*/
|
96
|
+
declare type ApiInjection = DomainApiSettings;
|
97
|
+
|
98
|
+
/**
|
99
|
+
* Generated when a new Platform's API becomes responsive.
|
100
|
+
* @interface
|
101
|
+
*/
|
102
|
+
declare type ApiReadyEvent = BaseEvent & {
|
103
|
+
topic: 'application';
|
104
|
+
type: 'platform-api-ready';
|
105
|
+
};
|
106
|
+
|
79
107
|
/**
|
80
108
|
* Configurations for API injection.
|
81
109
|
*
|
82
110
|
* @interface
|
83
111
|
*/
|
84
|
-
declare type
|
112
|
+
declare type ApiSettings = {
|
85
113
|
/**
|
86
|
-
* Configure injection of OpenFin API into iframes
|
114
|
+
* Configure conditional injection of OpenFin API into iframes
|
87
115
|
*/
|
88
116
|
iframe?: {
|
89
117
|
/**
|
@@ -114,41 +142,6 @@ declare type Api = {
|
|
114
142
|
fin?: InjectionType;
|
115
143
|
};
|
116
144
|
|
117
|
-
declare type ApiCall<Request, Response> = {
|
118
|
-
request: Request;
|
119
|
-
response: Response;
|
120
|
-
};
|
121
|
-
|
122
|
-
declare type ApiClient<T extends Record<any, any>> = {
|
123
|
-
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
124
|
-
};
|
125
|
-
|
126
|
-
/**
|
127
|
-
* @interface
|
128
|
-
*
|
129
|
-
* Rules for domain-conditional `fin` API injection.
|
130
|
-
*/
|
131
|
-
declare type ApiInjection = {
|
132
|
-
/**
|
133
|
-
* Injection setting for the `fin` API for contexts on a matched domain.
|
134
|
-
*
|
135
|
-
* * 'none': The `fin` API will be not available.
|
136
|
-
* * 'global': The entire `fin` API will be available.
|
137
|
-
*
|
138
|
-
* @defaultValue 'global'
|
139
|
-
*/
|
140
|
-
fin: InjectionType;
|
141
|
-
};
|
142
|
-
|
143
|
-
/**
|
144
|
-
* Generated when a new Platform's API becomes responsive.
|
145
|
-
* @interface
|
146
|
-
*/
|
147
|
-
declare type ApiReadyEvent = BaseEvent & {
|
148
|
-
topic: 'application';
|
149
|
-
type: 'platform-api-ready';
|
150
|
-
};
|
151
|
-
|
152
145
|
/**
|
153
146
|
* @interface
|
154
147
|
*/
|
@@ -187,31 +180,6 @@ declare type AppAssetRequest = {
|
|
187
180
|
alias: string;
|
188
181
|
};
|
189
182
|
|
190
|
-
declare interface AppIdentifier {
|
191
|
-
/** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
|
192
|
-
readonly appId: string;
|
193
|
-
/** An optional instance identifier, indicating that this object represents a specific instance of the application described. */
|
194
|
-
readonly instanceId?: string;
|
195
|
-
}
|
196
|
-
|
197
|
-
/**
|
198
|
-
* An interface that relates an intent to apps
|
199
|
-
*/
|
200
|
-
declare interface AppIntent {
|
201
|
-
readonly intent: IntentMetadata;
|
202
|
-
readonly apps: Array<AppMetadata>;
|
203
|
-
}
|
204
|
-
|
205
|
-
/**
|
206
|
-
* An interface that relates an intent to apps
|
207
|
-
*/
|
208
|
-
declare interface AppIntent_2 {
|
209
|
-
/** Details of the intent whose relationship to resolving applications is being described. */
|
210
|
-
readonly intent: IntentMetadata_2;
|
211
|
-
/** Details of applications that can resolve the intent. */
|
212
|
-
readonly apps: Array<AppMetadata_2>;
|
213
|
-
}
|
214
|
-
|
215
183
|
/**
|
216
184
|
* An object representing an application. Allows the developer to create,
|
217
185
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
@@ -1428,60 +1396,6 @@ declare type ApplySnapshotPayload = {
|
|
1428
1396
|
options?: ApplySnapshotOptions;
|
1429
1397
|
};
|
1430
1398
|
|
1431
|
-
/**
|
1432
|
-
* App definition as provided by the application directory
|
1433
|
-
*/
|
1434
|
-
declare interface AppMetadata {
|
1435
|
-
/** The unique app name that can be used with the open and raiseIntent calls. */
|
1436
|
-
readonly name: string;
|
1437
|
-
/** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
|
1438
|
-
readonly appId?: string;
|
1439
|
-
/** The Version of the application. */
|
1440
|
-
readonly version?: string;
|
1441
|
-
/** A more user-friendly application title that can be used to render UI elements */
|
1442
|
-
readonly title?: string;
|
1443
|
-
/** A tooltip for the application that can be used to render UI elements */
|
1444
|
-
readonly tooltip?: string;
|
1445
|
-
/** A longer, multi-paragraph description for the application that could include markup */
|
1446
|
-
readonly description?: string;
|
1447
|
-
/** A list of icon URLs for the application that can be used to render UI elements */
|
1448
|
-
readonly icons?: Array<string>;
|
1449
|
-
/** A list of image URLs for the application that can be used to render UI elements */
|
1450
|
-
readonly images?: Array<string>;
|
1451
|
-
}
|
1452
|
-
|
1453
|
-
/**
|
1454
|
-
* Extends an `AppIdentifier`, describing an application or instance of an application, with additional descriptive metadata that is usually provided by an FDC3 App Directory that the desktop agent connects to.
|
1455
|
-
*
|
1456
|
-
* The additional information from an app directory can aid in rendering UI elements, such as a launcher menu or resolver UI. This includes a title, description, tooltip and icon and screenshot URLs.
|
1457
|
-
*
|
1458
|
-
* Note that as `AppMetadata` instances are also `AppIdentifiers` they may be passed to the `app` argument of `fdc3.open`, `fdc3.raiseIntent` etc.
|
1459
|
-
*/
|
1460
|
-
declare interface AppMetadata_2 extends AppIdentifier {
|
1461
|
-
/**
|
1462
|
-
The 'friendly' app name.
|
1463
|
-
This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` wth `appId` set.
|
1464
|
-
Note that for display purposes the `title` field should be used, if set, in preference to this field.
|
1465
|
-
*/
|
1466
|
-
readonly name?: string;
|
1467
|
-
/** The Version of the application. */
|
1468
|
-
readonly version?: string;
|
1469
|
-
/** An optional set of, implementation specific, metadata fields that can be used to disambiguate instances, such as a window title or screen position. Must only be set if `instanceId` is set. */
|
1470
|
-
readonly instanceMetadata?: Record<string, any>;
|
1471
|
-
/** A more user-friendly application title that can be used to render UI elements */
|
1472
|
-
readonly title?: string;
|
1473
|
-
/** A tooltip for the application that can be used to render UI elements */
|
1474
|
-
readonly tooltip?: string;
|
1475
|
-
/** A longer, multi-paragraph description for the application that could include markup */
|
1476
|
-
readonly description?: string;
|
1477
|
-
/** A list of icon URLs for the application that can be used to render UI elements */
|
1478
|
-
readonly icons?: Array<Icon>;
|
1479
|
-
/** Images representing the app in common usage scenarios that can be used to render UI elements */
|
1480
|
-
readonly screenshots?: Array<Image_2>;
|
1481
|
-
/** The type of output returned for any intent specified during resolution. May express a particular context type (e.g. "fdc3.instrument"), channel (e.g. "channel") or a channel that will receive a specified type (e.g. "channel<fdc3.instrument>"). */
|
1482
|
-
readonly resultType?: string | null;
|
1483
|
-
}
|
1484
|
-
|
1485
1399
|
/**
|
1486
1400
|
* @interface
|
1487
1401
|
*/
|
@@ -2408,25 +2322,7 @@ declare class Channel extends EmitterBase<ChannelEvent> {
|
|
2408
2322
|
|
2409
2323
|
declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
2410
2324
|
|
2411
|
-
declare
|
2412
|
-
id: string;
|
2413
|
-
type: string;
|
2414
|
-
displayMetadata?: DisplayMetadata;
|
2415
|
-
broadcast(context: Context): void;
|
2416
|
-
getCurrentContext(contextType?: string): Promise<Context | null>;
|
2417
|
-
addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
|
2418
|
-
}
|
2419
|
-
|
2420
|
-
declare interface Channel_4 {
|
2421
|
-
readonly id: string;
|
2422
|
-
readonly type: 'user' | 'app' | 'private';
|
2423
|
-
readonly displayMetadata?: DisplayMetadata_2;
|
2424
|
-
broadcast(context: Context_2): Promise<void>;
|
2425
|
-
getCurrentContext(contextType?: string): Promise<Context_2 | null>;
|
2426
|
-
addContextListener(contextType: string | null, handler: ContextHandler_2): Listener_2 & Promise<Listener_2>;
|
2427
|
-
}
|
2428
|
-
|
2429
|
-
declare type Channel_5 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
2325
|
+
declare type Channel_3 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
2430
2326
|
|
2431
2327
|
declare type ChannelAction = OpenFin_2.ChannelAction;
|
2432
2328
|
|
@@ -2743,7 +2639,7 @@ declare class ChannelClient extends ChannelBase {
|
|
2743
2639
|
/**
|
2744
2640
|
* @internal
|
2745
2641
|
*/
|
2746
|
-
constructor(routingInfo: OpenFin_2.RoutingInfo,
|
2642
|
+
constructor(routingInfo: OpenFin_2.RoutingInfo, close: () => Promise<void>, strategy: AnyStrategy);
|
2747
2643
|
protected processAction: (action: string, payload: any, senderIdentity: OpenFin_2.ProviderIdentity | OpenFin_2.ClientIdentity) => Promise<any>;
|
2748
2644
|
/**
|
2749
2645
|
* a read-only provider identity
|
@@ -2809,6 +2705,11 @@ declare class ChannelClient extends ChannelBase {
|
|
2809
2705
|
*/
|
2810
2706
|
disconnect(): Promise<void>;
|
2811
2707
|
sendDisconnectAction(): Promise<void>;
|
2708
|
+
/**
|
2709
|
+
* @internal
|
2710
|
+
* Writing this as a static to keep code together, but in environments with a wire, this will be DI'd into the protectedObject class as close.
|
2711
|
+
*/
|
2712
|
+
static wireClose(wire: Transport, providerIdentity: OpenFin_2.ProviderIdentity, endpointId: string): Promise<void>;
|
2812
2713
|
}
|
2813
2714
|
|
2814
2715
|
declare type ChannelClient_2 = OpenFin_2.ChannelClient;
|
@@ -2896,7 +2797,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
2896
2797
|
/**
|
2897
2798
|
* @internal
|
2898
2799
|
*/
|
2899
|
-
constructor(providerIdentity: ProviderIdentity_3,
|
2800
|
+
constructor(providerIdentity: ProviderIdentity_3, close: () => Promise<void>, strategy: AnyStrategy);
|
2900
2801
|
/**
|
2901
2802
|
* Dispatch an action to a specified client. Returns a promise for the result of executing that action on the client side.
|
2902
2803
|
*
|
@@ -3052,6 +2953,7 @@ declare class ChannelProvider extends ChannelBase {
|
|
3052
2953
|
private getEndpointIdForOpenFinId;
|
3053
2954
|
private static clientIdentityIncludesEndpointId;
|
3054
2955
|
private static clientIsMultiRuntime;
|
2956
|
+
static wireClose(wire: Transport, channelName: string): Promise<void>;
|
3055
2957
|
}
|
3056
2958
|
|
3057
2959
|
declare type ChannelProviderDisconnectionListener = (identity: ProviderIdentity_4) => any;
|
@@ -3553,7 +3455,7 @@ declare type ConstViewOptions = {
|
|
3553
3455
|
/**
|
3554
3456
|
* Configurations for API injection.
|
3555
3457
|
*/
|
3556
|
-
api:
|
3458
|
+
api: ApiSettings;
|
3557
3459
|
/**
|
3558
3460
|
* The name of the view.
|
3559
3461
|
*/
|
@@ -3973,7 +3875,23 @@ declare interface Container extends EventEmitter_2 {
|
|
3973
3875
|
close(): boolean;
|
3974
3876
|
}
|
3975
3877
|
|
3976
|
-
|
3878
|
+
/**
|
3879
|
+
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
3880
|
+
*/
|
3881
|
+
declare type ContentBlockedEvent = NamedEvent & {
|
3882
|
+
type: 'content-blocked';
|
3883
|
+
/**
|
3884
|
+
* The domain whose content was blocked.
|
3885
|
+
*/
|
3886
|
+
url: string;
|
3887
|
+
};
|
3888
|
+
|
3889
|
+
declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
|
3890
|
+
|
3891
|
+
/**
|
3892
|
+
* @deprecated Renamed to {@link ContentCreationBehavior}.
|
3893
|
+
*/
|
3894
|
+
declare type ContentCreationBehaviorNames = ContentCreationBehavior;
|
3977
3895
|
|
3978
3896
|
/**
|
3979
3897
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
@@ -3997,7 +3915,7 @@ declare type ContentCreationOptions = {
|
|
3997
3915
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
3998
3916
|
* the specified `behavior` key.
|
3999
3917
|
*/
|
4000
|
-
declare type ContentCreationRule<Behavior extends
|
3918
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
4001
3919
|
behavior: Behavior;
|
4002
3920
|
}>;
|
4003
3921
|
|
@@ -4247,39 +4165,39 @@ declare interface ContentItem extends EventEmitter_2 {
|
|
4247
4165
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
4248
4166
|
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
4249
4167
|
*
|
4168
|
+
* @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
|
4169
|
+
* `content` setting, this setting will be **ignored**.
|
4170
|
+
*
|
4250
4171
|
* @interface
|
4251
4172
|
*/
|
4252
4173
|
declare type ContentNavigation = NavigationRules;
|
4253
4174
|
|
4175
|
+
/**
|
4176
|
+
* Whether a content url is allowed or blocked for navigation or redirection.
|
4177
|
+
*
|
4178
|
+
* * 'allow': The content url is allowed.
|
4179
|
+
* * 'block': The content url is blocked.
|
4180
|
+
*/
|
4181
|
+
declare type ContentPermission = 'allow' | 'block';
|
4182
|
+
|
4254
4183
|
/**
|
4255
4184
|
* Restrict redirects to URLs that match an allowed pattern.
|
4256
4185
|
* In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
|
4257
4186
|
* See [here](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) for more details.
|
4258
4187
|
*
|
4188
|
+
* @remarks Superseded by {@link DomainSettingsRule.content}. If {@link DomainSettings.default} includes a
|
4189
|
+
* `content` setting, this setting will be **ignored**.
|
4190
|
+
*
|
4259
4191
|
* @interface
|
4260
4192
|
*/
|
4261
4193
|
declare type ContentRedirect = NavigationRules;
|
4262
4194
|
|
4263
|
-
declare interface Context {
|
4264
|
-
id?: { [key: string]: string };
|
4265
|
-
name?: string;
|
4266
|
-
type: string;
|
4267
|
-
}
|
4268
|
-
|
4269
|
-
declare interface Context_2 {
|
4270
|
-
id?: { [key: string]: string };
|
4271
|
-
name?: string;
|
4272
|
-
type: string;
|
4273
|
-
contextMetadata?: ContextMetadata;
|
4274
|
-
metadata?: any;
|
4275
|
-
}
|
4276
|
-
|
4277
4195
|
/**
|
4278
4196
|
* Data passed between entities and applications.
|
4279
4197
|
*
|
4280
4198
|
* @interface
|
4281
4199
|
*/
|
4282
|
-
declare type
|
4200
|
+
declare type Context = {
|
4283
4201
|
/**
|
4284
4202
|
* An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
4285
4203
|
*/
|
@@ -4308,7 +4226,7 @@ declare type ContextChangedEvent = BaseEvent_5 & {
|
|
4308
4226
|
/**
|
4309
4227
|
* @interface
|
4310
4228
|
*/
|
4311
|
-
declare type ContextForIntent<MetadataType = any> =
|
4229
|
+
declare type ContextForIntent<MetadataType = any> = Context & {
|
4312
4230
|
metadata?: MetadataType;
|
4313
4231
|
};
|
4314
4232
|
|
@@ -4324,23 +4242,19 @@ declare type ContextGroupInfo = {
|
|
4324
4242
|
/**
|
4325
4243
|
* Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
|
4326
4244
|
*/
|
4327
|
-
displayMetadata?:
|
4245
|
+
displayMetadata?: DisplayMetadata;
|
4328
4246
|
};
|
4329
4247
|
|
4330
4248
|
declare type ContextGroupStates = {
|
4331
4249
|
[key: string]: {
|
4332
|
-
[key: string]:
|
4250
|
+
[key: string]: Context;
|
4333
4251
|
};
|
4334
4252
|
};
|
4335
4253
|
|
4336
|
-
declare type ContextHandler = (context: Context) => void;
|
4337
|
-
|
4338
|
-
declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
|
4339
|
-
|
4340
4254
|
/**
|
4341
4255
|
* Subscription function for addContextHandler.
|
4342
4256
|
*/
|
4343
|
-
declare type
|
4257
|
+
declare type ContextHandler = (context: Context) => void;
|
4344
4258
|
|
4345
4259
|
/**
|
4346
4260
|
* Configure the context menu when right-clicking on a window.
|
@@ -4379,20 +4293,6 @@ declare type ContextMenuSettings = {
|
|
4379
4293
|
reload?: boolean;
|
4380
4294
|
};
|
4381
4295
|
|
4382
|
-
/**
|
4383
|
-
* Metadata relating to a context or intent and context received through the
|
4384
|
-
* `addContextListener` and `addIntentListener` functions.
|
4385
|
-
*
|
4386
|
-
* @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
|
4387
|
-
*/
|
4388
|
-
declare interface ContextMetadata {
|
4389
|
-
/** Identifier for the app instance that sent the context and/or intent.
|
4390
|
-
*
|
4391
|
-
* @experimental
|
4392
|
-
*/
|
4393
|
-
readonly source: AppIdentifier;
|
4394
|
-
}
|
4395
|
-
|
4396
4296
|
/**
|
4397
4297
|
* @interface
|
4398
4298
|
*/
|
@@ -4639,45 +4539,6 @@ declare type DefaultDomainSettings = DomainSettings;
|
|
4639
4539
|
*/
|
4640
4540
|
declare type DefaultDomainSettingsRule = DomainSettingsRule;
|
4641
4541
|
|
4642
|
-
declare interface DesktopAgent {
|
4643
|
-
open(app: TargetApp, context?: Context): Promise<void>;
|
4644
|
-
findIntent(intent: string, context?: Context): Promise<AppIntent>;
|
4645
|
-
findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
|
4646
|
-
broadcast(context: Context): void;
|
4647
|
-
raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
|
4648
|
-
raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
|
4649
|
-
addIntentListener(intent: string, handler: ContextHandler): Listener;
|
4650
|
-
joinChannel(channelId: string): Promise<void>;
|
4651
|
-
leaveCurrentChannel(): Promise<void>;
|
4652
|
-
getInfo(): ImplementationMetadata;
|
4653
|
-
addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
|
4654
|
-
getOrCreateChannel(channelId: string): Promise<Channel_3>;
|
4655
|
-
getSystemChannels(): Promise<SystemChannel[]>;
|
4656
|
-
getCurrentChannel(): Promise<Channel_3 | null>;
|
4657
|
-
}
|
4658
|
-
|
4659
|
-
declare interface DesktopAgent_2 {
|
4660
|
-
open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
|
4661
|
-
findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
|
4662
|
-
findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
|
4663
|
-
findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
|
4664
|
-
broadcast(context: Context_2): Promise<void>;
|
4665
|
-
raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
|
4666
|
-
raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
|
4667
|
-
addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
|
4668
|
-
addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
|
4669
|
-
getUserChannels(): Promise<Array<SystemChannel>>;
|
4670
|
-
joinUserChannel(channelId: string): Promise<void>;
|
4671
|
-
getOrCreateChannel(channelId: string): Promise<Channel_4>;
|
4672
|
-
createPrivateChannel(): Promise<PrivateChannel>;
|
4673
|
-
getCurrentChannel(): Promise<Channel_3 | null>;
|
4674
|
-
leaveCurrentChannel(): Promise<void>;
|
4675
|
-
getInfo(): Promise<ImplementationMetadata_2>;
|
4676
|
-
getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
|
4677
|
-
getSystemChannels(): Promise<Array<SystemChannel>>;
|
4678
|
-
joinChannel(channelId: string): Promise<void>;
|
4679
|
-
}
|
4680
|
-
|
4681
4542
|
/**
|
4682
4543
|
* Generated when the desktop icon is clicked while it's already running.
|
4683
4544
|
* @interface
|
@@ -4822,52 +4683,12 @@ declare type DisconnectedEvent_3 = BaseFrameEvent & {
|
|
4822
4683
|
type: 'disconnected';
|
4823
4684
|
};
|
4824
4685
|
|
4825
|
-
/**
|
4826
|
-
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4827
|
-
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
4828
|
-
* this is their meaning.
|
4829
|
-
*/
|
4830
|
-
declare interface DisplayMetadata {
|
4831
|
-
/**
|
4832
|
-
* A user-readable name for this channel, e.g: `"Red"`
|
4833
|
-
*/
|
4834
|
-
readonly name?: string;
|
4835
|
-
/**
|
4836
|
-
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
4837
|
-
*/
|
4838
|
-
readonly color?: string;
|
4839
|
-
/**
|
4840
|
-
* A URL of an image that can be used to display this channel
|
4841
|
-
*/
|
4842
|
-
readonly glyph?: string;
|
4843
|
-
}
|
4844
|
-
|
4845
|
-
/**
|
4846
|
-
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
4847
|
-
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
4848
|
-
* this is their meaning.
|
4849
|
-
*/
|
4850
|
-
declare interface DisplayMetadata_2 {
|
4851
|
-
/**
|
4852
|
-
* A user-readable name for this channel, e.g: `"Red"`
|
4853
|
-
*/
|
4854
|
-
readonly name?: string;
|
4855
|
-
/**
|
4856
|
-
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
4857
|
-
*/
|
4858
|
-
readonly color?: string;
|
4859
|
-
/**
|
4860
|
-
* A URL of an image that can be used to display this channel
|
4861
|
-
*/
|
4862
|
-
readonly glyph?: string;
|
4863
|
-
}
|
4864
|
-
|
4865
4686
|
/**
|
4866
4687
|
* The display data for a context group.
|
4867
4688
|
*
|
4868
4689
|
* @interface
|
4869
4690
|
*/
|
4870
|
-
declare type
|
4691
|
+
declare type DisplayMetadata = {
|
4871
4692
|
/**
|
4872
4693
|
* A user-readable name for this context group, e.g: `"Red"`
|
4873
4694
|
*/
|
@@ -4882,6 +4703,25 @@ declare type DisplayMetadata_3 = {
|
|
4882
4703
|
readonly glyph?: string;
|
4883
4704
|
};
|
4884
4705
|
|
4706
|
+
/**
|
4707
|
+
* @interface
|
4708
|
+
*
|
4709
|
+
* Rules for domain-conditional `fin` API injection.
|
4710
|
+
*
|
4711
|
+
* @remarks Subset of {@link DomainSettings}.
|
4712
|
+
*/
|
4713
|
+
declare type DomainApiSettings = {
|
4714
|
+
/**
|
4715
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
4716
|
+
*
|
4717
|
+
* * 'none': The `fin` API will be not available.
|
4718
|
+
* * 'global': The entire `fin` API will be available.
|
4719
|
+
*
|
4720
|
+
* @defaultValue 'global'
|
4721
|
+
*/
|
4722
|
+
fin: InjectionType;
|
4723
|
+
};
|
4724
|
+
|
4885
4725
|
/**
|
4886
4726
|
* @interface
|
4887
4727
|
* Defines application settings that vary by the domain of the current context.
|
@@ -4894,6 +4734,10 @@ declare type DomainSettings = {
|
|
4894
4734
|
* {@inheritDoc DomainSettingsRule}
|
4895
4735
|
*/
|
4896
4736
|
rules: DomainSettingsRule[];
|
4737
|
+
/**
|
4738
|
+
* Default values for settings in {@link DomainSettingsRule}.
|
4739
|
+
*/
|
4740
|
+
default?: PerDomainSettings;
|
4897
4741
|
};
|
4898
4742
|
|
4899
4743
|
/**
|
@@ -4906,22 +4750,11 @@ declare type DomainSettingsRule = {
|
|
4906
4750
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
4907
4751
|
* the domain(s) for which the rule applies.
|
4908
4752
|
*/
|
4909
|
-
match
|
4753
|
+
match?: string[];
|
4910
4754
|
/**
|
4911
4755
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
4912
4756
|
*/
|
4913
|
-
options:
|
4914
|
-
/**
|
4915
|
-
* {@inheritDoc FileDownloadSettings}
|
4916
|
-
*
|
4917
|
-
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
4918
|
-
*/
|
4919
|
-
downloadSettings?: FileDownloadSettings;
|
4920
|
-
/**
|
4921
|
-
* {@inheritDoc ApiInjection}
|
4922
|
-
*/
|
4923
|
-
api?: ApiInjection;
|
4924
|
-
};
|
4757
|
+
options: PerDomainSettings;
|
4925
4758
|
};
|
4926
4759
|
|
4927
4760
|
/**
|
@@ -4959,18 +4792,19 @@ declare type DownloadPreloadOption = {
|
|
4959
4792
|
/**
|
4960
4793
|
* @interface
|
4961
4794
|
*
|
4962
|
-
* A rule
|
4795
|
+
* A rule that governs download behavior, discriminated by the URL of the download.
|
4963
4796
|
*/
|
4964
4797
|
declare type DownloadRule = {
|
4965
4798
|
/**
|
4966
|
-
* {@inheritDoc
|
4799
|
+
* {@inheritDoc FileDownloadBehavior}
|
4967
4800
|
*/
|
4968
|
-
behavior:
|
4801
|
+
behavior: FileDownloadBehavior;
|
4969
4802
|
/**
|
4970
4803
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
4971
|
-
*
|
4804
|
+
* URL(s) of the resource(s) being downloaded.
|
4972
4805
|
*
|
4973
|
-
* @remarks The match is evaluated against the URL of the *
|
4806
|
+
* @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
|
4807
|
+
* of the page in which a file download link is embedded.
|
4974
4808
|
*/
|
4975
4809
|
match: string[];
|
4976
4810
|
};
|
@@ -5250,7 +5084,7 @@ declare interface Environment {
|
|
5250
5084
|
getWsConstructor(): typeof WebSocket;
|
5251
5085
|
whenReady(): Promise<void>;
|
5252
5086
|
getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
|
5253
|
-
fdc3Version?:
|
5087
|
+
fdc3Version?: Version;
|
5254
5088
|
}>;
|
5255
5089
|
readonly type: EnvironmentType;
|
5256
5090
|
}
|
@@ -5318,7 +5152,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5318
5152
|
*/
|
5319
5153
|
declare type Event_5<Topic extends string> = {
|
5320
5154
|
topic: Topic;
|
5321
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
5155
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | ContentBlockedEvent);
|
5322
5156
|
|
5323
5157
|
/**
|
5324
5158
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
@@ -5676,13 +5510,12 @@ declare type FaviconUpdatedEvent = PageFaviconUpdatedEvent;
|
|
5676
5510
|
|
5677
5511
|
declare namespace FDC3 {
|
5678
5512
|
export {
|
5679
|
-
|
5680
|
-
|
5513
|
+
Version,
|
5514
|
+
v1_2,
|
5515
|
+
v2_0
|
5681
5516
|
}
|
5682
5517
|
}
|
5683
5518
|
|
5684
|
-
declare type Fdc3Version = '1.2' | '2.0';
|
5685
|
-
|
5686
5519
|
/**
|
5687
5520
|
* @interface
|
5688
5521
|
*/
|
@@ -5696,7 +5529,12 @@ declare type FetchManifestPayload = {
|
|
5696
5529
|
/**
|
5697
5530
|
* Whether file downloads raise a user prompt.
|
5698
5531
|
*/
|
5699
|
-
declare type
|
5532
|
+
declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
|
5533
|
+
|
5534
|
+
/**
|
5535
|
+
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
5536
|
+
*/
|
5537
|
+
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
5700
5538
|
|
5701
5539
|
/**
|
5702
5540
|
* Generated when a file download has completed.
|
@@ -5883,8 +5721,8 @@ declare type FindInPageResult = {
|
|
5883
5721
|
/**
|
5884
5722
|
* @interface
|
5885
5723
|
*/
|
5886
|
-
declare type FindIntentsByContextOptions<MetadataType =
|
5887
|
-
context:
|
5724
|
+
declare type FindIntentsByContextOptions<MetadataType = IntentMetadata> = {
|
5725
|
+
context: Context;
|
5888
5726
|
metadata?: MetadataType;
|
5889
5727
|
};
|
5890
5728
|
|
@@ -6329,6 +6167,20 @@ declare class GoldenLayout_2 implements EventEmitter_2 {
|
|
6329
6167
|
|
6330
6168
|
dropTargetIndicator: any;
|
6331
6169
|
|
6170
|
+
_isFullPage: boolean;
|
6171
|
+
|
6172
|
+
_onUnload: any;
|
6173
|
+
|
6174
|
+
tabDropPlaceholder: any;
|
6175
|
+
|
6176
|
+
transitionIndicator: any;
|
6177
|
+
|
6178
|
+
_dragSources: any;
|
6179
|
+
|
6180
|
+
_resizeFunction: any;
|
6181
|
+
|
6182
|
+
_unloadFunction: any;
|
6183
|
+
|
6332
6184
|
/**
|
6333
6185
|
* @param config A GoldenLayout configuration object
|
6334
6186
|
* @param container The DOM element the layout will be initialised in. Default: document.body
|
@@ -6657,15 +6509,6 @@ declare type HotkeyEvent_2 = InputEvent_2 & BaseEvent_5 & {
|
|
6657
6509
|
type: 'hotkey';
|
6658
6510
|
};
|
6659
6511
|
|
6660
|
-
declare interface Icon {
|
6661
|
-
/** The icon url */
|
6662
|
-
readonly src: string;
|
6663
|
-
/** The icon dimension, formatted as `<height>x<width>`. */
|
6664
|
-
readonly size?: string;
|
6665
|
-
/** Icon media type. If not present the Desktop Agent may use the src file extension. */
|
6666
|
-
readonly type?: string;
|
6667
|
-
}
|
6668
|
-
|
6669
6512
|
declare type Identity = OpenFin_2.Identity;
|
6670
6513
|
|
6671
6514
|
declare type Identity_2 = OpenFin_2.Identity;
|
@@ -6727,17 +6570,6 @@ declare type IdleStateChangedEvent = BaseEvent_9 & {
|
|
6727
6570
|
isIdle: boolean;
|
6728
6571
|
};
|
6729
6572
|
|
6730
|
-
declare interface Image_2 {
|
6731
|
-
/** The image url. */
|
6732
|
-
readonly src: string;
|
6733
|
-
/** The image dimension, formatted as `<height>x<width>`. */
|
6734
|
-
readonly size?: string;
|
6735
|
-
/** Image media type. If not present the Desktop Agent may use the src file extension. */
|
6736
|
-
readonly type?: string;
|
6737
|
-
/** Caption for the image. */
|
6738
|
-
readonly label?: string;
|
6739
|
-
}
|
6740
|
-
|
6741
6573
|
declare type ImageFormatOptions = {
|
6742
6574
|
format: 'dataURL' | 'png' | 'bmp';
|
6743
6575
|
} | {
|
@@ -6748,57 +6580,15 @@ declare type ImageFormatOptions = {
|
|
6748
6580
|
quality?: number;
|
6749
6581
|
};
|
6750
6582
|
|
6751
|
-
/**
|
6752
|
-
* Metadata relating to the FDC3 Desktop Agent implementation and its provider.
|
6753
|
-
*/
|
6754
|
-
declare interface ImplementationMetadata {
|
6755
|
-
/** The version number of the FDC3 specification that the implementation provides.
|
6756
|
-
* The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
|
6757
|
-
*/
|
6758
|
-
readonly fdc3Version: string;
|
6759
|
-
/** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
|
6760
|
-
readonly provider: string;
|
6761
|
-
/** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
|
6762
|
-
readonly providerVersion?: string;
|
6763
|
-
}
|
6764
|
-
|
6765
|
-
/**
|
6766
|
-
* Metadata relating to the FDC3 Desktop Agent implementation and its provider.
|
6767
|
-
*/
|
6768
|
-
declare interface ImplementationMetadata_2 {
|
6769
|
-
/** The version number of the FDC3 specification that the implementation provides.
|
6770
|
-
* The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
|
6771
|
-
*/
|
6772
|
-
readonly fdc3Version: string;
|
6773
|
-
/** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
|
6774
|
-
readonly provider: string;
|
6775
|
-
/** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
|
6776
|
-
readonly providerVersion?: string;
|
6777
|
-
/** Metadata indicating whether the Desktop Agent implements optional features of
|
6778
|
-
* the Desktop Agent API.
|
6779
|
-
*/
|
6780
|
-
readonly optionalFeatures: {
|
6781
|
-
/** Used to indicate whether the exposure of 'originating app metadata' for
|
6782
|
-
* context and intent messages is supported by the Desktop Agent. */
|
6783
|
-
readonly OriginatingAppMetadata: boolean;
|
6784
|
-
/** Used to indicate whether the optional `fdc3.joinUserChannel`,
|
6785
|
-
* `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
|
6786
|
-
* the Desktop Agent. */
|
6787
|
-
readonly UserChannelMembershipAPIs: boolean;
|
6788
|
-
};
|
6789
|
-
/** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
|
6790
|
-
readonly appMetadata: AppMetadata_2;
|
6791
|
-
}
|
6792
|
-
|
6793
6583
|
/**
|
6794
6584
|
* @interface
|
6795
6585
|
*/
|
6796
|
-
declare type InfoForIntentOptions<MetadataType =
|
6586
|
+
declare type InfoForIntentOptions<MetadataType = IntentMetadata> = {
|
6797
6587
|
/**
|
6798
6588
|
* Name of the intent to get info for.
|
6799
6589
|
*/
|
6800
6590
|
name: string;
|
6801
|
-
context?:
|
6591
|
+
context?: Context;
|
6802
6592
|
metadata?: MetadataType;
|
6803
6593
|
};
|
6804
6594
|
|
@@ -6906,16 +6696,10 @@ declare type InstalledApps_2 = {
|
|
6906
6696
|
[key: string]: InstallationInfo;
|
6907
6697
|
};
|
6908
6698
|
|
6909
|
-
declare interface Intent {
|
6910
|
-
name: string;
|
6911
|
-
context: Context_2;
|
6912
|
-
metadata: IntentMetadata_2;
|
6913
|
-
}
|
6914
|
-
|
6915
6699
|
/**
|
6916
6700
|
* Combination of an action and a context that is passed to an application for resolution.
|
6917
6701
|
*/
|
6918
|
-
declare type
|
6702
|
+
declare type Intent<MetadataType = IntentMetadata> = {
|
6919
6703
|
/**
|
6920
6704
|
* Name of the intent.
|
6921
6705
|
*/
|
@@ -6923,54 +6707,25 @@ declare type Intent_2<MetadataType = IntentMetadata_3> = {
|
|
6923
6707
|
/**
|
6924
6708
|
* Data associated with the intent.
|
6925
6709
|
*/
|
6926
|
-
context:
|
6710
|
+
context: Context;
|
6927
6711
|
metadata?: MetadataType;
|
6928
6712
|
};
|
6929
6713
|
|
6930
|
-
declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
|
6931
|
-
|
6932
6714
|
/**
|
6933
6715
|
* Subscription function for registerIntentHandler.
|
6934
6716
|
*/
|
6935
|
-
declare type
|
6717
|
+
declare type IntentHandler = (intent: Intent) => void;
|
6936
6718
|
|
6937
6719
|
/**
|
6938
|
-
*
|
6720
|
+
* The type used to describe an intent within the platform.
|
6721
|
+
* @interface
|
6939
6722
|
*/
|
6940
|
-
declare
|
6941
|
-
/** The unique name of the intent that can be invoked by the raiseIntent call */
|
6942
|
-
readonly name: string;
|
6943
|
-
/** A friendly display name for the intent that should be used to render UI elements */
|
6944
|
-
readonly displayName: string;
|
6945
|
-
}
|
6946
|
-
|
6947
|
-
declare type IntentMetadata_2<TargetType = any> = {
|
6723
|
+
declare type IntentMetadata<TargetType = any> = {
|
6948
6724
|
target?: TargetType;
|
6949
6725
|
resultType?: string;
|
6950
6726
|
intentResolutionResultId?: string;
|
6951
6727
|
};
|
6952
6728
|
|
6953
|
-
/**
|
6954
|
-
* The type used to describe an intent within the platform.
|
6955
|
-
* @interface
|
6956
|
-
*/
|
6957
|
-
declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
|
6958
|
-
|
6959
|
-
declare interface IntentResolution {
|
6960
|
-
source: TargetApp;
|
6961
|
-
data?: object;
|
6962
|
-
version: string;
|
6963
|
-
}
|
6964
|
-
|
6965
|
-
declare interface IntentResolution_2 {
|
6966
|
-
source: AppIdentifier;
|
6967
|
-
intent: string;
|
6968
|
-
version?: string;
|
6969
|
-
getResult(): Promise<IntentResult>;
|
6970
|
-
}
|
6971
|
-
|
6972
|
-
declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
|
6973
|
-
|
6974
6729
|
/**
|
6975
6730
|
* A messaging bus that allows for pub/sub messaging between different applications.
|
6976
6731
|
*
|
@@ -7228,7 +6983,6 @@ declare type InteropActionLoggingOption = {
|
|
7228
6983
|
*/
|
7229
6984
|
declare class InteropBroker extends Base {
|
7230
6985
|
#private;
|
7231
|
-
private getProvider;
|
7232
6986
|
private interopClients;
|
7233
6987
|
private contextGroupsById;
|
7234
6988
|
private intentClientMap;
|
@@ -7239,7 +6993,8 @@ declare class InteropBroker extends Base {
|
|
7239
6993
|
/**
|
7240
6994
|
* @internal
|
7241
6995
|
*/
|
7242
|
-
constructor(wire: Transport,
|
6996
|
+
constructor(wire: Transport, createProvider: () => Promise<OpenFin_2.ChannelProvider>, options: InternalInteropBrokerOptions);
|
6997
|
+
private getProvider;
|
7243
6998
|
static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
|
7244
6999
|
new (): InteropBroker;
|
7245
7000
|
};
|
@@ -7544,23 +7299,23 @@ declare class InteropBroker extends Base {
|
|
7544
7299
|
* @param clientIdentity Identity of the Client making the request.
|
7545
7300
|
*/
|
7546
7301
|
fdc3HandleOpen({ app, context }: {
|
7547
|
-
app: FDC3.
|
7302
|
+
app: FDC3.v1_2.TargetApp | FDC3.v2_0.AppIdentifier;
|
7548
7303
|
context: OpenFin_2.Context;
|
7549
|
-
}, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | FDC3.
|
7304
|
+
}, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | FDC3.v2_0.AppIdentifier>;
|
7550
7305
|
/**
|
7551
7306
|
* Responsible for resolving the fdc3.findInstances call.
|
7552
7307
|
* Must be overridden
|
7553
7308
|
* @param app AppIdentifier that was passed to fdc3.findInstances
|
7554
7309
|
* @param clientIdentity Identity of the Client making the request.
|
7555
7310
|
*/
|
7556
|
-
fdc3HandleFindInstances(app: FDC3.
|
7311
|
+
fdc3HandleFindInstances(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
7557
7312
|
/**
|
7558
7313
|
* Responsible for resolving the fdc3.getAppMetadata call.
|
7559
7314
|
* Must be overridden
|
7560
7315
|
* @param app AppIdentifier that was passed to fdc3.getAppMetadata
|
7561
7316
|
* @param clientIdentity Identity of the Client making the request.
|
7562
7317
|
*/
|
7563
|
-
fdc3HandleGetAppMetadata(app: FDC3.
|
7318
|
+
fdc3HandleGetAppMetadata(app: FDC3.v2_0.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
7564
7319
|
/**
|
7565
7320
|
* This function is called by the Interop Broker whenever a Context handler would fire.
|
7566
7321
|
* For FDC3 2.0 you would need to override this function and add the contextMetadata as
|
@@ -7805,7 +7560,7 @@ declare class InteropClient extends Base {
|
|
7805
7560
|
/**
|
7806
7561
|
* @internal
|
7807
7562
|
*/
|
7808
|
-
constructor(wire: Transport,
|
7563
|
+
constructor(wire: Transport, clientPromise: Promise<OpenFin_2.ChannelClient>);
|
7809
7564
|
/**
|
7810
7565
|
* Sets a context for the context group of the current entity.
|
7811
7566
|
*
|
@@ -8157,6 +7912,23 @@ declare class InteropClient extends Base {
|
|
8157
7912
|
* ```
|
8158
7913
|
*/
|
8159
7914
|
onDisconnection(listener: OpenFin_2.InteropClientOnDisconnectionListener): Promise<void>;
|
7915
|
+
/**
|
7916
|
+
* Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
|
7917
|
+
* Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
|
7918
|
+
* This also does not raise the FDC3Ready event.
|
7919
|
+
*/
|
7920
|
+
getFDC3Sync(version: '2.0'): OpenFin_2.FDC3.v2_0.DesktopAgent;
|
7921
|
+
getFDC3Sync(version: '1.2'): OpenFin_2.FDC3.v1_2.DesktopAgent;
|
7922
|
+
getFDC3Sync(version: OpenFin_2.FDC3.Version): OpenFin_2.FDC3.v1_2.DesktopAgent | OpenFin_2.FDC3.v2_0.DesktopAgent;
|
7923
|
+
/**
|
7924
|
+
*
|
7925
|
+
* Returns a representation of this Interop Client as an FDC3 DesktopAgent matching the given version.
|
7926
|
+
* Note that this does not set a global FDC3 object, it only returns an instance of the FDC3 DesktopAgent.
|
7927
|
+
* This also does not raise the FDC3Ready event.
|
7928
|
+
*/
|
7929
|
+
getFDC3(version: '2.0'): Promise<OpenFin_2.FDC3.v2_0.DesktopAgent>;
|
7930
|
+
getFDC3(version: '1.2'): Promise<OpenFin_2.FDC3.v1_2.DesktopAgent>;
|
7931
|
+
getFDC3(version: OpenFin_2.FDC3.Version): Promise<OpenFin_2.FDC3.v1_2.DesktopAgent | OpenFin_2.FDC3.v2_0.DesktopAgent>;
|
8160
7932
|
/**
|
8161
7933
|
* @internal
|
8162
7934
|
*
|
@@ -9382,21 +9154,7 @@ declare type LayoutSnapshot = {
|
|
9382
9154
|
*/
|
9383
9155
|
declare type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
9384
9156
|
|
9385
|
-
declare
|
9386
|
-
/**
|
9387
|
-
* Unsubscribe the listener object.
|
9388
|
-
*/
|
9389
|
-
unsubscribe(): void;
|
9390
|
-
}
|
9391
|
-
|
9392
|
-
declare interface Listener_2 {
|
9393
|
-
/**
|
9394
|
-
* Unsubscribe the listener object.
|
9395
|
-
*/
|
9396
|
-
unsubscribe(): void;
|
9397
|
-
}
|
9398
|
-
|
9399
|
-
declare type Listener_3<T extends {
|
9157
|
+
declare type Listener<T extends {
|
9400
9158
|
type: string;
|
9401
9159
|
}> = (payload: T) => void;
|
9402
9160
|
|
@@ -9785,7 +9543,7 @@ declare type MutableViewOptions = {
|
|
9785
9543
|
/**
|
9786
9544
|
* Configurations for API injection.
|
9787
9545
|
*/
|
9788
|
-
api:
|
9546
|
+
api: ApiSettings;
|
9789
9547
|
/**
|
9790
9548
|
* Restrict navigation to URLs that match an allowed pattern.
|
9791
9549
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
@@ -10185,6 +9943,7 @@ declare namespace OpenFin_2 {
|
|
10185
9943
|
export {
|
10186
9944
|
FinApi,
|
10187
9945
|
Fin,
|
9946
|
+
FDC3,
|
10188
9947
|
Application,
|
10189
9948
|
ApplicationModule,
|
10190
9949
|
ExternalApplication,
|
@@ -10236,11 +9995,11 @@ declare namespace OpenFin_2 {
|
|
10236
9995
|
CustomProtocolOptions,
|
10237
9996
|
InteropBrokerOptions,
|
10238
9997
|
ContextGroupInfo,
|
10239
|
-
|
9998
|
+
DisplayMetadata,
|
10240
9999
|
LegacyWinOptionsInAppOptions,
|
10241
10000
|
Snapshot,
|
10242
10001
|
ContextGroupStates,
|
10243
|
-
|
10002
|
+
Context,
|
10244
10003
|
MonitorInfo,
|
10245
10004
|
Point,
|
10246
10005
|
PointTopLeft,
|
@@ -10267,6 +10026,7 @@ declare namespace OpenFin_2 {
|
|
10267
10026
|
ResizeRegion,
|
10268
10027
|
Accelerator,
|
10269
10028
|
Api,
|
10029
|
+
ApiSettings,
|
10270
10030
|
InjectionType,
|
10271
10031
|
NavigationRules,
|
10272
10032
|
ContentNavigation,
|
@@ -10418,14 +10178,19 @@ declare namespace OpenFin_2 {
|
|
10418
10178
|
DefaultDomainSettingsRule,
|
10419
10179
|
DomainSettings,
|
10420
10180
|
ApiInjection,
|
10181
|
+
DomainApiSettings,
|
10182
|
+
ContentPermission,
|
10183
|
+
PerDomainSettings,
|
10421
10184
|
DomainSettingsRule,
|
10185
|
+
FileDownloadBehavior,
|
10422
10186
|
FileDownloadBehaviorNames,
|
10423
10187
|
FileDownloadSettings,
|
10424
10188
|
DownloadRule,
|
10425
|
-
|
10426
|
-
|
10427
|
-
|
10428
|
-
|
10189
|
+
ContextHandler,
|
10190
|
+
Intent,
|
10191
|
+
IntentMetadata,
|
10192
|
+
IntentHandler,
|
10193
|
+
ContentCreationBehavior,
|
10429
10194
|
ContentCreationBehaviorNames,
|
10430
10195
|
MatchPattern,
|
10431
10196
|
BaseContentCreationRule,
|
@@ -10646,6 +10411,31 @@ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
10646
10411
|
type: Type;
|
10647
10412
|
}>;
|
10648
10413
|
|
10414
|
+
/**
|
10415
|
+
* @interface
|
10416
|
+
*
|
10417
|
+
* Conditional settings for a domain or set of domains.
|
10418
|
+
*/
|
10419
|
+
declare type PerDomainSettings = {
|
10420
|
+
/**
|
10421
|
+
* {@inheritDoc FileDownloadSettings}
|
10422
|
+
*
|
10423
|
+
* @remarks See: https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads
|
10424
|
+
*/
|
10425
|
+
downloadSettings?: FileDownloadSettings;
|
10426
|
+
/**
|
10427
|
+
* {@inheritDoc ApiInjection}
|
10428
|
+
*/
|
10429
|
+
api?: DomainApiSettings;
|
10430
|
+
/**
|
10431
|
+
* Whether DOM content can be loaded (by navigation or redirect).
|
10432
|
+
*
|
10433
|
+
* @remarks If this is included in {@link DomainSettings.default}, then {@link ContentNavigation} and
|
10434
|
+
* {@link ContentRedirect} will be **ignored**.
|
10435
|
+
*/
|
10436
|
+
content?: ContentPermission;
|
10437
|
+
};
|
10438
|
+
|
10649
10439
|
/**
|
10650
10440
|
* Generated when window finishes loading. Provides performance and navigation data.
|
10651
10441
|
* @interface
|
@@ -10684,7 +10474,7 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
|
|
10684
10474
|
/**
|
10685
10475
|
* @internal
|
10686
10476
|
*/
|
10687
|
-
constructor(identity: OpenFin_2.ApplicationIdentity, channel:
|
10477
|
+
constructor(identity: OpenFin_2.ApplicationIdentity, channel: Channel_3);
|
10688
10478
|
getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
|
10689
10479
|
/**
|
10690
10480
|
* Creates a new view and attaches it to a specified target window.
|
@@ -12460,14 +12250,6 @@ declare type PrintOptions = {
|
|
12460
12250
|
dpi?: Dpi;
|
12461
12251
|
};
|
12462
12252
|
|
12463
|
-
declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
|
12464
|
-
addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
|
12465
|
-
onAddContextListener(handler: (contextType?: string) => void): Listener_2;
|
12466
|
-
onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
|
12467
|
-
onDisconnect(handler: () => void): Listener_2;
|
12468
|
-
disconnect(): void;
|
12469
|
-
};
|
12470
|
-
|
12471
12253
|
/**
|
12472
12254
|
* Strategy to assign views to process affinity by domain.
|
12473
12255
|
*
|
@@ -13433,19 +13215,19 @@ declare type SessionContextGroup = {
|
|
13433
13215
|
* A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
13434
13216
|
* @param context The Context to be set.
|
13435
13217
|
*/
|
13436
|
-
setContext: (context:
|
13218
|
+
setContext: (context: Context) => Promise<void>;
|
13437
13219
|
/**
|
13438
13220
|
* A SessionContextGroup instance method for getting the current context of a certain type.
|
13439
13221
|
* @param type The Context Type to get. If not specified the last contextType set would get used.
|
13440
13222
|
*/
|
13441
|
-
getCurrentContext: (type?: string) => Promise<
|
13223
|
+
getCurrentContext: (type?: string) => Promise<Context>;
|
13442
13224
|
/**
|
13443
13225
|
* A SessionContextGroup instance method for adding a handler for context change.
|
13444
13226
|
* @param handler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
|
13445
13227
|
* @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
|
13446
13228
|
*
|
13447
13229
|
*/
|
13448
|
-
addContextHandler: (handler:
|
13230
|
+
addContextHandler: (handler: ContextHandler, contextType?: string) => Promise<{
|
13449
13231
|
unsubscribe: () => void;
|
13450
13232
|
}>;
|
13451
13233
|
};
|
@@ -15338,12 +15120,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
15338
15120
|
setDomainSettings(domainSettings: OpenFin_2.DefaultDomainSettings): Promise<void>;
|
15339
15121
|
}
|
15340
15122
|
|
15341
|
-
declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
|
15342
|
-
addContextListener(): Error;
|
15343
|
-
broadcast(): Error;
|
15344
|
-
getCurrentContext(): Error;
|
15345
|
-
};
|
15346
|
-
|
15347
15123
|
/**
|
15348
15124
|
* @deprecated Renamed to {@link Event}.
|
15349
15125
|
*/
|
@@ -15622,8 +15398,6 @@ declare class TabStack extends LayoutNode {
|
|
15622
15398
|
setActiveView: (view: OpenFin_2.Identity) => Promise<void>;
|
15623
15399
|
}
|
15624
15400
|
|
15625
|
-
declare type TargetApp = string | AppMetadata;
|
15626
|
-
|
15627
15401
|
/**
|
15628
15402
|
* Generated when a View changes its window target.
|
15629
15403
|
* @remarks This event will fire during creation of a View.
|
@@ -15821,13 +15595,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
|
|
15821
15595
|
declare interface TypedEventEmitter<Event extends {
|
15822
15596
|
type: string;
|
15823
15597
|
}, EmitterEventType = Event['type']> {
|
15824
|
-
on<EventType extends EmitterEventType>(event: EventType, listener:
|
15598
|
+
on<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
|
15825
15599
|
type: EventType;
|
15826
15600
|
}>>): this;
|
15827
|
-
addListener<EventType extends EmitterEventType>(event: EventType, listener:
|
15601
|
+
addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
|
15828
15602
|
type: EventType;
|
15829
15603
|
}>>): this;
|
15830
|
-
removeListener<EventType extends EmitterEventType>(event: EventType, listener:
|
15604
|
+
removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener<Extract<Event, {
|
15831
15605
|
type: EventType;
|
15832
15606
|
}>>): this;
|
15833
15607
|
removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
|
@@ -15898,45 +15672,102 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
|
|
15898
15672
|
type: 'user-movement-enabled';
|
15899
15673
|
};
|
15900
15674
|
|
15901
|
-
declare namespace
|
15902
|
-
|
15903
|
-
Listener,
|
15904
|
-
AppMetadata,
|
15905
|
-
IntentMetadata,
|
15675
|
+
declare namespace v1_2 {
|
15676
|
+
{
|
15906
15677
|
AppIntent,
|
15678
|
+
AppMetadata,
|
15907
15679
|
DisplayMetadata,
|
15680
|
+
OpenError,
|
15681
|
+
ResolveError,
|
15682
|
+
ChannelError,
|
15908
15683
|
ImplementationMetadata,
|
15909
|
-
|
15910
|
-
|
15684
|
+
IntentMetadata,
|
15685
|
+
Listener,
|
15686
|
+
ContextTypes,
|
15687
|
+
ContextType,
|
15911
15688
|
Context,
|
15689
|
+
ContactList,
|
15690
|
+
Contact,
|
15691
|
+
ContactID,
|
15692
|
+
InstrumentList,
|
15693
|
+
Instrument,
|
15694
|
+
InstrumentID,
|
15695
|
+
Country,
|
15696
|
+
CountryID,
|
15697
|
+
Organization,
|
15698
|
+
OrganizationID,
|
15699
|
+
Portfolio,
|
15700
|
+
Position,
|
15701
|
+
Convert,
|
15702
|
+
Intents,
|
15703
|
+
Channel,
|
15704
|
+
DesktopAgent,
|
15912
15705
|
IntentResolution,
|
15913
|
-
|
15914
|
-
|
15915
|
-
DesktopAgent
|
15706
|
+
TargetApp,
|
15707
|
+
ContextHandler
|
15916
15708
|
}
|
15917
15709
|
}
|
15918
15710
|
|
15919
|
-
declare namespace
|
15920
|
-
|
15921
|
-
IntentMetadata_2 as IntentMetadata,
|
15711
|
+
declare namespace v2_0 {
|
15712
|
+
{
|
15922
15713
|
AppIdentifier,
|
15923
|
-
Listener_2 as Listener,
|
15924
15714
|
AppIntent_2 as AppIntent,
|
15925
|
-
|
15715
|
+
AppMetadata_2 as AppMetadata,
|
15926
15716
|
ContextMetadata,
|
15717
|
+
DisplayMetadata_2 as DisplayMetadata,
|
15718
|
+
OpenError_2 as OpenError,
|
15719
|
+
ResolveError_2 as ResolveError,
|
15720
|
+
ResultError,
|
15721
|
+
ChannelError_2 as ChannelError,
|
15927
15722
|
Icon,
|
15928
15723
|
Image_2 as Image,
|
15929
|
-
|
15930
|
-
|
15931
|
-
|
15932
|
-
|
15933
|
-
|
15724
|
+
ImplementationMetadata_2 as ImplementationMetadata,
|
15725
|
+
IntentMetadata_2 as IntentMetadata,
|
15726
|
+
Listener_2 as Listener,
|
15727
|
+
ContextTypes_2 as ContextTypes,
|
15728
|
+
ContextType_2 as ContextType,
|
15729
|
+
Chart,
|
15730
|
+
InstrumentElement,
|
15731
|
+
PurpleID,
|
15732
|
+
PurpleMarket,
|
15733
|
+
TimeRangeObject,
|
15734
|
+
Style,
|
15735
|
+
ChatInitSettings,
|
15736
|
+
ContactListObject,
|
15737
|
+
ContactElement,
|
15738
|
+
FluffyID,
|
15739
|
+
Contact_2 as Contact,
|
15740
|
+
TentacledID,
|
15741
|
+
ContactList_2 as ContactList,
|
15934
15742
|
Context_2 as Context,
|
15935
|
-
|
15743
|
+
Country_2 as Country,
|
15744
|
+
CountryID_2 as CountryID,
|
15745
|
+
Currency,
|
15746
|
+
CurrencyID,
|
15747
|
+
Email,
|
15748
|
+
RecipientsObject,
|
15749
|
+
RecipientsID,
|
15750
|
+
Instrument_2 as Instrument,
|
15751
|
+
StickyID,
|
15752
|
+
FluffyMarket,
|
15753
|
+
InstrumentList_2 as InstrumentList,
|
15754
|
+
Nothing,
|
15755
|
+
Organization_2 as Organization,
|
15756
|
+
OrganizationID_2 as OrganizationID,
|
15757
|
+
Portfolio_2 as Portfolio,
|
15758
|
+
PositionElement,
|
15759
|
+
Position_2 as Position,
|
15760
|
+
TimeRange,
|
15761
|
+
Valuation,
|
15762
|
+
Convert_2 as Convert,
|
15763
|
+
Intents_2 as Intents,
|
15764
|
+
Channel_2 as Channel,
|
15765
|
+
DesktopAgent_2 as DesktopAgent,
|
15936
15766
|
IntentResolution_2 as IntentResolution,
|
15937
|
-
Channel_4 as Channel,
|
15938
15767
|
PrivateChannel,
|
15939
|
-
|
15768
|
+
ContextHandler_2 as ContextHandler,
|
15769
|
+
IntentResult,
|
15770
|
+
IntentHandler
|
15940
15771
|
}
|
15941
15772
|
}
|
15942
15773
|
|
@@ -15945,6 +15776,13 @@ declare type VerboseWebPermission = {
|
|
15945
15776
|
enabled: boolean;
|
15946
15777
|
};
|
15947
15778
|
|
15779
|
+
declare type Version = (typeof versions)[keyof typeof versions];
|
15780
|
+
|
15781
|
+
declare const versions: {
|
15782
|
+
readonly v1_2: "1.2";
|
15783
|
+
readonly v2_0: "2.0";
|
15784
|
+
};
|
15785
|
+
|
15948
15786
|
declare type View = OpenFin_2.View;
|
15949
15787
|
|
15950
15788
|
/**
|
@@ -17683,6 +17521,7 @@ declare namespace WebContentsEvents {
|
|
17683
17521
|
FileDownloadStartedEvent,
|
17684
17522
|
FileDownloadProgressEvent,
|
17685
17523
|
FileDownloadCompletedEvent,
|
17524
|
+
ContentBlockedEvent,
|
17686
17525
|
Event_5 as Event,
|
17687
17526
|
WebContentsEvent,
|
17688
17527
|
WillPropagateWebContentsEvent,
|
@@ -17796,10 +17635,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
|
|
17796
17635
|
* @internal
|
17797
17636
|
*/
|
17798
17637
|
constructor(wire: Transport, identity: OpenFin_2.Identity);
|
17799
|
-
/**
|
17800
|
-
* create a new window
|
17801
|
-
* @internal
|
17802
|
-
*/
|
17803
17638
|
createWindow(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
|
17804
17639
|
/**
|
17805
17640
|
* Retrieves an array of frame info objects representing the main frame and any
|