@openfin/core 25.68.30 → 25.70.2
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/OpenFin.d.ts +30 -826
- package/README.md +12 -2
- package/package.json +1 -1
- package/src/api/application/Factory.d.ts +145 -145
- package/src/api/application/Factory.js +229 -229
- package/src/api/application/Instance.d.ts +301 -302
- package/src/api/application/Instance.js +412 -412
- package/src/api/application/index.d.ts +3 -3
- package/src/api/application/index.js +15 -15
- package/src/api/base.d.ts +43 -43
- package/src/api/base.js +177 -177
- package/src/api/clipboard/index.d.ts +69 -69
- package/src/api/clipboard/index.js +88 -88
- package/src/api/events/application.d.ts +69 -0
- package/src/api/events/application.js +2 -0
- package/src/api/events/base.d.ts +17 -0
- package/src/api/events/base.js +2 -0
- package/src/api/events/channel.d.ts +10 -11
- package/src/api/events/channel.js +2 -2
- package/src/api/events/emitterMap.d.ts +11 -11
- package/src/api/events/emitterMap.js +35 -35
- package/src/api/events/eventAggregator.d.ts +5 -5
- package/src/api/events/eventAggregator.js +43 -43
- package/src/api/events/externalApplication.d.ts +5 -0
- package/src/api/events/externalApplication.js +2 -0
- package/src/api/events/frame.d.ts +9 -0
- package/src/api/events/frame.js +2 -0
- package/src/api/events/globalHotkey.d.ts +10 -0
- package/src/api/events/globalHotkey.js +2 -0
- package/src/api/events/platform.d.ts +18 -0
- package/src/api/events/platform.js +2 -0
- package/src/api/events/system.d.ts +22 -0
- package/src/api/events/system.js +2 -0
- package/src/api/events/view.d.ts +56 -0
- package/src/api/events/view.js +2 -0
- package/src/api/events/webcontents.d.ts +48 -0
- package/src/api/events/webcontents.js +2 -0
- package/src/api/events/window.d.ts +176 -0
- package/src/api/events/window.js +2 -0
- package/src/api/external-application/Factory.d.ts +26 -26
- package/src/api/external-application/Factory.js +40 -40
- package/src/api/external-application/Instance.d.ts +101 -102
- package/src/api/external-application/Instance.js +109 -109
- package/src/api/external-application/index.d.ts +3 -3
- package/src/api/external-application/index.js +15 -15
- package/src/api/fin.d.ts +49 -49
- package/src/api/fin.js +43 -43
- package/src/api/frame/Factory.d.ts +36 -36
- package/src/api/frame/Factory.js +69 -69
- package/src/api/frame/Instance.d.ts +121 -121
- package/src/api/frame/Instance.js +130 -130
- package/src/api/frame/index.d.ts +3 -3
- package/src/api/frame/index.js +15 -15
- package/src/api/global-hotkey/index.d.ts +38 -38
- package/src/api/global-hotkey/index.js +58 -58
- package/src/api/interappbus/channel/channel.d.ts +26 -26
- package/src/api/interappbus/channel/channel.js +77 -77
- package/src/api/interappbus/channel/channels-docs.d.ts +318 -318
- package/src/api/interappbus/channel/channels-docs.js +376 -376
- package/src/api/interappbus/channel/client.d.ts +22 -22
- package/src/api/interappbus/channel/client.js +84 -84
- package/src/api/interappbus/channel/connection-manager.d.ts +28 -28
- package/src/api/interappbus/channel/connection-manager.js +244 -244
- package/src/api/interappbus/channel/index.d.ts +22 -23
- package/src/api/interappbus/channel/index.js +121 -121
- package/src/api/interappbus/channel/protocols/classic/message-receiver.d.ts +13 -13
- package/src/api/interappbus/channel/protocols/classic/message-receiver.js +73 -73
- package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +22 -22
- package/src/api/interappbus/channel/protocols/classic/strategy.js +84 -84
- package/src/api/interappbus/channel/protocols/combined/strategy.d.ts +20 -20
- package/src/api/interappbus/channel/protocols/combined/strategy.js +58 -58
- package/src/api/interappbus/channel/protocols/index.d.ts +44 -44
- package/src/api/interappbus/channel/protocols/index.js +2 -2
- package/src/api/interappbus/channel/protocols/protocol-manager.d.ts +10 -10
- package/src/api/interappbus/channel/protocols/protocol-manager.js +43 -43
- package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts +23 -23
- package/src/api/interappbus/channel/protocols/rtc/endpoint.js +135 -135
- package/src/api/interappbus/channel/protocols/rtc/ice-manager.d.ts +30 -30
- package/src/api/interappbus/channel/protocols/rtc/ice-manager.js +131 -131
- package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts +22 -22
- package/src/api/interappbus/channel/protocols/rtc/strategy.js +87 -87
- package/src/api/interappbus/channel/protocols/strategy-types.d.ts +13 -13
- package/src/api/interappbus/channel/protocols/strategy-types.js +2 -2
- package/src/api/interappbus/channel/protocols/strategy.d.ts +15 -15
- package/src/api/interappbus/channel/protocols/strategy.js +2 -2
- package/src/api/interappbus/channel/provider.d.ts +31 -31
- package/src/api/interappbus/channel/provider.js +160 -160
- package/src/api/interappbus/index.d.ts +85 -86
- package/src/api/interappbus/index.js +175 -175
- package/src/api/interop/Factory.d.ts +37 -37
- package/src/api/interop/Factory.js +54 -54
- package/src/api/interop/InteropBroker.d.ts +363 -363
- package/src/api/interop/InteropBroker.js +914 -914
- package/src/api/interop/InteropClient.d.ts +268 -268
- package/src/api/interop/InteropClient.js +450 -450
- package/src/api/interop/SessionContextGroupBroker.d.ts +26 -26
- package/src/api/interop/SessionContextGroupBroker.js +107 -107
- package/src/api/interop/SessionContextGroupClient.d.ts +20 -20
- package/src/api/interop/SessionContextGroupClient.js +85 -85
- package/src/api/interop/fdc3/fdc3-1.2.d.ts +187 -187
- package/src/api/interop/fdc3/fdc3-1.2.js +385 -385
- package/src/api/interop/fdc3/fdc3.js +17 -17
- package/src/api/interop/fdc3/utils.d.ts +6 -6
- package/src/api/interop/fdc3/utils.js +17 -17
- package/src/api/interop/index.d.ts +4 -4
- package/src/api/interop/index.js +16 -16
- package/src/api/interop/utils.d.ts +11 -11
- package/src/api/interop/utils.js +36 -36
- package/src/api/me.d.ts +38 -35
- package/src/api/me.js +128 -60
- package/src/api/platform/Factory.d.ts +109 -109
- package/src/api/platform/Factory.js +188 -188
- package/src/api/platform/Instance.d.ts +122 -122
- package/src/api/platform/Instance.js +298 -298
- package/src/api/platform/common-utils.d.ts +6 -6
- package/src/api/platform/common-utils.js +16 -16
- package/src/api/platform/index.d.ts +3 -3
- package/src/api/platform/index.js +15 -15
- package/src/api/platform/layout/Factory.d.ts +108 -108
- package/src/api/platform/layout/Factory.js +189 -189
- package/src/api/platform/layout/Instance.d.ts +49 -49
- package/src/api/platform/layout/Instance.js +99 -99
- package/src/api/platform/layout/index.d.ts +2 -2
- package/src/api/platform/layout/index.js +14 -14
- package/src/api/platform/layout/shapes.d.ts +11 -0
- package/src/api/{window → platform/layout}/shapes.js +2 -2
- package/src/api/snapshot-source/Factory.d.ts +36 -36
- package/src/api/snapshot-source/Factory.js +65 -65
- package/src/api/snapshot-source/Instance.d.ts +30 -30
- package/src/api/snapshot-source/Instance.js +134 -134
- package/src/api/snapshot-source/index.d.ts +3 -3
- package/src/api/snapshot-source/index.js +15 -15
- package/src/api/snapshot-source/utils.d.ts +1 -1
- package/src/api/snapshot-source/utils.js +5 -5
- package/src/api/system/index.d.ts +960 -961
- package/src/api/system/index.js +1241 -1241
- package/src/api/view/Factory.d.ts +49 -49
- package/src/api/view/Factory.js +103 -103
- package/src/api/view/Instance.d.ts +387 -380
- package/src/api/view/Instance.js +422 -415
- package/src/api/view/index.d.ts +3 -3
- package/src/api/view/index.js +15 -15
- package/src/api/webcontents/main.d.ts +36 -36
- package/src/api/webcontents/main.js +82 -82
- package/src/api/window/Factory.d.ts +44 -44
- package/src/api/window/Factory.js +91 -91
- package/src/api/window/Instance.d.ts +972 -966
- package/src/api/window/Instance.js +1209 -1202
- package/src/api/window/index.d.ts +3 -5
- package/src/api/window/index.js +15 -17
- package/src/environment/environment.d.ts +28 -25
- package/src/environment/environment.js +4 -4
- package/src/environment/node-env.d.ts +25 -26
- package/src/environment/node-env.js +64 -64
- package/src/environment/openfin-env.d.ts +29 -30
- package/src/environment/openfin-env.js +107 -107
- package/src/mock.d.ts +3 -3
- package/src/mock.js +91 -90
- package/src/shapes/ERROR_BOX_TYPES.d.ts +1 -0
- package/src/shapes/ERROR_BOX_TYPES.js +2 -0
- package/src/shapes/WebOptions.d.ts +12 -0
- package/src/shapes/WebOptions.js +2 -0
- package/src/shapes/WindowOptions.d.ts +42 -0
- package/src/shapes/WindowOptions.js +2 -0
- package/src/shapes/protocol.d.ts +178 -0
- package/src/shapes/protocol.js +2 -0
- package/src/transport/fin_store.d.ts +4 -4
- package/src/transport/fin_store.js +16 -16
- package/src/transport/transport-errors.d.ts +18 -18
- package/src/transport/transport-errors.js +37 -37
- package/src/transport/transport.d.ts +56 -43
- package/src/transport/transport.js +181 -181
- package/src/transport/wire.d.ts +71 -11
- package/src/transport/wire.js +32 -32
- package/src/util/asyncFilter.d.ts +1 -1
- package/src/util/asyncFilter.js +7 -7
- package/src/util/errors.d.ts +9 -5
- package/src/util/errors.js +11 -11
- package/src/util/exhaustive.d.ts +1 -1
- package/src/util/exhaustive.js +7 -7
- package/src/util/http.d.ts +11 -11
- package/src/util/http.js +83 -83
- package/src/util/normalize-config.d.ts +3 -5
- package/src/util/normalize-config.js +47 -47
- package/src/util/promises.d.ts +5 -5
- package/src/util/promises.js +27 -27
- package/src/util/ref-counter.d.ts +7 -7
- package/src/util/ref-counter.js +51 -51
- package/src/util/runtimeVersioning.d.ts +3 -3
- package/src/util/runtimeVersioning.js +25 -25
- package/src/util/utilTypes.d.ts +8 -8
- package/src/util/utilTypes.js +2 -2
- package/src/util/validate.d.ts +3 -3
- package/src/util/validate.js +11 -11
- package/docs.README(OLD).md +0 -82
- package/resources/win/OpenFinRVM.exe +0 -0
- package/src/api/window/bounds-changed.d.ts +0 -10
- package/src/api/window/bounds-changed.js +0 -6
- package/src/api/window/shapes.d.ts +0 -13
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
import Transport from '../../../transport/transport';
|
|
2
|
-
import { Base } from '../../base';
|
|
3
|
-
import Identity = OpenFin.Identity;
|
|
4
|
-
import InitLayoutOptions = OpenFin.InitLayoutOptions;
|
|
5
|
-
import PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
|
6
|
-
/**
|
|
7
|
-
* @lends Platform#Layout
|
|
8
|
-
*/
|
|
9
|
-
export declare class Layout extends Base {
|
|
10
|
-
init: (options?: InitLayoutOptions) => Promise<Layout>;
|
|
11
|
-
identity: Identity;
|
|
12
|
-
private platform;
|
|
13
|
-
wire: Transport;
|
|
14
|
-
constructor(identity: OpenFin.Identity, wire: Transport);
|
|
15
|
-
/**
|
|
16
|
-
* Returns the configuration of the window's layout. Returns the same information that is returned for all windows in getSnapshot.
|
|
17
|
-
* @return { Promise<LayoutConfig> }
|
|
18
|
-
* @tutorial Layout.getConfig
|
|
19
|
-
*/
|
|
20
|
-
getConfig(): Promise<any>;
|
|
21
|
-
/**
|
|
22
|
-
* Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout
|
|
23
|
-
* will be destroyed.
|
|
24
|
-
* @param { LayoutConfig } layout New layout to implement in the target window.
|
|
25
|
-
* Please see explanation of a layout {@link https://developers.openfin.co/docs/platform-api#section-layout here}.
|
|
26
|
-
* @return { Promise<void> }
|
|
27
|
-
* @tutorial Layout.replace
|
|
28
|
-
*/
|
|
29
|
-
replace: (layout: any) => Promise<void>;
|
|
30
|
-
/**
|
|
31
|
-
* Replaces the specified view with a view with the provided configuration.
|
|
32
|
-
* The old view is stripped of its listeners and either closed or attached to the provider window
|
|
33
|
-
* depending on `detachOnClose` view option.
|
|
34
|
-
* @param { Identity } viewToReplace Identity of the view to be replaced
|
|
35
|
-
* @param { View~options } newView Creation options of the new view.
|
|
36
|
-
* @return { Promise<void> }
|
|
37
|
-
* @tutorial Layout.replaceView
|
|
38
|
-
*/
|
|
39
|
-
replaceView: (viewToReplace: Identity, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
40
|
-
/**
|
|
41
|
-
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
42
|
-
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
43
|
-
* @param { PresetLayoutOptions } options Mandatory object with `presetType` property that sets which preset layout arrangement to use.
|
|
44
|
-
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
45
|
-
* @return { Promise<void> }
|
|
46
|
-
* @tutorial Layout.applyPreset
|
|
47
|
-
*/
|
|
48
|
-
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
49
|
-
}
|
|
1
|
+
import Transport from '../../../transport/transport';
|
|
2
|
+
import { Base } from '../../base';
|
|
3
|
+
import Identity = OpenFin.Identity;
|
|
4
|
+
import InitLayoutOptions = OpenFin.InitLayoutOptions;
|
|
5
|
+
import PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
|
6
|
+
/**
|
|
7
|
+
* @lends Platform#Layout
|
|
8
|
+
*/
|
|
9
|
+
export declare class Layout extends Base {
|
|
10
|
+
init: (options?: InitLayoutOptions) => Promise<Layout>;
|
|
11
|
+
identity: Identity;
|
|
12
|
+
private platform;
|
|
13
|
+
wire: Transport;
|
|
14
|
+
constructor(identity: OpenFin.Identity, wire: Transport);
|
|
15
|
+
/**
|
|
16
|
+
* Returns the configuration of the window's layout. Returns the same information that is returned for all windows in getSnapshot.
|
|
17
|
+
* @return { Promise<LayoutConfig> }
|
|
18
|
+
* @tutorial Layout.getConfig
|
|
19
|
+
*/
|
|
20
|
+
getConfig(): Promise<any>;
|
|
21
|
+
/**
|
|
22
|
+
* Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout
|
|
23
|
+
* will be destroyed.
|
|
24
|
+
* @param { LayoutConfig } layout New layout to implement in the target window.
|
|
25
|
+
* Please see explanation of a layout {@link https://developers.openfin.co/docs/platform-api#section-layout here}.
|
|
26
|
+
* @return { Promise<void> }
|
|
27
|
+
* @tutorial Layout.replace
|
|
28
|
+
*/
|
|
29
|
+
replace: (layout: any) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* Replaces the specified view with a view with the provided configuration.
|
|
32
|
+
* The old view is stripped of its listeners and either closed or attached to the provider window
|
|
33
|
+
* depending on `detachOnClose` view option.
|
|
34
|
+
* @param { Identity } viewToReplace Identity of the view to be replaced
|
|
35
|
+
* @param { View~options } newView Creation options of the new view.
|
|
36
|
+
* @return { Promise<void> }
|
|
37
|
+
* @tutorial Layout.replaceView
|
|
38
|
+
*/
|
|
39
|
+
replaceView: (viewToReplace: Identity, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
42
|
+
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
43
|
+
* @param { PresetLayoutOptions } options Mandatory object with `presetType` property that sets which preset layout arrangement to use.
|
|
44
|
+
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
45
|
+
* @return { Promise<void> }
|
|
46
|
+
* @tutorial Layout.applyPreset
|
|
47
|
+
*/
|
|
48
|
+
applyPreset: (options: PresetLayoutOptions) => Promise<void>;
|
|
49
|
+
}
|
|
@@ -1,99 +1,99 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/* eslint-disable no-undef, import/prefer-default-export */
|
|
3
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Layout = void 0;
|
|
5
|
-
const validate_1 = require("../../../util/validate");
|
|
6
|
-
const common_utils_1 = require("../common-utils");
|
|
7
|
-
const base_1 = require("../../base");
|
|
8
|
-
/**
|
|
9
|
-
* @lends Platform#Layout
|
|
10
|
-
*/
|
|
11
|
-
class Layout extends base_1.Base {
|
|
12
|
-
// eslint-disable-next-line no-shadow
|
|
13
|
-
constructor(identity, wire) {
|
|
14
|
-
super(wire);
|
|
15
|
-
/**
|
|
16
|
-
* Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout
|
|
17
|
-
* will be destroyed.
|
|
18
|
-
* @param { LayoutConfig } layout New layout to implement in the target window.
|
|
19
|
-
* Please see explanation of a layout {@link https://developers.openfin.co/docs/platform-api#section-layout here}.
|
|
20
|
-
* @return { Promise<void> }
|
|
21
|
-
* @tutorial Layout.replace
|
|
22
|
-
*/
|
|
23
|
-
this.replace = async (layout) => {
|
|
24
|
-
this.wire.sendAction('layout-replace').catch((e) => {
|
|
25
|
-
// don't expose
|
|
26
|
-
});
|
|
27
|
-
const client = await this.platform.getClient();
|
|
28
|
-
await client.dispatch('replace-layout', {
|
|
29
|
-
target: this.identity,
|
|
30
|
-
opts: { layout }
|
|
31
|
-
});
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* Replaces the specified view with a view with the provided configuration.
|
|
35
|
-
* The old view is stripped of its listeners and either closed or attached to the provider window
|
|
36
|
-
* depending on `detachOnClose` view option.
|
|
37
|
-
* @param { Identity } viewToReplace Identity of the view to be replaced
|
|
38
|
-
* @param { View~options } newView Creation options of the new view.
|
|
39
|
-
* @return { Promise<void> }
|
|
40
|
-
* @tutorial Layout.replaceView
|
|
41
|
-
*/
|
|
42
|
-
this.replaceView = async (viewToReplace, newView) => {
|
|
43
|
-
this.wire.sendAction('layout-replace-view').catch((e) => {
|
|
44
|
-
// don't expose
|
|
45
|
-
});
|
|
46
|
-
const client = await this.platform.getClient();
|
|
47
|
-
await client.dispatch('replace-view', {
|
|
48
|
-
target: this.identity,
|
|
49
|
-
opts: { viewToReplace, newView }
|
|
50
|
-
});
|
|
51
|
-
};
|
|
52
|
-
/**
|
|
53
|
-
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
54
|
-
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
55
|
-
* @param { PresetLayoutOptions } options Mandatory object with `presetType` property that sets which preset layout arrangement to use.
|
|
56
|
-
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
57
|
-
* @return { Promise<void> }
|
|
58
|
-
* @tutorial Layout.applyPreset
|
|
59
|
-
*/
|
|
60
|
-
this.applyPreset = async (options) => {
|
|
61
|
-
this.wire.sendAction('layout-apply-preset').catch((e) => {
|
|
62
|
-
// don't expose
|
|
63
|
-
});
|
|
64
|
-
const client = await this.platform.getClient();
|
|
65
|
-
const { presetType } = options;
|
|
66
|
-
if (!presetType || !common_utils_1.isValidPresetType(presetType)) {
|
|
67
|
-
throw new Error('Cannot apply preset layout, please include an applicable presetType property in the PresetLayoutOptions.');
|
|
68
|
-
}
|
|
69
|
-
await client.dispatch('apply-preset-layout', {
|
|
70
|
-
target: this.identity,
|
|
71
|
-
opts: { presetType }
|
|
72
|
-
});
|
|
73
|
-
};
|
|
74
|
-
const errorMsg = validate_1.validateIdentity(identity);
|
|
75
|
-
if (errorMsg) {
|
|
76
|
-
throw new Error(errorMsg);
|
|
77
|
-
}
|
|
78
|
-
this.identity = identity;
|
|
79
|
-
this.platform = this.fin.Platform.wrapSync({ uuid: identity.uuid });
|
|
80
|
-
if (identity.uuid === this.fin.me.uuid && identity.name === this.fin.me.name) {
|
|
81
|
-
this.init = this.fin.Platform.Layout.init;
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* Returns the configuration of the window's layout. Returns the same information that is returned for all windows in getSnapshot.
|
|
86
|
-
* @return { Promise<LayoutConfig> }
|
|
87
|
-
* @tutorial Layout.getConfig
|
|
88
|
-
*/
|
|
89
|
-
async getConfig() {
|
|
90
|
-
this.wire.sendAction('layout-get-config').catch((e) => {
|
|
91
|
-
// don't expose
|
|
92
|
-
});
|
|
93
|
-
const client = await this.platform.getClient();
|
|
94
|
-
return client.dispatch('get-frame-snapshot', {
|
|
95
|
-
target: this.identity
|
|
96
|
-
});
|
|
97
|
-
}
|
|
98
|
-
}
|
|
99
|
-
exports.Layout = Layout;
|
|
1
|
+
"use strict";
|
|
2
|
+
/* eslint-disable no-undef, import/prefer-default-export */
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Layout = void 0;
|
|
5
|
+
const validate_1 = require("../../../util/validate");
|
|
6
|
+
const common_utils_1 = require("../common-utils");
|
|
7
|
+
const base_1 = require("../../base");
|
|
8
|
+
/**
|
|
9
|
+
* @lends Platform#Layout
|
|
10
|
+
*/
|
|
11
|
+
class Layout extends base_1.Base {
|
|
12
|
+
// eslint-disable-next-line no-shadow
|
|
13
|
+
constructor(identity, wire) {
|
|
14
|
+
super(wire);
|
|
15
|
+
/**
|
|
16
|
+
* Replaces a Platform window's layout with a new layout. Any views that were in the old layout but not the new layout
|
|
17
|
+
* will be destroyed.
|
|
18
|
+
* @param { LayoutConfig } layout New layout to implement in the target window.
|
|
19
|
+
* Please see explanation of a layout {@link https://developers.openfin.co/docs/platform-api#section-layout here}.
|
|
20
|
+
* @return { Promise<void> }
|
|
21
|
+
* @tutorial Layout.replace
|
|
22
|
+
*/
|
|
23
|
+
this.replace = async (layout) => {
|
|
24
|
+
this.wire.sendAction('layout-replace').catch((e) => {
|
|
25
|
+
// don't expose
|
|
26
|
+
});
|
|
27
|
+
const client = await this.platform.getClient();
|
|
28
|
+
await client.dispatch('replace-layout', {
|
|
29
|
+
target: this.identity,
|
|
30
|
+
opts: { layout }
|
|
31
|
+
});
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Replaces the specified view with a view with the provided configuration.
|
|
35
|
+
* The old view is stripped of its listeners and either closed or attached to the provider window
|
|
36
|
+
* depending on `detachOnClose` view option.
|
|
37
|
+
* @param { Identity } viewToReplace Identity of the view to be replaced
|
|
38
|
+
* @param { View~options } newView Creation options of the new view.
|
|
39
|
+
* @return { Promise<void> }
|
|
40
|
+
* @tutorial Layout.replaceView
|
|
41
|
+
*/
|
|
42
|
+
this.replaceView = async (viewToReplace, newView) => {
|
|
43
|
+
this.wire.sendAction('layout-replace-view').catch((e) => {
|
|
44
|
+
// don't expose
|
|
45
|
+
});
|
|
46
|
+
const client = await this.platform.getClient();
|
|
47
|
+
await client.dispatch('replace-view', {
|
|
48
|
+
target: this.identity,
|
|
49
|
+
opts: { viewToReplace, newView }
|
|
50
|
+
});
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
54
|
+
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
55
|
+
* @param { PresetLayoutOptions } options Mandatory object with `presetType` property that sets which preset layout arrangement to use.
|
|
56
|
+
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
57
|
+
* @return { Promise<void> }
|
|
58
|
+
* @tutorial Layout.applyPreset
|
|
59
|
+
*/
|
|
60
|
+
this.applyPreset = async (options) => {
|
|
61
|
+
this.wire.sendAction('layout-apply-preset').catch((e) => {
|
|
62
|
+
// don't expose
|
|
63
|
+
});
|
|
64
|
+
const client = await this.platform.getClient();
|
|
65
|
+
const { presetType } = options;
|
|
66
|
+
if (!presetType || !common_utils_1.isValidPresetType(presetType)) {
|
|
67
|
+
throw new Error('Cannot apply preset layout, please include an applicable presetType property in the PresetLayoutOptions.');
|
|
68
|
+
}
|
|
69
|
+
await client.dispatch('apply-preset-layout', {
|
|
70
|
+
target: this.identity,
|
|
71
|
+
opts: { presetType }
|
|
72
|
+
});
|
|
73
|
+
};
|
|
74
|
+
const errorMsg = validate_1.validateIdentity(identity);
|
|
75
|
+
if (errorMsg) {
|
|
76
|
+
throw new Error(errorMsg);
|
|
77
|
+
}
|
|
78
|
+
this.identity = identity;
|
|
79
|
+
this.platform = this.fin.Platform.wrapSync({ uuid: identity.uuid });
|
|
80
|
+
if (identity.uuid === this.fin.me.uuid && identity.name === this.fin.me.name) {
|
|
81
|
+
this.init = this.fin.Platform.Layout.init;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Returns the configuration of the window's layout. Returns the same information that is returned for all windows in getSnapshot.
|
|
86
|
+
* @return { Promise<LayoutConfig> }
|
|
87
|
+
* @tutorial Layout.getConfig
|
|
88
|
+
*/
|
|
89
|
+
async getConfig() {
|
|
90
|
+
this.wire.sendAction('layout-get-config').catch((e) => {
|
|
91
|
+
// don't expose
|
|
92
|
+
});
|
|
93
|
+
const client = await this.platform.getClient();
|
|
94
|
+
return client.dispatch('get-frame-snapshot', {
|
|
95
|
+
target: this.identity
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
exports.Layout = Layout;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './Factory';
|
|
2
|
-
export * from './Instance';
|
|
1
|
+
export * from './Factory';
|
|
2
|
+
export * from './Instance';
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
5
|
-
}) : (function(o, m, k, k2) {
|
|
6
|
-
if (k2 === undefined) k2 = k;
|
|
7
|
-
o[k2] = m[k];
|
|
8
|
-
}));
|
|
9
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
10
|
-
for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
|
|
11
|
-
}
|
|
12
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
-
__exportStar(require("./Factory"), exports);
|
|
14
|
-
__exportStar(require("./Instance"), exports);
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
5
|
+
}) : (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
o[k2] = m[k];
|
|
8
|
+
}));
|
|
9
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
10
|
+
for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
|
|
11
|
+
}
|
|
12
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
__exportStar(require("./Factory"), exports);
|
|
14
|
+
__exportStar(require("./Instance"), exports);
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import LayoutPresetType = OpenFin.LayoutPresetType;
|
|
2
|
+
export interface InitLayoutOptions {
|
|
3
|
+
containerId?: string;
|
|
4
|
+
}
|
|
5
|
+
export interface PresetLayoutOptions {
|
|
6
|
+
presetType: LayoutPresetType;
|
|
7
|
+
}
|
|
8
|
+
export interface DragPayload {
|
|
9
|
+
'view-config': OpenFin.ViewCreationOptions;
|
|
10
|
+
'view-identity': [string, string, string];
|
|
11
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
import { Base } from '../base';
|
|
2
|
-
import { SnapshotSource } from './Instance';
|
|
3
|
-
/**
|
|
4
|
-
* @typedef { object } SnapshotProvider
|
|
5
|
-
* @property {getSnapshot} [getSnapshot]
|
|
6
|
-
* @property {applySnapshot} [applySnapshot]
|
|
7
|
-
*/
|
|
8
|
-
/**
|
|
9
|
-
* @lends SnapshotSource
|
|
10
|
-
*/
|
|
11
|
-
export default class SnapshotSourceModule extends Base {
|
|
12
|
-
/**
|
|
13
|
-
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
|
14
|
-
* @param { SnapshotProvider } provider
|
|
15
|
-
* @return { Promise<void> }
|
|
16
|
-
* @tutorial SnapshotSource.init
|
|
17
|
-
* @static
|
|
18
|
-
*/
|
|
19
|
-
init<T = any>(provider: OpenFin.SnapshotProvider<T>): Promise<void>;
|
|
20
|
-
/**
|
|
21
|
-
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
22
|
-
* @param { Identity } identity
|
|
23
|
-
* @return { SnapshotSource }
|
|
24
|
-
* @tutorial SnapshotSource.wrapSync
|
|
25
|
-
* @static
|
|
26
|
-
*/
|
|
27
|
-
wrapSync(identity: OpenFin.ApplicationIdentity): SnapshotSource;
|
|
28
|
-
/**
|
|
29
|
-
* Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
30
|
-
* @param { Identity } identity
|
|
31
|
-
* @return { Promise.<SnapshotSource> }
|
|
32
|
-
* @tutorial SnapshotSource.wrap
|
|
33
|
-
* @static
|
|
34
|
-
*/
|
|
35
|
-
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
36
|
-
}
|
|
1
|
+
import { Base } from '../base';
|
|
2
|
+
import { SnapshotSource } from './Instance';
|
|
3
|
+
/**
|
|
4
|
+
* @typedef { object } SnapshotProvider
|
|
5
|
+
* @property {getSnapshot} [getSnapshot]
|
|
6
|
+
* @property {applySnapshot} [applySnapshot]
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* @lends SnapshotSource
|
|
10
|
+
*/
|
|
11
|
+
export default class SnapshotSourceModule extends Base {
|
|
12
|
+
/**
|
|
13
|
+
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
|
14
|
+
* @param { SnapshotProvider } provider
|
|
15
|
+
* @return { Promise<void> }
|
|
16
|
+
* @tutorial SnapshotSource.init
|
|
17
|
+
* @static
|
|
18
|
+
*/
|
|
19
|
+
init<T = any>(provider: OpenFin.SnapshotProvider<T>): Promise<void>;
|
|
20
|
+
/**
|
|
21
|
+
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
22
|
+
* @param { Identity } identity
|
|
23
|
+
* @return { SnapshotSource }
|
|
24
|
+
* @tutorial SnapshotSource.wrapSync
|
|
25
|
+
* @static
|
|
26
|
+
*/
|
|
27
|
+
wrapSync(identity: OpenFin.ApplicationIdentity): SnapshotSource;
|
|
28
|
+
/**
|
|
29
|
+
* Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
30
|
+
* @param { Identity } identity
|
|
31
|
+
* @return { Promise.<SnapshotSource> }
|
|
32
|
+
* @tutorial SnapshotSource.wrap
|
|
33
|
+
* @static
|
|
34
|
+
*/
|
|
35
|
+
wrap(identity: OpenFin.ApplicationIdentity): Promise<SnapshotSource>;
|
|
36
|
+
}
|
|
@@ -1,65 +1,65 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const base_1 = require("../base");
|
|
4
|
-
const Instance_1 = require("./Instance");
|
|
5
|
-
const utils_1 = require("./utils");
|
|
6
|
-
/**
|
|
7
|
-
* @typedef { object } SnapshotProvider
|
|
8
|
-
* @property {getSnapshot} [getSnapshot]
|
|
9
|
-
* @property {applySnapshot} [applySnapshot]
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* @lends SnapshotSource
|
|
13
|
-
*/
|
|
14
|
-
class SnapshotSourceModule extends base_1.Base {
|
|
15
|
-
/**
|
|
16
|
-
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
|
17
|
-
* @param { SnapshotProvider } provider
|
|
18
|
-
* @return { Promise<void> }
|
|
19
|
-
* @tutorial SnapshotSource.init
|
|
20
|
-
* @static
|
|
21
|
-
*/
|
|
22
|
-
async init(provider) {
|
|
23
|
-
this.wire.sendAction('snapshot-source-init').catch((e) => {
|
|
24
|
-
// don't expose, analytics-only call
|
|
25
|
-
});
|
|
26
|
-
if (typeof provider !== 'object' ||
|
|
27
|
-
typeof provider.getSnapshot !== 'function' ||
|
|
28
|
-
typeof provider.applySnapshot !== 'function') {
|
|
29
|
-
throw new Error('you must pass in a valid SnapshotProvider');
|
|
30
|
-
}
|
|
31
|
-
const channel = await this.fin.InterApplicationBus.Channel.create(utils_1.getSnapshotSourceChannelName(fin.me.identity));
|
|
32
|
-
channel.register('get-snapshot', async () => {
|
|
33
|
-
const snapshot = await provider.getSnapshot();
|
|
34
|
-
return { snapshot };
|
|
35
|
-
});
|
|
36
|
-
channel.register('apply-snapshot', ({ snapshot }) => provider.applySnapshot(snapshot));
|
|
37
|
-
}
|
|
38
|
-
/**
|
|
39
|
-
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
40
|
-
* @param { Identity } identity
|
|
41
|
-
* @return { SnapshotSource }
|
|
42
|
-
* @tutorial SnapshotSource.wrapSync
|
|
43
|
-
* @static
|
|
44
|
-
*/
|
|
45
|
-
wrapSync(identity) {
|
|
46
|
-
this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
|
|
47
|
-
// don't expose, analytics-only call
|
|
48
|
-
});
|
|
49
|
-
return new Instance_1.SnapshotSource(this.wire, identity);
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
53
|
-
* @param { Identity } identity
|
|
54
|
-
* @return { Promise.<SnapshotSource> }
|
|
55
|
-
* @tutorial SnapshotSource.wrap
|
|
56
|
-
* @static
|
|
57
|
-
*/
|
|
58
|
-
async wrap(identity) {
|
|
59
|
-
this.wire.sendAction('snapshot-source-wrap').catch((e) => {
|
|
60
|
-
// don't expose, analytics-only call
|
|
61
|
-
});
|
|
62
|
-
return this.wrapSync(identity);
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
exports.default = SnapshotSourceModule;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const base_1 = require("../base");
|
|
4
|
+
const Instance_1 = require("./Instance");
|
|
5
|
+
const utils_1 = require("./utils");
|
|
6
|
+
/**
|
|
7
|
+
* @typedef { object } SnapshotProvider
|
|
8
|
+
* @property {getSnapshot} [getSnapshot]
|
|
9
|
+
* @property {applySnapshot} [applySnapshot]
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* @lends SnapshotSource
|
|
13
|
+
*/
|
|
14
|
+
class SnapshotSourceModule extends base_1.Base {
|
|
15
|
+
/**
|
|
16
|
+
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
|
17
|
+
* @param { SnapshotProvider } provider
|
|
18
|
+
* @return { Promise<void> }
|
|
19
|
+
* @tutorial SnapshotSource.init
|
|
20
|
+
* @static
|
|
21
|
+
*/
|
|
22
|
+
async init(provider) {
|
|
23
|
+
this.wire.sendAction('snapshot-source-init').catch((e) => {
|
|
24
|
+
// don't expose, analytics-only call
|
|
25
|
+
});
|
|
26
|
+
if (typeof provider !== 'object' ||
|
|
27
|
+
typeof provider.getSnapshot !== 'function' ||
|
|
28
|
+
typeof provider.applySnapshot !== 'function') {
|
|
29
|
+
throw new Error('you must pass in a valid SnapshotProvider');
|
|
30
|
+
}
|
|
31
|
+
const channel = await this.fin.InterApplicationBus.Channel.create(utils_1.getSnapshotSourceChannelName(fin.me.identity));
|
|
32
|
+
channel.register('get-snapshot', async () => {
|
|
33
|
+
const snapshot = await provider.getSnapshot();
|
|
34
|
+
return { snapshot };
|
|
35
|
+
});
|
|
36
|
+
channel.register('apply-snapshot', ({ snapshot }) => provider.applySnapshot(snapshot));
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
40
|
+
* @param { Identity } identity
|
|
41
|
+
* @return { SnapshotSource }
|
|
42
|
+
* @tutorial SnapshotSource.wrapSync
|
|
43
|
+
* @static
|
|
44
|
+
*/
|
|
45
|
+
wrapSync(identity) {
|
|
46
|
+
this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
|
|
47
|
+
// don't expose, analytics-only call
|
|
48
|
+
});
|
|
49
|
+
return new Instance_1.SnapshotSource(this.wire, identity);
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
|
53
|
+
* @param { Identity } identity
|
|
54
|
+
* @return { Promise.<SnapshotSource> }
|
|
55
|
+
* @tutorial SnapshotSource.wrap
|
|
56
|
+
* @static
|
|
57
|
+
*/
|
|
58
|
+
async wrap(identity) {
|
|
59
|
+
this.wire.sendAction('snapshot-source-wrap').catch((e) => {
|
|
60
|
+
// don't expose, analytics-only call
|
|
61
|
+
});
|
|
62
|
+
return this.wrapSync(identity);
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
exports.default = SnapshotSourceModule;
|
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
import { Base } from '../base';
|
|
2
|
-
import Transport from '../../transport/transport';
|
|
3
|
-
/**
|
|
4
|
-
* Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
|
|
5
|
-
* @namespace
|
|
6
|
-
*/
|
|
7
|
-
export declare class SnapshotSource<T = any> extends Base {
|
|
8
|
-
#private;
|
|
9
|
-
constructor(wire: Transport, id: OpenFin.ApplicationIdentity);
|
|
10
|
-
get identity(): OpenFin.ApplicationIdentity;
|
|
11
|
-
/**
|
|
12
|
-
* Method to determine if the SnapshotSource has been initialized.
|
|
13
|
-
*
|
|
14
|
-
* Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
|
|
15
|
-
* apply a snapshot using the {@link SnapshotSource#applySnapshot applySnapshot} method.
|
|
16
|
-
* @return { Promise<void> }
|
|
17
|
-
* @tutorial SnapshotSource.ready
|
|
18
|
-
*/
|
|
19
|
-
ready(): Promise<void>;
|
|
20
|
-
/**
|
|
21
|
-
* Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource#init init}.
|
|
22
|
-
* @return { Promise<any> }
|
|
23
|
-
*/
|
|
24
|
-
getSnapshot(): Promise<T>;
|
|
25
|
-
/**
|
|
26
|
-
* Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource#init init}.
|
|
27
|
-
* @return { Promise<void> }
|
|
28
|
-
*/
|
|
29
|
-
applySnapshot(snapshot: T): Promise<void>;
|
|
30
|
-
}
|
|
1
|
+
import { Base } from '../base';
|
|
2
|
+
import Transport from '../../transport/transport';
|
|
3
|
+
/**
|
|
4
|
+
* Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
|
|
5
|
+
* @namespace
|
|
6
|
+
*/
|
|
7
|
+
export declare class SnapshotSource<T = any> extends Base {
|
|
8
|
+
#private;
|
|
9
|
+
constructor(wire: Transport, id: OpenFin.ApplicationIdentity);
|
|
10
|
+
get identity(): OpenFin.ApplicationIdentity;
|
|
11
|
+
/**
|
|
12
|
+
* Method to determine if the SnapshotSource has been initialized.
|
|
13
|
+
*
|
|
14
|
+
* Use when the parent application is starting up to ensure the SnapshotSource is able to accept and
|
|
15
|
+
* apply a snapshot using the {@link SnapshotSource#applySnapshot applySnapshot} method.
|
|
16
|
+
* @return { Promise<void> }
|
|
17
|
+
* @tutorial SnapshotSource.ready
|
|
18
|
+
*/
|
|
19
|
+
ready(): Promise<void>;
|
|
20
|
+
/**
|
|
21
|
+
* Call the SnapshotSource's getSnapshot method defined by {@link SnapshotSource#init init}.
|
|
22
|
+
* @return { Promise<any> }
|
|
23
|
+
*/
|
|
24
|
+
getSnapshot(): Promise<T>;
|
|
25
|
+
/**
|
|
26
|
+
* Call the SnapshotSource's applySnapshot method defined by {@link SnapshotSource#init init}.
|
|
27
|
+
* @return { Promise<void> }
|
|
28
|
+
*/
|
|
29
|
+
applySnapshot(snapshot: T): Promise<void>;
|
|
30
|
+
}
|