@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.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}.
|
|
@@ -1353,6 +1377,60 @@ declare type ApplySnapshotPayload = {
|
|
|
1353
1377
|
options?: ApplySnapshotOptions;
|
|
1354
1378
|
};
|
|
1355
1379
|
|
|
1380
|
+
/**
|
|
1381
|
+
* App definition as provided by the application directory
|
|
1382
|
+
*/
|
|
1383
|
+
declare interface AppMetadata {
|
|
1384
|
+
/** The unique app name that can be used with the open and raiseIntent calls. */
|
|
1385
|
+
readonly name: string;
|
|
1386
|
+
/** The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root' */
|
|
1387
|
+
readonly appId?: string;
|
|
1388
|
+
/** The Version of the application. */
|
|
1389
|
+
readonly version?: string;
|
|
1390
|
+
/** A more user-friendly application title that can be used to render UI elements */
|
|
1391
|
+
readonly title?: string;
|
|
1392
|
+
/** A tooltip for the application that can be used to render UI elements */
|
|
1393
|
+
readonly tooltip?: string;
|
|
1394
|
+
/** A longer, multi-paragraph description for the application that could include markup */
|
|
1395
|
+
readonly description?: string;
|
|
1396
|
+
/** A list of icon URLs for the application that can be used to render UI elements */
|
|
1397
|
+
readonly icons?: Array<string>;
|
|
1398
|
+
/** A list of image URLs for the application that can be used to render UI elements */
|
|
1399
|
+
readonly images?: Array<string>;
|
|
1400
|
+
}
|
|
1401
|
+
|
|
1402
|
+
/**
|
|
1403
|
+
* 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.
|
|
1404
|
+
*
|
|
1405
|
+
* 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.
|
|
1406
|
+
*
|
|
1407
|
+
* Note that as `AppMetadata` instances are also `AppIdentifiers` they may be passed to the `app` argument of `fdc3.open`, `fdc3.raiseIntent` etc.
|
|
1408
|
+
*/
|
|
1409
|
+
declare interface AppMetadata_2 extends AppIdentifier {
|
|
1410
|
+
/**
|
|
1411
|
+
The 'friendly' app name.
|
|
1412
|
+
This field was used with the `open` and `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier` wth `appId` set.
|
|
1413
|
+
Note that for display purposes the `title` field should be used, if set, in preference to this field.
|
|
1414
|
+
*/
|
|
1415
|
+
readonly name?: string;
|
|
1416
|
+
/** The Version of the application. */
|
|
1417
|
+
readonly version?: string;
|
|
1418
|
+
/** 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. */
|
|
1419
|
+
readonly instanceMetadata?: Record<string, any>;
|
|
1420
|
+
/** A more user-friendly application title that can be used to render UI elements */
|
|
1421
|
+
readonly title?: string;
|
|
1422
|
+
/** A tooltip for the application that can be used to render UI elements */
|
|
1423
|
+
readonly tooltip?: string;
|
|
1424
|
+
/** A longer, multi-paragraph description for the application that could include markup */
|
|
1425
|
+
readonly description?: string;
|
|
1426
|
+
/** A list of icon URLs for the application that can be used to render UI elements */
|
|
1427
|
+
readonly icons?: Array<Icon>;
|
|
1428
|
+
/** Images representing the app in common usage scenarios that can be used to render UI elements */
|
|
1429
|
+
readonly screenshots?: Array<Image_2>;
|
|
1430
|
+
/** 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>"). */
|
|
1431
|
+
readonly resultType?: string | null;
|
|
1432
|
+
}
|
|
1433
|
+
|
|
1356
1434
|
/**
|
|
1357
1435
|
* @interface
|
|
1358
1436
|
*/
|
|
@@ -2035,7 +2113,25 @@ declare class Channel extends EmitterBase<ChannelEvent> {
|
|
|
2035
2113
|
|
|
2036
2114
|
declare type Channel_2 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
|
2037
2115
|
|
|
2038
|
-
declare
|
|
2116
|
+
declare interface Channel_3 {
|
|
2117
|
+
id: string;
|
|
2118
|
+
type: string;
|
|
2119
|
+
displayMetadata?: DisplayMetadata;
|
|
2120
|
+
broadcast(context: Context): void;
|
|
2121
|
+
getCurrentContext(contextType?: string): Promise<Context | null>;
|
|
2122
|
+
addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
|
|
2123
|
+
}
|
|
2124
|
+
|
|
2125
|
+
declare interface Channel_4 {
|
|
2126
|
+
readonly id: string;
|
|
2127
|
+
readonly type: 'user' | 'app' | 'private';
|
|
2128
|
+
readonly displayMetadata?: DisplayMetadata_2;
|
|
2129
|
+
broadcast(context: Context_2): Promise<void>;
|
|
2130
|
+
getCurrentContext(contextType?: string): Promise<Context_2 | null>;
|
|
2131
|
+
addContextListener(contextType: string | null, handler: ContextHandler_2): Listener_2 & Promise<Listener_2>;
|
|
2132
|
+
}
|
|
2133
|
+
|
|
2134
|
+
declare type Channel_5 = OpenFin_2.Fin['InterApplicationBus']['Channel'];
|
|
2039
2135
|
|
|
2040
2136
|
declare type ChannelAction = OpenFin_2.ChannelAction;
|
|
2041
2137
|
|
|
@@ -3535,12 +3631,26 @@ declare type ContentNavigation = NavigationRules;
|
|
|
3535
3631
|
*/
|
|
3536
3632
|
declare type ContentRedirect = NavigationRules;
|
|
3537
3633
|
|
|
3634
|
+
declare interface Context {
|
|
3635
|
+
id?: { [key: string]: string };
|
|
3636
|
+
name?: string;
|
|
3637
|
+
type: string;
|
|
3638
|
+
}
|
|
3639
|
+
|
|
3640
|
+
declare interface Context_2 {
|
|
3641
|
+
id?: { [key: string]: string };
|
|
3642
|
+
name?: string;
|
|
3643
|
+
type: string;
|
|
3644
|
+
contextMetadata?: ContextMetadata;
|
|
3645
|
+
metadata?: any;
|
|
3646
|
+
}
|
|
3647
|
+
|
|
3538
3648
|
/**
|
|
3539
3649
|
* Data passed between entities and applications.
|
|
3540
3650
|
*
|
|
3541
3651
|
* @interface
|
|
3542
3652
|
*/
|
|
3543
|
-
declare type
|
|
3653
|
+
declare type Context_3 = {
|
|
3544
3654
|
/**
|
|
3545
3655
|
* An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
|
|
3546
3656
|
*/
|
|
@@ -3560,7 +3670,7 @@ declare type Context = {
|
|
|
3560
3670
|
/**
|
|
3561
3671
|
* @interface
|
|
3562
3672
|
*/
|
|
3563
|
-
declare type ContextForIntent<MetadataType = any> =
|
|
3673
|
+
declare type ContextForIntent<MetadataType = any> = Context_3 & {
|
|
3564
3674
|
metadata?: MetadataType;
|
|
3565
3675
|
};
|
|
3566
3676
|
|
|
@@ -3576,19 +3686,23 @@ declare type ContextGroupInfo = {
|
|
|
3576
3686
|
/**
|
|
3577
3687
|
* Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
|
|
3578
3688
|
*/
|
|
3579
|
-
displayMetadata?:
|
|
3689
|
+
displayMetadata?: DisplayMetadata_3;
|
|
3580
3690
|
};
|
|
3581
3691
|
|
|
3582
3692
|
declare type ContextGroupStates = {
|
|
3583
3693
|
[key: string]: {
|
|
3584
|
-
[key: string]:
|
|
3694
|
+
[key: string]: Context_3;
|
|
3585
3695
|
};
|
|
3586
3696
|
};
|
|
3587
3697
|
|
|
3698
|
+
declare type ContextHandler = (context: Context) => void;
|
|
3699
|
+
|
|
3700
|
+
declare type ContextHandler_2 = (context: Context_2, metadata?: ContextMetadata) => void;
|
|
3701
|
+
|
|
3588
3702
|
/**
|
|
3589
3703
|
* Subscription function for addContextHandler.
|
|
3590
3704
|
*/
|
|
3591
|
-
declare type
|
|
3705
|
+
declare type ContextHandler_3 = (context: Context_3) => void;
|
|
3592
3706
|
|
|
3593
3707
|
/**
|
|
3594
3708
|
* Configure the context menu when right-clicking on a window.
|
|
@@ -3627,6 +3741,20 @@ declare type ContextMenuSettings = {
|
|
|
3627
3741
|
reload?: boolean;
|
|
3628
3742
|
};
|
|
3629
3743
|
|
|
3744
|
+
/**
|
|
3745
|
+
* Metadata relating to a context or intent and context received through the
|
|
3746
|
+
* `addContextListener` and `addIntentListener` functions.
|
|
3747
|
+
*
|
|
3748
|
+
* @experimental Introduced in FDC3 2.0 and may be refined by further changes outside the normal FDC3 versioning policy.
|
|
3749
|
+
*/
|
|
3750
|
+
declare interface ContextMetadata {
|
|
3751
|
+
/** Identifier for the app instance that sent the context and/or intent.
|
|
3752
|
+
*
|
|
3753
|
+
* @experimental
|
|
3754
|
+
*/
|
|
3755
|
+
readonly source: AppIdentifier;
|
|
3756
|
+
}
|
|
3757
|
+
|
|
3630
3758
|
/**
|
|
3631
3759
|
* @interface
|
|
3632
3760
|
*/
|
|
@@ -3789,6 +3917,45 @@ declare type DefaultDomainSettingsRule = {
|
|
|
3789
3917
|
};
|
|
3790
3918
|
};
|
|
3791
3919
|
|
|
3920
|
+
declare interface DesktopAgent {
|
|
3921
|
+
open(app: TargetApp, context?: Context): Promise<void>;
|
|
3922
|
+
findIntent(intent: string, context?: Context): Promise<AppIntent>;
|
|
3923
|
+
findIntentsByContext(context: Context): Promise<Array<AppIntent>>;
|
|
3924
|
+
broadcast(context: Context): void;
|
|
3925
|
+
raiseIntent(intent: string, context: Context, app?: TargetApp): Promise<IntentResolution>;
|
|
3926
|
+
raiseIntentForContext(context: Context, app?: TargetApp): Promise<IntentResolution>;
|
|
3927
|
+
addIntentListener(intent: string, handler: ContextHandler): Listener;
|
|
3928
|
+
joinChannel(channelId: string): Promise<void>;
|
|
3929
|
+
leaveCurrentChannel(): Promise<void>;
|
|
3930
|
+
getInfo(): ImplementationMetadata;
|
|
3931
|
+
addContextListener(contextType: string | null, handler: ContextHandler): Listener & Promise<Listener>;
|
|
3932
|
+
getOrCreateChannel(channelId: string): Promise<Channel_3>;
|
|
3933
|
+
getSystemChannels(): Promise<SystemChannel[]>;
|
|
3934
|
+
getCurrentChannel(): Promise<Channel_3 | null>;
|
|
3935
|
+
}
|
|
3936
|
+
|
|
3937
|
+
declare interface DesktopAgent_2 {
|
|
3938
|
+
open(app: AppIdentifier | TargetApp, context?: Context_2): Promise<AppIdentifier>;
|
|
3939
|
+
findIntent(intent: string, context?: Context_2, resultType?: string): Promise<AppIntent_2>;
|
|
3940
|
+
findIntentsByContext(context: Context_2, resultType?: string): Promise<Array<AppIntent_2>>;
|
|
3941
|
+
findInstances(app: AppIdentifier): Promise<Array<AppIdentifier>>;
|
|
3942
|
+
broadcast(context: Context_2): Promise<void>;
|
|
3943
|
+
raiseIntent(intent: string, context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
|
|
3944
|
+
raiseIntentForContext(context: Context_2, app?: AppIdentifier | TargetApp): Promise<IntentResolution_2>;
|
|
3945
|
+
addIntentListener(intent: string, handler: IntentHandler): Promise<Listener_2>;
|
|
3946
|
+
addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
|
|
3947
|
+
getUserChannels(): Promise<Array<SystemChannel>>;
|
|
3948
|
+
joinUserChannel(channelId: string): Promise<void>;
|
|
3949
|
+
getOrCreateChannel(channelId: string): Promise<Channel_4>;
|
|
3950
|
+
createPrivateChannel(): Promise<PrivateChannel>;
|
|
3951
|
+
getCurrentChannel(): Promise<Channel_3 | null>;
|
|
3952
|
+
leaveCurrentChannel(): Promise<void>;
|
|
3953
|
+
getInfo(): Promise<ImplementationMetadata_2>;
|
|
3954
|
+
getAppMetadata(app: AppIdentifier): Promise<AppMetadata_2>;
|
|
3955
|
+
getSystemChannels(): Promise<Array<SystemChannel>>;
|
|
3956
|
+
joinChannel(channelId: string): Promise<void>;
|
|
3957
|
+
}
|
|
3958
|
+
|
|
3792
3959
|
/**
|
|
3793
3960
|
* Generated when the desktop icon is clicked while it's already running.
|
|
3794
3961
|
* @interface
|
|
@@ -3861,12 +4028,52 @@ declare type DisabledMovementBoundsChangingEvent = BoundsChangeEvent & {
|
|
|
3861
4028
|
type: 'disabled-movement-bounds-changing';
|
|
3862
4029
|
};
|
|
3863
4030
|
|
|
4031
|
+
/**
|
|
4032
|
+
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
4033
|
+
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
4034
|
+
* this is their meaning.
|
|
4035
|
+
*/
|
|
4036
|
+
declare interface DisplayMetadata {
|
|
4037
|
+
/**
|
|
4038
|
+
* A user-readable name for this channel, e.g: `"Red"`
|
|
4039
|
+
*/
|
|
4040
|
+
readonly name?: string;
|
|
4041
|
+
/**
|
|
4042
|
+
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
|
4043
|
+
*/
|
|
4044
|
+
readonly color?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* A URL of an image that can be used to display this channel
|
|
4047
|
+
*/
|
|
4048
|
+
readonly glyph?: string;
|
|
4049
|
+
}
|
|
4050
|
+
|
|
4051
|
+
/**
|
|
4052
|
+
* A system channel will be global enough to have a presence across many apps. This gives us some hints
|
|
4053
|
+
* to render them in a standard way. It is assumed it may have other properties too, but if it has these,
|
|
4054
|
+
* this is their meaning.
|
|
4055
|
+
*/
|
|
4056
|
+
declare interface DisplayMetadata_2 {
|
|
4057
|
+
/**
|
|
4058
|
+
* A user-readable name for this channel, e.g: `"Red"`
|
|
4059
|
+
*/
|
|
4060
|
+
readonly name?: string;
|
|
4061
|
+
/**
|
|
4062
|
+
* The color that should be associated within this channel when displaying this channel in a UI, e.g: `0xFF0000`.
|
|
4063
|
+
*/
|
|
4064
|
+
readonly color?: string;
|
|
4065
|
+
/**
|
|
4066
|
+
* A URL of an image that can be used to display this channel
|
|
4067
|
+
*/
|
|
4068
|
+
readonly glyph?: string;
|
|
4069
|
+
}
|
|
4070
|
+
|
|
3864
4071
|
/**
|
|
3865
4072
|
* The display data for a context group.
|
|
3866
4073
|
*
|
|
3867
4074
|
* @interface
|
|
3868
4075
|
*/
|
|
3869
|
-
declare type
|
|
4076
|
+
declare type DisplayMetadata_3 = {
|
|
3870
4077
|
/**
|
|
3871
4078
|
* A user-readable name for this context group, e.g: `"Red"`
|
|
3872
4079
|
*/
|
|
@@ -4482,6 +4689,13 @@ declare type FaviconUpdatedEvent = NamedEvent & {
|
|
|
4482
4689
|
favicons: string[];
|
|
4483
4690
|
};
|
|
4484
4691
|
|
|
4692
|
+
declare namespace FDC3 {
|
|
4693
|
+
export {
|
|
4694
|
+
v1,
|
|
4695
|
+
v2
|
|
4696
|
+
}
|
|
4697
|
+
}
|
|
4698
|
+
|
|
4485
4699
|
/**
|
|
4486
4700
|
* @interface
|
|
4487
4701
|
*/
|
|
@@ -4674,8 +4888,8 @@ declare type FindInPageResult = {
|
|
|
4674
4888
|
/**
|
|
4675
4889
|
* @interface
|
|
4676
4890
|
*/
|
|
4677
|
-
declare type FindIntentsByContextOptions<MetadataType =
|
|
4678
|
-
context:
|
|
4891
|
+
declare type FindIntentsByContextOptions<MetadataType = IntentMetadata_3> = {
|
|
4892
|
+
context: Context_3;
|
|
4679
4893
|
metadata?: MetadataType;
|
|
4680
4894
|
};
|
|
4681
4895
|
|
|
@@ -5200,6 +5414,15 @@ declare type HotkeyEvent = BaseViewEvent & {
|
|
|
5200
5414
|
type: 'hotkey';
|
|
5201
5415
|
};
|
|
5202
5416
|
|
|
5417
|
+
declare interface Icon {
|
|
5418
|
+
/** The icon url */
|
|
5419
|
+
readonly src: string;
|
|
5420
|
+
/** The icon dimension, formatted as `<height>x<width>`. */
|
|
5421
|
+
readonly size?: string;
|
|
5422
|
+
/** Icon media type. If not present the Desktop Agent may use the src file extension. */
|
|
5423
|
+
readonly type?: string;
|
|
5424
|
+
}
|
|
5425
|
+
|
|
5203
5426
|
declare type Identity = OpenFin_2.Identity;
|
|
5204
5427
|
|
|
5205
5428
|
declare type Identity_2 = OpenFin_2.Identity;
|
|
@@ -5255,6 +5478,17 @@ declare type IdleEvent = {
|
|
|
5255
5478
|
isIdle: boolean;
|
|
5256
5479
|
};
|
|
5257
5480
|
|
|
5481
|
+
declare interface Image_2 {
|
|
5482
|
+
/** The image url. */
|
|
5483
|
+
readonly src: string;
|
|
5484
|
+
/** The image dimension, formatted as `<height>x<width>`. */
|
|
5485
|
+
readonly size?: string;
|
|
5486
|
+
/** Image media type. If not present the Desktop Agent may use the src file extension. */
|
|
5487
|
+
readonly type?: string;
|
|
5488
|
+
/** Caption for the image. */
|
|
5489
|
+
readonly label?: string;
|
|
5490
|
+
}
|
|
5491
|
+
|
|
5258
5492
|
declare type ImageFormatOptions = {
|
|
5259
5493
|
format: 'dataURL' | 'png' | 'bmp';
|
|
5260
5494
|
} | {
|
|
@@ -5265,15 +5499,57 @@ declare type ImageFormatOptions = {
|
|
|
5265
5499
|
quality?: number;
|
|
5266
5500
|
};
|
|
5267
5501
|
|
|
5502
|
+
/**
|
|
5503
|
+
* Metadata relating to the FDC3 Desktop Agent implementation and its provider.
|
|
5504
|
+
*/
|
|
5505
|
+
declare interface ImplementationMetadata {
|
|
5506
|
+
/** The version number of the FDC3 specification that the implementation provides.
|
|
5507
|
+
* The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
|
|
5508
|
+
*/
|
|
5509
|
+
readonly fdc3Version: string;
|
|
5510
|
+
/** The name of the provider of the FDC3 Desktop Agent Implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
|
|
5511
|
+
readonly provider: string;
|
|
5512
|
+
/** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
|
|
5513
|
+
readonly providerVersion?: string;
|
|
5514
|
+
}
|
|
5515
|
+
|
|
5516
|
+
/**
|
|
5517
|
+
* Metadata relating to the FDC3 Desktop Agent implementation and its provider.
|
|
5518
|
+
*/
|
|
5519
|
+
declare interface ImplementationMetadata_2 {
|
|
5520
|
+
/** The version number of the FDC3 specification that the implementation provides.
|
|
5521
|
+
* The string must be a numeric semver version, e.g. 1.2 or 1.2.1.
|
|
5522
|
+
*/
|
|
5523
|
+
readonly fdc3Version: string;
|
|
5524
|
+
/** The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.). */
|
|
5525
|
+
readonly provider: string;
|
|
5526
|
+
/** The version of the provider of the Desktop Agent implementation (e.g. 5.3.0). */
|
|
5527
|
+
readonly providerVersion?: string;
|
|
5528
|
+
/** Metadata indicating whether the Desktop Agent implements optional features of
|
|
5529
|
+
* the Desktop Agent API.
|
|
5530
|
+
*/
|
|
5531
|
+
readonly optionalFeatures: {
|
|
5532
|
+
/** Used to indicate whether the exposure of 'originating app metadata' for
|
|
5533
|
+
* context and intent messages is supported by the Desktop Agent. */
|
|
5534
|
+
readonly OriginatingAppMetadata: boolean;
|
|
5535
|
+
/** Used to indicate whether the optional `fdc3.joinUserChannel`,
|
|
5536
|
+
* `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
|
|
5537
|
+
* the Desktop Agent. */
|
|
5538
|
+
readonly UserChannelMembershipAPIs: boolean;
|
|
5539
|
+
};
|
|
5540
|
+
/** The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the `appId` and `instanceId`). */
|
|
5541
|
+
readonly appMetadata: AppMetadata_2;
|
|
5542
|
+
}
|
|
5543
|
+
|
|
5268
5544
|
/**
|
|
5269
5545
|
* @interface
|
|
5270
5546
|
*/
|
|
5271
|
-
declare type InfoForIntentOptions<MetadataType =
|
|
5547
|
+
declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
5272
5548
|
/**
|
|
5273
5549
|
* Name of the intent to get info for.
|
|
5274
5550
|
*/
|
|
5275
5551
|
name: string;
|
|
5276
|
-
context?:
|
|
5552
|
+
context?: Context_3;
|
|
5277
5553
|
metadata?: MetadataType;
|
|
5278
5554
|
};
|
|
5279
5555
|
|
|
@@ -5346,10 +5622,16 @@ declare type InstalledApps_2 = {
|
|
|
5346
5622
|
[key: string]: InstallationInfo;
|
|
5347
5623
|
};
|
|
5348
5624
|
|
|
5625
|
+
declare interface Intent {
|
|
5626
|
+
name: string;
|
|
5627
|
+
context: Context_2;
|
|
5628
|
+
metadata: IntentMetadata_2;
|
|
5629
|
+
}
|
|
5630
|
+
|
|
5349
5631
|
/**
|
|
5350
5632
|
* Combination of an action and a context that is passed to an application for resolution.
|
|
5351
5633
|
*/
|
|
5352
|
-
declare type
|
|
5634
|
+
declare type Intent_2<MetadataType = IntentMetadata_3> = {
|
|
5353
5635
|
/**
|
|
5354
5636
|
* Name of the intent.
|
|
5355
5637
|
*/
|
|
@@ -5357,25 +5639,54 @@ declare type Intent<MetadataType = IntentMetadata> = {
|
|
|
5357
5639
|
/**
|
|
5358
5640
|
* Data associated with the intent.
|
|
5359
5641
|
*/
|
|
5360
|
-
context:
|
|
5642
|
+
context: Context_3;
|
|
5361
5643
|
metadata?: MetadataType;
|
|
5362
5644
|
};
|
|
5363
5645
|
|
|
5646
|
+
declare type IntentHandler = (context: Context_2, metadata?: ContextMetadata) => Promise<IntentResult> | void;
|
|
5647
|
+
|
|
5364
5648
|
/**
|
|
5365
5649
|
* Subscription function for registerIntentHandler.
|
|
5366
5650
|
*/
|
|
5367
|
-
declare type
|
|
5651
|
+
declare type IntentHandler_2 = (intent: Intent_2) => void;
|
|
5368
5652
|
|
|
5369
5653
|
/**
|
|
5370
|
-
*
|
|
5371
|
-
* @interface
|
|
5654
|
+
* Intent descriptor
|
|
5372
5655
|
*/
|
|
5373
|
-
declare
|
|
5656
|
+
declare interface IntentMetadata {
|
|
5657
|
+
/** The unique name of the intent that can be invoked by the raiseIntent call */
|
|
5658
|
+
readonly name: string;
|
|
5659
|
+
/** A friendly display name for the intent that should be used to render UI elements */
|
|
5660
|
+
readonly displayName: string;
|
|
5661
|
+
}
|
|
5662
|
+
|
|
5663
|
+
declare type IntentMetadata_2<TargetType = any> = {
|
|
5374
5664
|
target?: TargetType;
|
|
5375
5665
|
resultType?: string;
|
|
5376
5666
|
intentResolutionResultId?: string;
|
|
5377
5667
|
};
|
|
5378
5668
|
|
|
5669
|
+
/**
|
|
5670
|
+
* The type used to describe an intent within the platform.
|
|
5671
|
+
* @interface
|
|
5672
|
+
*/
|
|
5673
|
+
declare type IntentMetadata_3<TargetType = any> = FDC3.v2.IntentMetadata<TargetType>;
|
|
5674
|
+
|
|
5675
|
+
declare interface IntentResolution {
|
|
5676
|
+
source: TargetApp;
|
|
5677
|
+
data?: object;
|
|
5678
|
+
version: string;
|
|
5679
|
+
}
|
|
5680
|
+
|
|
5681
|
+
declare interface IntentResolution_2 {
|
|
5682
|
+
source: AppIdentifier;
|
|
5683
|
+
intent: string;
|
|
5684
|
+
version?: string;
|
|
5685
|
+
getResult(): Promise<IntentResult>;
|
|
5686
|
+
}
|
|
5687
|
+
|
|
5688
|
+
declare type IntentResult = Context_2 | Channel_4 | PrivateChannel;
|
|
5689
|
+
|
|
5379
5690
|
/**
|
|
5380
5691
|
* A messaging bus that allows for pub/sub messaging between different applications.
|
|
5381
5692
|
*
|
|
@@ -5980,23 +6291,23 @@ declare class InteropBroker extends Base {
|
|
|
5980
6291
|
* @param clientIdentity Identity of the Client making the request.
|
|
5981
6292
|
*/
|
|
5982
6293
|
fdc3HandleOpen({ app, context }: {
|
|
5983
|
-
app: TargetApp | AppIdentifier;
|
|
6294
|
+
app: FDC3.v1.TargetApp | FDC3.v2.AppIdentifier;
|
|
5984
6295
|
context: OpenFin_2.Context;
|
|
5985
|
-
}, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | AppIdentifier>;
|
|
6296
|
+
}, clientIdentity: OpenFin_2.ClientIdentity): Promise<void | FDC3.v2.AppIdentifier>;
|
|
5986
6297
|
/**
|
|
5987
6298
|
* Responsible for resolving the fdc3.findInstances call.
|
|
5988
6299
|
* Must be overridden
|
|
5989
6300
|
* @param app AppIdentifier that was passed to fdc3.findInstances
|
|
5990
6301
|
* @param clientIdentity Identity of the Client making the request.
|
|
5991
6302
|
*/
|
|
5992
|
-
fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
6303
|
+
fdc3HandleFindInstances(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
5993
6304
|
/**
|
|
5994
6305
|
* Responsible for resolving the fdc3.getAppMetadata call.
|
|
5995
6306
|
* Must be overridden
|
|
5996
6307
|
* @param app AppIdentifier that was passed to fdc3.getAppMetadata
|
|
5997
6308
|
* @param clientIdentity Identity of the Client making the request.
|
|
5998
6309
|
*/
|
|
5999
|
-
fdc3HandleGetAppMetadata(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
6310
|
+
fdc3HandleGetAppMetadata(app: FDC3.v2.AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
|
|
6000
6311
|
/**
|
|
6001
6312
|
* This function is called by the Interop Broker whenever a Context handler would fire.
|
|
6002
6313
|
* For FDC3 2.0 you would need to override this function and add the contextMetadata as
|
|
@@ -7868,7 +8179,21 @@ declare type LayoutRow = LayoutItemConfig & {
|
|
|
7868
8179
|
*/
|
|
7869
8180
|
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'>;
|
|
7870
8181
|
|
|
7871
|
-
declare
|
|
8182
|
+
declare interface Listener {
|
|
8183
|
+
/**
|
|
8184
|
+
* Unsubscribe the listener object.
|
|
8185
|
+
*/
|
|
8186
|
+
unsubscribe(): void;
|
|
8187
|
+
}
|
|
8188
|
+
|
|
8189
|
+
declare interface Listener_2 {
|
|
8190
|
+
/**
|
|
8191
|
+
* Unsubscribe the listener object.
|
|
8192
|
+
*/
|
|
8193
|
+
unsubscribe(): void;
|
|
8194
|
+
}
|
|
8195
|
+
|
|
8196
|
+
declare type Listener_3<T extends {
|
|
7872
8197
|
type: string;
|
|
7873
8198
|
}> = (payload: T) => void;
|
|
7874
8199
|
|
|
@@ -8669,11 +8994,11 @@ declare namespace OpenFin_2 {
|
|
|
8669
8994
|
ApplicationOptions,
|
|
8670
8995
|
InteropBrokerOptions,
|
|
8671
8996
|
ContextGroupInfo,
|
|
8672
|
-
DisplayMetadata,
|
|
8997
|
+
DisplayMetadata_3 as DisplayMetadata,
|
|
8673
8998
|
LegacyWinOptionsInAppOptions,
|
|
8674
8999
|
Snapshot,
|
|
8675
9000
|
ContextGroupStates,
|
|
8676
|
-
Context,
|
|
9001
|
+
Context_3 as Context,
|
|
8677
9002
|
MonitorInfo,
|
|
8678
9003
|
Point,
|
|
8679
9004
|
PointTopLeft,
|
|
@@ -8842,10 +9167,10 @@ declare namespace OpenFin_2 {
|
|
|
8842
9167
|
FileDownloadBehaviorNames,
|
|
8843
9168
|
FileDownloadSettings,
|
|
8844
9169
|
DownloadRule,
|
|
8845
|
-
ContextHandler,
|
|
8846
|
-
Intent,
|
|
8847
|
-
IntentMetadata,
|
|
8848
|
-
IntentHandler,
|
|
9170
|
+
ContextHandler_3 as ContextHandler,
|
|
9171
|
+
Intent_2 as Intent,
|
|
9172
|
+
IntentMetadata_3 as IntentMetadata,
|
|
9173
|
+
IntentHandler_2 as IntentHandler,
|
|
8849
9174
|
ContentCreationBehaviorNames,
|
|
8850
9175
|
MatchPattern,
|
|
8851
9176
|
ContentCreationRule,
|
|
@@ -9004,7 +9329,7 @@ declare class Platform extends EmitterBase<OpenFin_2.PlatformEvent> {
|
|
|
9004
9329
|
/**
|
|
9005
9330
|
* @internal
|
|
9006
9331
|
*/
|
|
9007
|
-
constructor(identity: OpenFin_2.ApplicationIdentity, channel:
|
|
9332
|
+
constructor(identity: OpenFin_2.ApplicationIdentity, channel: Channel_5);
|
|
9008
9333
|
getClient: (identity?: OpenFin_2.ApplicationIdentity) => Promise<ChannelClient_2>;
|
|
9009
9334
|
/**
|
|
9010
9335
|
* Creates a new view and attaches it to a specified target window.
|
|
@@ -10761,6 +11086,14 @@ declare type PrintOptions = {
|
|
|
10761
11086
|
dpi?: Dpi;
|
|
10762
11087
|
};
|
|
10763
11088
|
|
|
11089
|
+
declare type PrivateChannel = Omit<Channel_4, 'addContextListener'> & {
|
|
11090
|
+
addContextListener(contextType: string | null, handler: ContextHandler_2): Promise<Listener_2>;
|
|
11091
|
+
onAddContextListener(handler: (contextType?: string) => void): Listener_2;
|
|
11092
|
+
onUnsubscribe(handler: (contextType?: string) => void): Listener_2;
|
|
11093
|
+
onDisconnect(handler: () => void): Listener_2;
|
|
11094
|
+
disconnect(): void;
|
|
11095
|
+
};
|
|
11096
|
+
|
|
10764
11097
|
/**
|
|
10765
11098
|
* Strategy to assign views to process affinity by domain.
|
|
10766
11099
|
*
|
|
@@ -11673,19 +12006,19 @@ declare type SessionContextGroup = {
|
|
|
11673
12006
|
* A SessionContextGroup instance method for setting a context in the SessionContextGroup.
|
|
11674
12007
|
* @param context The Context to be set.
|
|
11675
12008
|
*/
|
|
11676
|
-
setContext: (context:
|
|
12009
|
+
setContext: (context: Context_3) => Promise<void>;
|
|
11677
12010
|
/**
|
|
11678
12011
|
* A SessionContextGroup instance method for getting the current context of a certain type.
|
|
11679
12012
|
* @param type The Context Type to get. If not specified the last contextType set would get used.
|
|
11680
12013
|
*/
|
|
11681
|
-
getCurrentContext: (type?: string) => Promise<
|
|
12014
|
+
getCurrentContext: (type?: string) => Promise<Context_3>;
|
|
11682
12015
|
/**
|
|
11683
12016
|
* A SessionContextGroup instance method for adding a handler for context change.
|
|
11684
12017
|
* @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.
|
|
11685
12018
|
* @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.
|
|
11686
12019
|
*
|
|
11687
12020
|
*/
|
|
11688
|
-
addContextHandler: (handler:
|
|
12021
|
+
addContextHandler: (handler: ContextHandler_3, contextType?: string) => Promise<{
|
|
11689
12022
|
unsubscribe: () => void;
|
|
11690
12023
|
}>;
|
|
11691
12024
|
};
|
|
@@ -13438,6 +13771,12 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13438
13771
|
setDomainSettings(domainSettings: OpenFin_2.DefaultDomainSettings): Promise<void>;
|
|
13439
13772
|
}
|
|
13440
13773
|
|
|
13774
|
+
declare type SystemChannel = Omit<Channel_3, 'addContextListener' | 'broadcast' | 'getCurrentContext'> & {
|
|
13775
|
+
addContextListener(): Error;
|
|
13776
|
+
broadcast(): Error;
|
|
13777
|
+
getCurrentContext(): Error;
|
|
13778
|
+
};
|
|
13779
|
+
|
|
13441
13780
|
/**
|
|
13442
13781
|
* [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
|
|
13443
13782
|
* discriminated by {@link SystemEvent.type | their type}. Event payloads unique to `System` can be found
|
|
@@ -13967,13 +14306,13 @@ declare type tween = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'ease-i
|
|
|
13967
14306
|
declare interface TypedEventEmitter<Event extends {
|
|
13968
14307
|
type: string;
|
|
13969
14308
|
}, EmitterEventType = Event['type']> {
|
|
13970
|
-
on<EventType extends EmitterEventType>(event: EventType, listener:
|
|
14309
|
+
on<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
|
|
13971
14310
|
type: EventType;
|
|
13972
14311
|
}>>): this;
|
|
13973
|
-
addListener<EventType extends EmitterEventType>(event: EventType, listener:
|
|
14312
|
+
addListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
|
|
13974
14313
|
type: EventType;
|
|
13975
14314
|
}>>): this;
|
|
13976
|
-
removeListener<EventType extends EmitterEventType>(event: EventType, listener:
|
|
14315
|
+
removeListener<EventType extends EmitterEventType>(event: EventType, listener: Listener_3<Extract<Event, {
|
|
13977
14316
|
type: EventType;
|
|
13978
14317
|
}>>): this;
|
|
13979
14318
|
removeAllListeners<EventType extends EmitterEventType>(event?: EmitterEventType): this;
|
|
@@ -14044,6 +14383,48 @@ declare type UserMovementEnabledEvent = NamedEvent & {
|
|
|
14044
14383
|
type: 'user-movement-enabled';
|
|
14045
14384
|
};
|
|
14046
14385
|
|
|
14386
|
+
declare namespace v1 {
|
|
14387
|
+
export {
|
|
14388
|
+
Listener,
|
|
14389
|
+
AppMetadata,
|
|
14390
|
+
IntentMetadata,
|
|
14391
|
+
AppIntent,
|
|
14392
|
+
DisplayMetadata,
|
|
14393
|
+
ImplementationMetadata,
|
|
14394
|
+
ContextHandler,
|
|
14395
|
+
TargetApp,
|
|
14396
|
+
Context,
|
|
14397
|
+
IntentResolution,
|
|
14398
|
+
Channel_3 as Channel,
|
|
14399
|
+
SystemChannel,
|
|
14400
|
+
DesktopAgent
|
|
14401
|
+
}
|
|
14402
|
+
}
|
|
14403
|
+
|
|
14404
|
+
declare namespace v2 {
|
|
14405
|
+
export {
|
|
14406
|
+
IntentMetadata_2 as IntentMetadata,
|
|
14407
|
+
AppIdentifier,
|
|
14408
|
+
Listener_2 as Listener,
|
|
14409
|
+
AppIntent_2 as AppIntent,
|
|
14410
|
+
ImplementationMetadata_2 as ImplementationMetadata,
|
|
14411
|
+
ContextMetadata,
|
|
14412
|
+
Icon,
|
|
14413
|
+
Image_2 as Image,
|
|
14414
|
+
AppMetadata_2 as AppMetadata,
|
|
14415
|
+
DisplayMetadata_2 as DisplayMetadata,
|
|
14416
|
+
ContextHandler_2 as ContextHandler,
|
|
14417
|
+
IntentHandler,
|
|
14418
|
+
IntentResult,
|
|
14419
|
+
Context_2 as Context,
|
|
14420
|
+
Intent,
|
|
14421
|
+
IntentResolution_2 as IntentResolution,
|
|
14422
|
+
Channel_4 as Channel,
|
|
14423
|
+
PrivateChannel,
|
|
14424
|
+
DesktopAgent_2 as DesktopAgent
|
|
14425
|
+
}
|
|
14426
|
+
}
|
|
14427
|
+
|
|
14047
14428
|
declare type View = OpenFin_2.View;
|
|
14048
14429
|
|
|
14049
14430
|
/**
|