@openfin/core 34.78.19 → 34.78.20
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 +417 -36
- package/out/mock-beta.d.ts +417 -36
- package/out/mock-public.d.ts +417 -36
- package/out/mock.d.ts +418 -37
- package/out/mock.js +50 -70
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
/// <reference types="jquery" />
|
|
2
2
|
/// <reference types="node" />
|
|
3
3
|
|
|
4
|
-
import { AppIdentifier } from 'fdc3v2/dist/api/AppIdentifier';
|
|
5
|
-
import type { AppMetadata } from 'fdc3v1/dist/api/AppMetadata';
|
|
6
4
|
import { EventEmitter } from 'events';
|
|
5
|
+
import type * as GoldenLayout from '@openfin/golden-layout';
|
|
7
6
|
|
|
8
7
|
/**
|
|
9
8
|
* Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
|
|
@@ -138,6 +137,31 @@ declare type AppAssetRequest = {
|
|
|
138
137
|
alias: string;
|
|
139
138
|
};
|
|
140
139
|
|
|
140
|
+
declare interface AppIdentifier {
|
|
141
|
+
/** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
|
|
142
|
+
readonly appId: string;
|
|
143
|
+
/** An optional instance identifier, indicating that this object represents a specific instance of the application described. */
|
|
144
|
+
readonly instanceId?: string;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* An interface that relates an intent to apps
|
|
149
|
+
*/
|
|
150
|
+
declare interface AppIntent {
|
|
151
|
+
readonly intent: IntentMetadata;
|
|
152
|
+
readonly apps: Array<AppMetadata>;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* An interface that relates an intent to apps
|
|
157
|
+
*/
|
|
158
|
+
declare interface AppIntent_2 {
|
|
159
|
+
/** Details of the intent whose relationship to resolving applications is being described. */
|
|
160
|
+
readonly intent: IntentMetadata_2;
|
|
161
|
+
/** Details of applications that can resolve the intent. */
|
|
162
|
+
readonly apps: Array<AppMetadata_2>;
|
|
163
|
+
}
|
|
164
|
+
|
|
141
165
|
/**
|
|
142
166
|
* An object representing an application. Allows the developer to create,
|
|
143
167
|
* execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
|
|
@@ -1347,6 +1371,60 @@ declare type ApplySnapshotPayload = {
|
|
|
1347
1371
|
options?: ApplySnapshotOptions;
|
|
1348
1372
|
};
|
|
1349
1373
|
|
|
1374
|
+
/**
|
|
1375
|
+
* App definition as provided by the application directory
|
|
1376
|
+
*/
|
|
1377
|
+
declare interface AppMetadata {
|
|
1378
|
+
/** The unique app name that can be used with the open and raiseIntent calls. */
|
|
1379
|
+
readonly name: string;
|
|
1380
|
+
/** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
|
|
1381
|
+
readonly appId?: string;
|
|
1382
|
+
/** The Version of the application. */
|
|
1383
|
+
readonly version?: string;
|
|
1384
|
+
/** A more user-friendly application title that can be used to render UI elements */
|
|
1385
|
+
readonly title?: string;
|
|
1386
|
+
/** A tooltip for the application that can be used to render UI elements */
|
|
1387
|
+
readonly tooltip?: string;
|
|
1388
|
+
/** A longer, multi-paragraph description for the application that could include markup */
|
|
1389
|
+
readonly description?: string;
|
|
1390
|
+
/** A list of icon URLs for the application that can be used to render UI elements */
|
|
1391
|
+
readonly icons?: Array<string>;
|
|
1392
|
+
/** A list of image URLs for the application that can be used to render UI elements */
|
|
1393
|
+
readonly images?: Array<string>;
|
|
1394
|
+
}
|
|
1395
|
+
|
|
1396
|
+
/**
|
|
1397
|
+
* 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.
|
|
1398
|
+
*
|
|
1399
|
+
* 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.
|
|
1400
|
+
*
|
|
1401
|
+
* Note that as `AppMetadata` instances are also `AppIdentifiers` they may be passed to the `app` argument of `fdc3.open`, `fdc3.raiseIntent` etc.
|
|
1402
|
+
*/
|
|
1403
|
+
declare interface AppMetadata_2 extends AppIdentifier {
|
|
1404
|
+
/**
|
|
1405
|
+
The 'friendly' app name.
|
|
1406
|
+
This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` wth `appId` set.
|
|
1407
|
+
Note that for display purposes the `title` field should be used, if set, in preference to this field.
|
|
1408
|
+
*/
|
|
1409
|
+
readonly name?: string;
|
|
1410
|
+
/** The Version of the application. */
|
|
1411
|
+
readonly version?: string;
|
|
1412
|
+
/** 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. */
|
|
1413
|
+
readonly instanceMetadata?: Record<string, any>;
|
|
1414
|
+
/** A more user-friendly application title that can be used to render UI elements */
|
|
1415
|
+
readonly title?: string;
|
|
1416
|
+
/** A tooltip for the application that can be used to render UI elements */
|
|
1417
|
+
readonly tooltip?: string;
|
|
1418
|
+
/** A longer, multi-paragraph description for the application that could include markup */
|
|
1419
|
+
readonly description?: string;
|
|
1420
|
+
/** A list of icon URLs for the application that can be used to render UI elements */
|
|
1421
|
+
readonly icons?: Array<Icon>;
|
|
1422
|
+
/** Images representing the app in common usage scenarios that can be used to render UI elements */
|
|
1423
|
+
readonly screenshots?: Array<Image_2>;
|
|
1424
|
+
/** 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>"). */
|
|
1425
|
+
readonly resultType?: string | null;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1350
1428
|
/**
|
|
1351
1429
|
* @interface
|
|
1352
1430
|
*/
|
|
@@ -2008,7 +2086,25 @@ declare class Channel extends EmitterBase<ChannelEvent> {
|
|
|
2008
2086
|
|
|
2009
2087
|
declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
|
2010
2088
|
|
|
2011
|
-
declare
|
|
2089
|
+
declare interface Channel_3 {
|
|
2090
|
+
id: string;
|
|
2091
|
+
type: string;
|
|
2092
|
+
displayMetadata?: DisplayMetadata;
|
|
2093
|
+
broadcast(context: Context): void;
|
|
2094
|
+
getCurrentContext(contextType?: string): Promise<Context | null>;
|
|
2095
|
+
addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
|
|
2096
|
+
}
|
|
2097
|
+
|
|
2098
|
+
declare interface Channel_4 {
|
|
2099
|
+
readonly id: string;
|
|
2100
|
+
readonly type: 'user' | 'app' | 'private';
|
|
2101
|
+
readonly displayMetadata?: DisplayMetadata_2;
|
|
2102
|
+
broadcast(context: Context_2): Promise<void>;
|
|
2103
|
+
getCurrentContext(contextType?: string): Promise<Context_2 | null>;
|
|
2104
|
+
addContextListener(contextType: string | null, handler: ContextHandler_2): Listener_2 & Promise<Listener_2>;
|
|
2105
|
+
}
|
|
2106
|
+
|
|
2107
|
+
declare type Channel_5 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
|
2012
2108
|
|
|
2013
2109
|
declare type ChannelAction = OpenFin_2.ChannelAction;
|
|
2014
2110
|
|
|
@@ -3441,12 +3537,26 @@ declare type ContentNavigation = NavigationRules;
|
|
|
3441
3537
|
*/
|
|
3442
3538
|
declare type ContentRedirect = NavigationRules;
|
|
3443
3539
|
|
|
3540
|
+
declare interface Context {
|
|
3541
|
+
id?: { [key: string]: string };
|
|
3542
|
+
name?: string;
|
|
3543
|
+
type: string;
|
|
3544
|
+
}
|
|
3545
|
+
|
|
3546
|
+
declare interface Context_2 {
|
|
3547
|
+
id?: { [key: string]: string };
|
|
3548
|
+
name?: string;
|
|
3549
|
+
type: string;
|
|
3550
|
+
contextMetadata?: ContextMetadata;
|
|
3551
|
+
metadata?: any;
|
|
3552
|
+
}
|
|
3553
|
+
|
|
3444
3554
|
/**
|
|
3445
3555
|
* Data passed between entities and applications.
|
|
3446
3556
|
*
|
|
3447
3557
|
* @interface
|
|
3448
3558
|
*/
|
|
3449
|
-
declare type
|
|
3559
|
+
declare type Context_3 = {
|
|
3450
3560
|
/**
|
|
3451
3561
|
* An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
3452
3562
|
*/
|
|
@@ -3466,7 +3576,7 @@ declare type Context = {
|
|
|
3466
3576
|
/**
|
|
3467
3577
|
* @interface
|
|
3468
3578
|
*/
|
|
3469
|
-
declare type ContextForIntent<MetadataType = any> =
|
|
3579
|
+
declare type ContextForIntent<MetadataType = any> = Context_3 & {
|
|
3470
3580
|
metadata?: MetadataType;
|
|
3471
3581
|
};
|
|
3472
3582
|
|
|
@@ -3482,19 +3592,23 @@ declare type ContextGroupInfo = {
|
|
|
3482
3592
|
/**
|
|
3483
3593
|
* Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
|
|
3484
3594
|
*/
|
|
3485
|
-
displayMetadata?:
|
|
3595
|
+
displayMetadata?: DisplayMetadata_3;
|
|
3486
3596
|
};
|
|
3487
3597
|
|
|
3488
3598
|
declare type ContextGroupStates = {
|
|
3489
3599
|
[key: string]: {
|
|
3490
|
-
[key: string]:
|
|
3600
|
+
[key: string]: Context_3;
|
|
3491
3601
|
};
|
|
3492
3602
|
};
|
|
3493
3603
|
|
|
3604
|
+
declare type ContextHandler = (context: Context) => void;
|
|
3605
|
+
|
|
3606
|
+
declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
|
|
3607
|
+
|
|
3494
3608
|
/**
|
|
3495
3609
|
* Subscription function for addContextHandler.
|
|
3496
3610
|
*/
|
|
3497
|
-
declare type
|
|
3611
|
+
declare type ContextHandler_3 = (context: Context_3) => void;
|
|
3498
3612
|
|
|
3499
3613
|
/**
|
|
3500
3614
|
* Configure the context menu when right-clicking on a window.
|
|
@@ -3533,6 +3647,20 @@ declare type ContextMenuSettings = {
|
|
|
3533
3647
|
reload?: boolean;
|
|
3534
3648
|
};
|
|
3535
3649
|
|
|
3650
|
+
/**
|
|
3651
|
+
* Metadata relating to a context or intent and context received through the
|
|
3652
|
+
* `addContextListener` and `addIntentListener` functions.
|
|
3653
|
+
*
|
|
3654
|
+
* @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
|
|
3655
|
+
*/
|
|
3656
|
+
declare interface ContextMetadata {
|
|
3657
|
+
/** Identifier for the app instance that sent the context and/or intent.
|
|
3658
|
+
*
|
|
3659
|
+
* @experimental
|
|
3660
|
+
*/
|
|
3661
|
+
readonly source: AppIdentifier;
|
|
3662
|
+
}
|
|
3663
|
+
|
|
3536
3664
|
/**
|
|
3537
3665
|
* @interface
|
|
3538
3666
|
*/
|
|
@@ -3695,6 +3823,45 @@ declare type DefaultDomainSettingsRule = {
|
|
|
3695
3823
|
};
|
|
3696
3824
|
};
|
|
3697
3825
|
|
|
3826
|
+
declare interface DesktopAgent {
|
|
3827
|
+
open(app: TargetApp, context?: Context): Promise<void>;
|
|
3828
|
+
findIntent(intent: string, context?: Context): Promise<AppIntent>;
|
|
3829
|
+
findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
|
|
3830
|
+
broadcast(context: Context): void;
|
|
3831
|
+
raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
|
|
3832
|
+
raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
|
|
3833
|
+
addIntentListener(intent: string, handler: ContextHandler): Listener;
|
|
3834
|
+
joinChannel(channelId: string): Promise<void>;
|
|
3835
|
+
leaveCurrentChannel(): Promise<void>;
|
|
3836
|
+
getInfo(): ImplementationMetadata;
|
|
3837
|
+
addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
|
|
3838
|
+
getOrCreateChannel(channelId: string): Promise<Channel_3>;
|
|
3839
|
+
getSystemChannels(): Promise<SystemChannel[]>;
|
|
3840
|
+
getCurrentChannel(): Promise<Channel_3 | null>;
|
|
3841
|
+
}
|
|
3842
|
+
|
|
3843
|
+
declare interface DesktopAgent_2 {
|
|
3844
|
+
open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
|
|
3845
|
+
findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
|
|
3846
|
+
findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
|
|
3847
|
+
findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
|
|
3848
|
+
broadcast(context: Context_2): Promise<void>;
|
|
3849
|
+
raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
|
|
3850
|
+
raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
|
|
3851
|
+
addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
|
|
3852
|
+
addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
|
|
3853
|
+
getUserChannels(): Promise<Array<SystemChannel>>;
|
|
3854
|
+
joinUserChannel(channelId: string): Promise<void>;
|
|
3855
|
+
getOrCreateChannel(channelId: string): Promise<Channel_4>;
|
|
3856
|
+
createPrivateChannel(): Promise<PrivateChannel>;
|
|
3857
|
+
getCurrentChannel(): Promise<Channel_3 | null>;
|
|
3858
|
+
leaveCurrentChannel(): Promise<void>;
|
|
3859
|
+
getInfo(): Promise<ImplementationMetadata_2>;
|
|
3860
|
+
getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
|
|
3861
|
+
getSystemChannels(): Promise<Array<SystemChannel>>;
|
|
3862
|
+
joinChannel(channelId: string): Promise<void>;
|
|
3863
|
+
}
|
|
3864
|
+
|
|
3698
3865
|
/**
|
|
3699
3866
|
* Generated when the desktop icon is clicked while it's already running.
|
|
3700
3867
|
* @interface
|
|
@@ -3767,12 +3934,52 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
|
3767
3934
|
type: 'disabled-movement-bounds-changing';
|
|
3768
3935
|
};
|
|
3769
3936
|
|
|
3937
|
+
/**
|
|
3938
|
+
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
3939
|
+
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
3940
|
+
* this is their meaning.
|
|
3941
|
+
*/
|
|
3942
|
+
declare interface DisplayMetadata {
|
|
3943
|
+
/**
|
|
3944
|
+
* A user-readable name for this channel, e.g: `"Red"`
|
|
3945
|
+
*/
|
|
3946
|
+
readonly name?: string;
|
|
3947
|
+
/**
|
|
3948
|
+
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
|
3949
|
+
*/
|
|
3950
|
+
readonly color?: string;
|
|
3951
|
+
/**
|
|
3952
|
+
* A URL of an image that can be used to display this channel
|
|
3953
|
+
*/
|
|
3954
|
+
readonly glyph?: string;
|
|
3955
|
+
}
|
|
3956
|
+
|
|
3957
|
+
/**
|
|
3958
|
+
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
3959
|
+
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
3960
|
+
* this is their meaning.
|
|
3961
|
+
*/
|
|
3962
|
+
declare interface DisplayMetadata_2 {
|
|
3963
|
+
/**
|
|
3964
|
+
* A user-readable name for this channel, e.g: `"Red"`
|
|
3965
|
+
*/
|
|
3966
|
+
readonly name?: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
|
3969
|
+
*/
|
|
3970
|
+
readonly color?: string;
|
|
3971
|
+
/**
|
|
3972
|
+
* A URL of an image that can be used to display this channel
|
|
3973
|
+
*/
|
|
3974
|
+
readonly glyph?: string;
|
|
3975
|
+
}
|
|
3976
|
+
|
|
3770
3977
|
/**
|
|
3771
3978
|
* The display data for a context group.
|
|
3772
3979
|
*
|
|
3773
3980
|
* @interface
|
|
3774
3981
|
*/
|
|
3775
|
-
declare type
|
|
3982
|
+
declare type DisplayMetadata_3 = {
|
|
3776
3983
|
/**
|
|
3777
3984
|
* A user-readable name for this context group, e.g: `"Red"`
|
|
3778
3985
|
*/
|
|
@@ -4364,6 +4571,13 @@ declare type FaviconUpdatedEvent = NamedEvent & {
|
|
|
4364
4571
|
favicons: string[];
|
|
4365
4572
|
};
|
|
4366
4573
|
|
|
4574
|
+
declare namespace FDC3 {
|
|
4575
|
+
export {
|
|
4576
|
+
v1,
|
|
4577
|
+
v2
|
|
4578
|
+
}
|
|
4579
|
+
}
|
|
4580
|
+
|
|
4367
4581
|
/**
|
|
4368
4582
|
* @interface
|
|
4369
4583
|
*/
|
|
@@ -4556,8 +4770,8 @@ declare type FindInPageResult = {
|
|
|
4556
4770
|
/**
|
|
4557
4771
|
* @interface
|
|
4558
4772
|
*/
|
|
4559
|
-
declare type FindIntentsByContextOptions<MetadataType =
|
|
4560
|
-
context:
|
|
4773
|
+
declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
|
|
4774
|
+
context: Context_3;
|
|
4561
4775
|
metadata?: MetadataType;
|
|
4562
4776
|
};
|
|
4563
4777
|
|
|
@@ -5076,6 +5290,15 @@ declare type HotkeyEvent = BaseViewEvent & {
|
|
|
5076
5290
|
type: 'hotkey';
|
|
5077
5291
|
};
|
|
5078
5292
|
|
|
5293
|
+
declare interface Icon {
|
|
5294
|
+
/** The icon url */
|
|
5295
|
+
readonly src: string;
|
|
5296
|
+
/** The icon dimension, formatted as `<height>x<width>`. */
|
|
5297
|
+
readonly size?: string;
|
|
5298
|
+
/** Icon media type. If not present the Desktop Agent may use the src file extension. */
|
|
5299
|
+
readonly type?: string;
|
|
5300
|
+
}
|
|
5301
|
+
|
|
5079
5302
|
declare type Identity = OpenFin_2.Identity;
|
|
5080
5303
|
|
|
5081
5304
|
declare type Identity_2 = OpenFin_2.Identity;
|
|
@@ -5128,6 +5351,17 @@ declare type IdleEvent = {
|
|
|
5128
5351
|
isIdle: boolean;
|
|
5129
5352
|
};
|
|
5130
5353
|
|
|
5354
|
+
declare interface Image_2 {
|
|
5355
|
+
/** The image url. */
|
|
5356
|
+
readonly src: string;
|
|
5357
|
+
/** The image dimension, formatted as `<height>x<width>`. */
|
|
5358
|
+
readonly size?: string;
|
|
5359
|
+
/** Image media type. If not present the Desktop Agent may use the src file extension. */
|
|
5360
|
+
readonly type?: string;
|
|
5361
|
+
/** Caption for the image. */
|
|
5362
|
+
readonly label?: string;
|
|
5363
|
+
}
|
|
5364
|
+
|
|
5131
5365
|
declare type ImageFormatOptions = {
|
|
5132
5366
|
format: 'dataURL' | 'png' | 'bmp';
|
|
5133
5367
|
} | {
|
|
@@ -5138,15 +5372,57 @@ declare type ImageFormatOptions = {
|
|
|
5138
5372
|
quality?: number;
|
|
5139
5373
|
};
|
|
5140
5374
|
|
|
5375
|
+
/**
|
|
5376
|
+
* Metadata relating to the FDC3 Desktop Agent implementation and its provider.
|
|
5377
|
+
*/
|
|
5378
|
+
declare interface ImplementationMetadata {
|
|
5379
|
+
/** The version number of the FDC3 specification that the implementation provides.
|
|
5380
|
+
* The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
|
|
5381
|
+
*/
|
|
5382
|
+
readonly fdc3Version: string;
|
|
5383
|
+
/** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
|
|
5384
|
+
readonly provider: string;
|
|
5385
|
+
/** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
|
|
5386
|
+
readonly providerVersion?: string;
|
|
5387
|
+
}
|
|
5388
|
+
|
|
5389
|
+
/**
|
|
5390
|
+
* Metadata relating to the FDC3 Desktop Agent implementation and its provider.
|
|
5391
|
+
*/
|
|
5392
|
+
declare interface ImplementationMetadata_2 {
|
|
5393
|
+
/** The version number of the FDC3 specification that the implementation provides.
|
|
5394
|
+
* The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
|
|
5395
|
+
*/
|
|
5396
|
+
readonly fdc3Version: string;
|
|
5397
|
+
/** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
|
|
5398
|
+
readonly provider: string;
|
|
5399
|
+
/** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
|
|
5400
|
+
readonly providerVersion?: string;
|
|
5401
|
+
/** Metadata indicating whether the Desktop Agent implements optional features of
|
|
5402
|
+
* the Desktop Agent API.
|
|
5403
|
+
*/
|
|
5404
|
+
readonly optionalFeatures: {
|
|
5405
|
+
/** Used to indicate whether the exposure of 'originating app metadata' for
|
|
5406
|
+
* context and intent messages is supported by the Desktop Agent. */
|
|
5407
|
+
readonly OriginatingAppMetadata: boolean;
|
|
5408
|
+
/** Used to indicate whether the optional `fdc3.joinUserChannel`,
|
|
5409
|
+
* `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
|
|
5410
|
+
* the Desktop Agent. */
|
|
5411
|
+
readonly UserChannelMembershipAPIs: boolean;
|
|
5412
|
+
};
|
|
5413
|
+
/** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
|
|
5414
|
+
readonly appMetadata: AppMetadata_2;
|
|
5415
|
+
}
|
|
5416
|
+
|
|
5141
5417
|
/**
|
|
5142
5418
|
* @interface
|
|
5143
5419
|
*/
|
|
5144
|
-
declare type InfoForIntentOptions<MetadataType =
|
|
5420
|
+
declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
5145
5421
|
/**
|
|
5146
5422
|
* Name of the intent to get info for.
|
|
5147
5423
|
*/
|
|
5148
5424
|
name: string;
|
|
5149
|
-
context?:
|
|
5425
|
+
context?: Context_3;
|
|
5150
5426
|
metadata?: MetadataType;
|
|
5151
5427
|
};
|
|
5152
5428
|
|
|
@@ -5219,10 +5495,16 @@ declare type InstalledApps_2 = {
|
|
|
5219
5495
|
[key: string]: InstallationInfo;
|
|
5220
5496
|
};
|
|
5221
5497
|
|
|
5498
|
+
declare interface Intent {
|
|
5499
|
+
name: string;
|
|
5500
|
+
context: Context_2;
|
|
5501
|
+
metadata: IntentMetadata_2;
|
|
5502
|
+
}
|
|
5503
|
+
|
|
5222
5504
|
/**
|
|
5223
5505
|
* Combination of an action and a context that is passed to an application for resolution.
|
|
5224
5506
|
*/
|
|
5225
|
-
declare type
|
|
5507
|
+
declare type Intent_2<MetadataType = IntentMetadata_3> = {
|
|
5226
5508
|
/**
|
|
5227
5509
|
* Name of the intent.
|
|
5228
5510
|
*/
|
|
@@ -5230,25 +5512,54 @@ declare type Intent<MetadataType = IntentMetadata> = {
|
|
|
5230
5512
|
/**
|
|
5231
5513
|
* Data associated with the intent.
|
|
5232
5514
|
*/
|
|
5233
|
-
context:
|
|
5515
|
+
context: Context_3;
|
|
5234
5516
|
metadata?: MetadataType;
|
|
5235
5517
|
};
|
|
5236
5518
|
|
|
5519
|
+
declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
|
|
5520
|
+
|
|
5237
5521
|
/**
|
|
5238
5522
|
* Subscription function for registerIntentHandler.
|
|
5239
5523
|
*/
|
|
5240
|
-
declare type
|
|
5524
|
+
declare type IntentHandler_2 = (intent: Intent_2) => void;
|
|
5241
5525
|
|
|
5242
5526
|
/**
|
|
5243
|
-
*
|
|
5244
|
-
* @interface
|
|
5527
|
+
* Intent descriptor
|
|
5245
5528
|
*/
|
|
5246
|
-
declare
|
|
5529
|
+
declare interface IntentMetadata {
|
|
5530
|
+
/** The unique name of the intent that can be invoked by the raiseIntent call */
|
|
5531
|
+
readonly name: string;
|
|
5532
|
+
/** A friendly display name for the intent that should be used to render UI elements */
|
|
5533
|
+
readonly displayName: string;
|
|
5534
|
+
}
|
|
5535
|
+
|
|
5536
|
+
declare type IntentMetadata_2<TargetType = any> = {
|
|
5247
5537
|
target?: TargetType;
|
|
5248
5538
|
resultType?: string;
|
|
5249
5539
|
intentResolutionResultId?: string;
|
|
5250
5540
|
};
|
|
5251
5541
|
|
|
5542
|
+
/**
|
|
5543
|
+
* The type used to describe an intent within the platform.
|
|
5544
|
+
* @interface
|
|
5545
|
+
*/
|
|
5546
|
+
declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
|
|
5547
|
+
|
|
5548
|
+
declare interface IntentResolution {
|
|
5549
|
+
source: TargetApp;
|
|
5550
|
+
data?: object;
|
|
5551
|
+
version: string;
|
|
5552
|
+
}
|
|
5553
|
+
|
|
5554
|
+
declare interface IntentResolution_2 {
|
|
5555
|
+
source: AppIdentifier;
|
|
5556
|
+
intent: string;
|
|
5557
|
+
version?: string;
|
|
5558
|
+
getResult(): Promise<IntentResult>;
|
|
5559
|
+
}
|
|
5560
|
+
|
|
5561
|
+
declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
|
|
5562
|
+
|
|
5252
5563
|
/**
|
|
5253
5564
|
* A messaging bus that allows for pub/sub messaging between different applications.
|
|
5254
5565
|
*
|
|
@@ -5838,23 +6149,23 @@ declare class InteropBroker extends Base {
|
|
|
5838
6149
|
* @param clientIdentity Identity of the Client making the request.
|
|
5839
6150
|
*/
|
|
5840
6151
|
fdc3HandleOpen({ app, context }: {
|
|
5841
|
-
app: TargetApp | AppIdentifier;
|
|
6152
|
+
app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
|
|
5842
6153
|
context: OpenFin_2.Context;
|
|
5843
|
-
}, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | AppIdentifier>;
|
|
6154
|
+
}, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
|
|
5844
6155
|
/**
|
|
5845
6156
|
* Responsible for resolving the fdc3.findInstances call.
|
|
5846
6157
|
* Must be overridden
|
|
5847
6158
|
* @param app AppIdentifier that was passed to fdc3.findInstances
|
|
5848
6159
|
* @param clientIdentity Identity of the Client making the request.
|
|
5849
6160
|
*/
|
|
5850
|
-
fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
6161
|
+
fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
5851
6162
|
/**
|
|
5852
6163
|
* Responsible for resolving the fdc3.getAppMetadata call.
|
|
5853
6164
|
* Must be overridden
|
|
5854
6165
|
* @param app AppIdentifier that was passed to fdc3.getAppMetadata
|
|
5855
6166
|
* @param clientIdentity Identity of the Client making the request.
|
|
5856
6167
|
*/
|
|
5857
|
-
fdc3HandleGetAppMetadata(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
6168
|
+
fdc3HandleGetAppMetadata(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
5858
6169
|
/**
|
|
5859
6170
|
* This function is called by the Interop Broker whenever a Context handler would fire.
|
|
5860
6171
|
* For FDC3 2.0 you would need to override this function and add the contextMetadata as
|
|
@@ -7442,7 +7753,21 @@ declare type LayoutRow = LayoutItemConfig & {
|
|
|
7442
7753
|
*/
|
|
7443
7754
|
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'>;
|
|
7444
7755
|
|
|
7445
|
-
declare
|
|
7756
|
+
declare interface Listener {
|
|
7757
|
+
/**
|
|
7758
|
+
* Unsubscribe the listener object.
|
|
7759
|
+
*/
|
|
7760
|
+
unsubscribe(): void;
|
|
7761
|
+
}
|
|
7762
|
+
|
|
7763
|
+
declare interface Listener_2 {
|
|
7764
|
+
/**
|
|
7765
|
+
* Unsubscribe the listener object.
|
|
7766
|
+
*/
|
|
7767
|
+
unsubscribe(): void;
|
|
7768
|
+
}
|
|
7769
|
+
|
|
7770
|
+
declare type Listener_3<T extends {
|
|
7446
7771
|
type: string;
|
|
7447
7772
|
}> = (payload: T) => void;
|
|
7448
7773
|
|
|
@@ -8232,11 +8557,11 @@ declare namespace OpenFin_2 {
|
|
|
8232
8557
|
ApplicationOptions,
|
|
8233
8558
|
InteropBrokerOptions,
|
|
8234
8559
|
ContextGroupInfo,
|
|
8235
|
-
DisplayMetadata,
|
|
8560
|
+
DisplayMetadata_3 as DisplayMetadata,
|
|
8236
8561
|
LegacyWinOptionsInAppOptions,
|
|
8237
8562
|
Snapshot,
|
|
8238
8563
|
ContextGroupStates,
|
|
8239
|
-
Context,
|
|
8564
|
+
Context_3 as Context,
|
|
8240
8565
|
MonitorInfo,
|
|
8241
8566
|
Point,
|
|
8242
8567
|
PointTopLeft,
|
|
@@ -8405,10 +8730,10 @@ declare namespace OpenFin_2 {
|
|
|
8405
8730
|
FileDownloadBehaviorNames,
|
|
8406
8731
|
FileDownloadSettings,
|
|
8407
8732
|
DownloadRule,
|
|
8408
|
-
ContextHandler,
|
|
8409
|
-
Intent,
|
|
8410
|
-
IntentMetadata,
|
|
8411
|
-
IntentHandler,
|
|
8733
|
+
ContextHandler_3 as ContextHandler,
|
|
8734
|
+
Intent_2 as Intent,
|
|
8735
|
+
IntentMetadata_3 as IntentMetadata,
|
|
8736
|
+
IntentHandler_2 as IntentHandler,
|
|
8412
8737
|
ContentCreationBehaviorNames,
|
|
8413
8738
|
MatchPattern,
|
|
8414
8739
|
ContentCreationRule,
|
|
@@ -10255,6 +10580,14 @@ declare type PrintOptions = {
|
|
|
10255
10580
|
dpi?: Dpi;
|
|
10256
10581
|
};
|
|
10257
10582
|
|
|
10583
|
+
declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
|
|
10584
|
+
addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
|
|
10585
|
+
onAddContextListener(handler: (contextType?: string) => void): Listener_2;
|
|
10586
|
+
onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
|
|
10587
|
+
onDisconnect(handler: () => void): Listener_2;
|
|
10588
|
+
disconnect(): void;
|
|
10589
|
+
};
|
|
10590
|
+
|
|
10258
10591
|
/**
|
|
10259
10592
|
* Strategy to assign views to process affinity by domain.
|
|
10260
10593
|
*
|
|
@@ -11167,19 +11500,19 @@ declare type SessionContextGroup = {
|
|
|
11167
11500
|
* A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
|
11168
11501
|
* @param context The Context to be set.
|
|
11169
11502
|
*/
|
|
11170
|
-
setContext: (context:
|
|
11503
|
+
setContext: (context: Context_3) => Promise<void>;
|
|
11171
11504
|
/**
|
|
11172
11505
|
* A SessionContextGroup instance method for getting the current context of a certain type.
|
|
11173
11506
|
* @param type The Context Type to get. If not specified the last contextType set would get used.
|
|
11174
11507
|
*/
|
|
11175
|
-
getCurrentContext: (type?: string) => Promise<
|
|
11508
|
+
getCurrentContext: (type?: string) => Promise<Context_3>;
|
|
11176
11509
|
/**
|
|
11177
11510
|
* A SessionContextGroup instance method for adding a handler for context change.
|
|
11178
11511
|
* @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.
|
|
11179
11512
|
* @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.
|
|
11180
11513
|
*
|
|
11181
11514
|
*/
|
|
11182
|
-
addContextHandler: (handler:
|
|
11515
|
+
addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
|
|
11183
11516
|
unsubscribe: () => void;
|
|
11184
11517
|
}>;
|
|
11185
11518
|
};
|
|
@@ -12926,6 +13259,12 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
12926
13259
|
setDomainSettings(domainSettings: OpenFin_2.DefaultDomainSettings): Promise<void>;
|
|
12927
13260
|
}
|
|
12928
13261
|
|
|
13262
|
+
declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
|
|
13263
|
+
addContextListener(): Error;
|
|
13264
|
+
broadcast(): Error;
|
|
13265
|
+
getCurrentContext(): Error;
|
|
13266
|
+
};
|
|
13267
|
+
|
|
12929
13268
|
/**
|
|
12930
13269
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link System}. Events are
|
|
12931
13270
|
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
@@ -13398,13 +13737,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
|
|
|
13398
13737
|
declare interface TypedEventEmitter<Event extends {
|
|
13399
13738
|
type: string;
|
|
13400
13739
|
}, EmitterEventType = Event['type']> {
|
|
13401
|
-
on<EventType extends EmitterEventType>(event: EventType, listener:
|
|
13740
|
+
on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
|
|
13402
13741
|
type: EventType;
|
|
13403
13742
|
}>>): this;
|
|
13404
|
-
addListener<EventType extends EmitterEventType>(event: EventType, listener:
|
|
13743
|
+
addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
|
|
13405
13744
|
type: EventType;
|
|
13406
13745
|
}>>): this;
|
|
13407
|
-
removeListener<EventType extends EmitterEventType>(event: EventType, listener:
|
|
13746
|
+
removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
|
|
13408
13747
|
type: EventType;
|
|
13409
13748
|
}>>): this;
|
|
13410
13749
|
removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
|
|
@@ -13475,6 +13814,48 @@ declare type UserMovementEnabledEvent = NamedEvent & {
|
|
|
13475
13814
|
type: 'user-movement-enabled';
|
|
13476
13815
|
};
|
|
13477
13816
|
|
|
13817
|
+
declare namespace v1 {
|
|
13818
|
+
export {
|
|
13819
|
+
Listener,
|
|
13820
|
+
AppMetadata,
|
|
13821
|
+
IntentMetadata,
|
|
13822
|
+
AppIntent,
|
|
13823
|
+
DisplayMetadata,
|
|
13824
|
+
ImplementationMetadata,
|
|
13825
|
+
ContextHandler,
|
|
13826
|
+
TargetApp,
|
|
13827
|
+
Context,
|
|
13828
|
+
IntentResolution,
|
|
13829
|
+
Channel_3 as Channel,
|
|
13830
|
+
SystemChannel,
|
|
13831
|
+
DesktopAgent
|
|
13832
|
+
}
|
|
13833
|
+
}
|
|
13834
|
+
|
|
13835
|
+
declare namespace v2 {
|
|
13836
|
+
export {
|
|
13837
|
+
IntentMetadata_2 as IntentMetadata,
|
|
13838
|
+
AppIdentifier,
|
|
13839
|
+
Listener_2 as Listener,
|
|
13840
|
+
AppIntent_2 as AppIntent,
|
|
13841
|
+
ImplementationMetadata_2 as ImplementationMetadata,
|
|
13842
|
+
ContextMetadata,
|
|
13843
|
+
Icon,
|
|
13844
|
+
Image_2 as Image,
|
|
13845
|
+
AppMetadata_2 as AppMetadata,
|
|
13846
|
+
DisplayMetadata_2 as DisplayMetadata,
|
|
13847
|
+
ContextHandler_2 as ContextHandler,
|
|
13848
|
+
IntentHandler,
|
|
13849
|
+
IntentResult,
|
|
13850
|
+
Context_2 as Context,
|
|
13851
|
+
Intent,
|
|
13852
|
+
IntentResolution_2 as IntentResolution,
|
|
13853
|
+
Channel_4 as Channel,
|
|
13854
|
+
PrivateChannel,
|
|
13855
|
+
DesktopAgent_2 as DesktopAgent
|
|
13856
|
+
}
|
|
13857
|
+
}
|
|
13858
|
+
|
|
13478
13859
|
declare type View = OpenFin_2.View;
|
|
13479
13860
|
|
|
13480
13861
|
/**
|