@openfin/node-adapter 33.77.8 → 34.78.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/README.md +11 -11
- package/out/node-adapter-alpha.d.ts +555 -1981
- package/out/node-adapter-beta.d.ts +555 -1981
- package/out/node-adapter-public.d.ts +555 -1981
- package/out/node-adapter.d.ts +537 -1997
- package/out/node-adapter.js +521 -859
- package/package.json +1 -1
package/out/node-adapter.js
CHANGED
@@ -30,16 +30,12 @@ function _mergeNamespaces(n, m) {
|
|
30
30
|
|
31
31
|
var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
|
32
32
|
|
33
|
-
function getDefaultExportFromCjs (x) {
|
34
|
-
return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
|
35
|
-
}
|
36
|
-
|
37
33
|
var main$1 = {};
|
38
34
|
|
39
35
|
var fin = {};
|
40
36
|
|
41
37
|
var eventsExports = {};
|
42
|
-
var events
|
38
|
+
var events = {
|
43
39
|
get exports(){ return eventsExports; },
|
44
40
|
set exports(v){ eventsExports = v; },
|
45
41
|
};
|
@@ -76,7 +72,7 @@ var NumberIsNaN = Number.isNaN || function NumberIsNaN(value) {
|
|
76
72
|
function EventEmitter() {
|
77
73
|
EventEmitter.init.call(this);
|
78
74
|
}
|
79
|
-
events
|
75
|
+
events.exports = EventEmitter;
|
80
76
|
eventsExports.once = once;
|
81
77
|
|
82
78
|
// Backwards-compat with node 0.10.x
|
@@ -518,9 +514,9 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
|
|
518
514
|
}
|
519
515
|
}
|
520
516
|
|
521
|
-
var system
|
517
|
+
var system = {};
|
522
518
|
|
523
|
-
var base
|
519
|
+
var base = {};
|
524
520
|
|
525
521
|
var promises = {};
|
526
522
|
|
@@ -563,8 +559,8 @@ var __classPrivateFieldGet$f = (commonjsGlobal && commonjsGlobal.__classPrivateF
|
|
563
559
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
564
560
|
};
|
565
561
|
var _EmitterBase_emitterAccessor;
|
566
|
-
Object.defineProperty(base
|
567
|
-
base
|
562
|
+
Object.defineProperty(base, "__esModule", { value: true });
|
563
|
+
base.Reply = base.EmitterBase = base.Base = void 0;
|
568
564
|
const promises_1$2 = promises;
|
569
565
|
class Base {
|
570
566
|
/**
|
@@ -585,18 +581,11 @@ class Base {
|
|
585
581
|
get fin() {
|
586
582
|
return this.wire.getFin();
|
587
583
|
}
|
588
|
-
/**
|
589
|
-
* Provides access to the OpenFin representation of the current code context (usually a document
|
590
|
-
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
591
|
-
*
|
592
|
-
* Useful for debugging in the devtools console, where this will intelligently type itself based
|
593
|
-
* on the context in which the devtools panel was opened.
|
594
|
-
*/
|
595
584
|
get me() {
|
596
585
|
return this.wire.me;
|
597
586
|
}
|
598
587
|
}
|
599
|
-
base
|
588
|
+
base.Base = Base;
|
600
589
|
/**
|
601
590
|
* An entity that emits OpenFin events.
|
602
591
|
*
|
@@ -626,9 +615,6 @@ class EmitterBase extends Base {
|
|
626
615
|
this.topic = topic;
|
627
616
|
_EmitterBase_emitterAccessor.set(this, void 0);
|
628
617
|
this.eventNames = () => (this.hasEmitter() ? this.getOrCreateEmitter().eventNames() : []);
|
629
|
-
/**
|
630
|
-
* @internal
|
631
|
-
*/
|
632
618
|
this.emit = (eventType, payload, ...args) => {
|
633
619
|
return this.hasEmitter() ? this.getOrCreateEmitter().emit(eventType, payload, ...args) : false;
|
634
620
|
};
|
@@ -671,13 +657,16 @@ class EmitterBase extends Base {
|
|
671
657
|
// This will only be reached if unsubscribe from event that does not exist but do not want to error here
|
672
658
|
return Promise.resolve();
|
673
659
|
};
|
660
|
+
this.addListener = this.on;
|
674
661
|
__classPrivateFieldSet$d(this, _EmitterBase_emitterAccessor, [topic, ...additionalAccessors], "f");
|
675
662
|
this.listeners = (event) => this.hasEmitter() ? this.getOrCreateEmitter().listeners(event) : [];
|
676
663
|
}
|
677
664
|
/**
|
678
665
|
* Adds a listener to the end of the listeners array for the specified event.
|
679
666
|
*
|
680
|
-
* @
|
667
|
+
* @param eventType
|
668
|
+
* @param listener
|
669
|
+
* @param options
|
681
670
|
*/
|
682
671
|
async on(eventType, listener, options) {
|
683
672
|
await this.registerEventListener(eventType, options, (emitter) => {
|
@@ -687,16 +676,12 @@ class EmitterBase extends Base {
|
|
687
676
|
});
|
688
677
|
return this;
|
689
678
|
}
|
690
|
-
/**
|
691
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
692
|
-
*/
|
693
|
-
async addListener(eventType, listener, options) {
|
694
|
-
return this.on(eventType, listener, options);
|
695
|
-
}
|
696
679
|
/**
|
697
680
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
|
698
681
|
*
|
699
|
-
* @
|
682
|
+
* @param eventType
|
683
|
+
* @param listener
|
684
|
+
* @param options
|
700
685
|
*/
|
701
686
|
async once(eventType, listener, options) {
|
702
687
|
const deregister = () => this.deregisterEventListener(eventType);
|
@@ -712,7 +697,9 @@ class EmitterBase extends Base {
|
|
712
697
|
/**
|
713
698
|
* Adds a listener to the beginning of the listeners array for the specified event.
|
714
699
|
*
|
715
|
-
* @
|
700
|
+
* @param eventType
|
701
|
+
* @param listener
|
702
|
+
* @param options
|
716
703
|
*/
|
717
704
|
async prependListener(eventType, listener, options) {
|
718
705
|
await this.registerEventListener(eventType, options, (emitter) => {
|
@@ -726,7 +713,9 @@ class EmitterBase extends Base {
|
|
726
713
|
* Adds a one time listener for the event. The listener is invoked only the first time the event is fired,
|
727
714
|
* after which it is removed. The listener is added to the beginning of the listeners array.
|
728
715
|
*
|
729
|
-
* @
|
716
|
+
* @param eventType
|
717
|
+
* @param listener
|
718
|
+
* @param options
|
730
719
|
*/
|
731
720
|
async prependOnceListener(eventType, listener, options) {
|
732
721
|
const deregister = () => this.deregisterEventListener(eventType);
|
@@ -743,6 +732,10 @@ class EmitterBase extends Base {
|
|
743
732
|
* Remove a listener from the listener array for the specified event.
|
744
733
|
*
|
745
734
|
* @remarks Caution: Calling this method changes the array indices in the listener array behind the listener.
|
735
|
+
*
|
736
|
+
* @param eventType
|
737
|
+
* @param listener
|
738
|
+
* @param options
|
746
739
|
*/
|
747
740
|
async removeListener(eventType, listener, options) {
|
748
741
|
const emitter = await this.deregisterEventListener(eventType, options);
|
@@ -769,6 +762,7 @@ class EmitterBase extends Base {
|
|
769
762
|
/**
|
770
763
|
* Removes all listeners, or those of the specified event.
|
771
764
|
*
|
765
|
+
* @param eventType
|
772
766
|
*/
|
773
767
|
async removeAllListeners(eventType) {
|
774
768
|
const removeByEvent = async (event) => {
|
@@ -793,11 +787,11 @@ class EmitterBase extends Base {
|
|
793
787
|
}
|
794
788
|
}
|
795
789
|
}
|
796
|
-
base
|
790
|
+
base.EmitterBase = EmitterBase;
|
797
791
|
_EmitterBase_emitterAccessor = new WeakMap();
|
798
792
|
class Reply {
|
799
793
|
}
|
800
|
-
base
|
794
|
+
base.Reply = Reply;
|
801
795
|
|
802
796
|
var transportErrors = {};
|
803
797
|
|
@@ -880,7 +874,7 @@ class RuntimeError extends Error {
|
|
880
874
|
}
|
881
875
|
transportErrors.RuntimeError = RuntimeError;
|
882
876
|
|
883
|
-
var window$
|
877
|
+
var window$1 = {};
|
884
878
|
|
885
879
|
var Factory$8 = {};
|
886
880
|
|
@@ -899,45 +893,25 @@ validate.validateIdentity = validateIdentity;
|
|
899
893
|
|
900
894
|
var Instance$7 = {};
|
901
895
|
|
902
|
-
var application
|
896
|
+
var application = {};
|
903
897
|
|
904
898
|
var Factory$7 = {};
|
905
899
|
|
906
900
|
var Instance$6 = {};
|
907
901
|
|
908
|
-
var view
|
902
|
+
var view = {};
|
909
903
|
|
910
904
|
var Factory$6 = {};
|
911
905
|
|
912
|
-
var warnings = {};
|
913
|
-
|
914
|
-
Object.defineProperty(warnings, "__esModule", { value: true });
|
915
|
-
warnings.handleDeprecatedWarnings = void 0;
|
916
|
-
const handleDeprecatedWarnings = (options) => {
|
917
|
-
var _a, _b, _c, _d;
|
918
|
-
if (((_a = options.contentNavigation) === null || _a === void 0 ? void 0 : _a.whitelist) ||
|
919
|
-
((_b = options.contentNavigation) === null || _b === void 0 ? void 0 : _b.blacklist) ||
|
920
|
-
((_c = options.contentRedirect) === null || _c === void 0 ? void 0 : _c.whitelist) ||
|
921
|
-
((_d = options.contentRedirect) === null || _d === void 0 ? void 0 : _d.blacklist)) {
|
922
|
-
console.warn(`The properties 'whitelist' and 'blacklist' have been marked as deprecated and will be removed in a future version. Please use 'allowlist' and 'denylist'.`);
|
923
|
-
}
|
924
|
-
};
|
925
|
-
warnings.handleDeprecatedWarnings = handleDeprecatedWarnings;
|
926
|
-
|
927
906
|
var hasRequiredFactory$3;
|
928
907
|
|
929
908
|
function requireFactory$3 () {
|
930
909
|
if (hasRequiredFactory$3) return Factory$6;
|
931
910
|
hasRequiredFactory$3 = 1;
|
932
911
|
Object.defineProperty(Factory$6, "__esModule", { value: true });
|
933
|
-
|
934
|
-
const base_1 = base$1;
|
912
|
+
const base_1 = base;
|
935
913
|
const validate_1 = validate;
|
936
914
|
const index_1 = requireView();
|
937
|
-
const warnings_1 = warnings;
|
938
|
-
/**
|
939
|
-
* Static namespace for OpenFin API methods that interact with the {@link View} class, available under `fin.View`.
|
940
|
-
*/
|
941
915
|
class ViewModule extends base_1.Base {
|
942
916
|
/**
|
943
917
|
* Creates a new View.
|
@@ -966,13 +940,13 @@ function requireFactory$3 () {
|
|
966
940
|
* ```
|
967
941
|
* Note that created views needs to navigate somewhere for them to actually render a website.
|
968
942
|
* @experimental
|
943
|
+
* @static
|
969
944
|
*/
|
970
945
|
async create(options) {
|
971
946
|
const { uuid } = this.wire.me;
|
972
947
|
if (!options.name || typeof options.name !== 'string') {
|
973
948
|
throw new Error('Please provide a name property as a string in order to create a View.');
|
974
949
|
}
|
975
|
-
(0, warnings_1.handleDeprecatedWarnings)(options);
|
976
950
|
if (this.wire.environment.childViews) {
|
977
951
|
await this.wire.environment.createChildContent({
|
978
952
|
entityType: 'view',
|
@@ -986,6 +960,7 @@ function requireFactory$3 () {
|
|
986
960
|
}
|
987
961
|
/**
|
988
962
|
* Asynchronously returns a View object that represents an existing view.
|
963
|
+
* @param identity
|
989
964
|
*
|
990
965
|
* @example
|
991
966
|
* ```js
|
@@ -994,6 +969,7 @@ function requireFactory$3 () {
|
|
994
969
|
* .catch(err => console.log(err));
|
995
970
|
* ```
|
996
971
|
* @experimental
|
972
|
+
* @static
|
997
973
|
*/
|
998
974
|
async wrap(identity) {
|
999
975
|
this.wire.sendAction('view-wrap');
|
@@ -1005,6 +981,7 @@ function requireFactory$3 () {
|
|
1005
981
|
}
|
1006
982
|
/**
|
1007
983
|
* Synchronously returns a View object that represents an existing view.
|
984
|
+
* @param identity
|
1008
985
|
*
|
1009
986
|
* @example
|
1010
987
|
* ```js
|
@@ -1012,6 +989,7 @@ function requireFactory$3 () {
|
|
1012
989
|
* await view.hide();
|
1013
990
|
* ```
|
1014
991
|
* @experimental
|
992
|
+
* @static
|
1015
993
|
*/
|
1016
994
|
wrapSync(identity) {
|
1017
995
|
this.wire.sendAction('view-wrap-sync').catch((e) => {
|
@@ -1034,6 +1012,7 @@ function requireFactory$3 () {
|
|
1034
1012
|
*
|
1035
1013
|
* ```
|
1036
1014
|
* @experimental
|
1015
|
+
* @static
|
1037
1016
|
*/
|
1038
1017
|
getCurrent() {
|
1039
1018
|
this.wire.sendAction('view-get-current').catch((e) => {
|
@@ -1055,6 +1034,7 @@ function requireFactory$3 () {
|
|
1055
1034
|
*
|
1056
1035
|
* ```
|
1057
1036
|
* @experimental
|
1037
|
+
* @static
|
1058
1038
|
*/
|
1059
1039
|
getCurrentSync() {
|
1060
1040
|
this.wire.sendAction('view-get-current-sync').catch((e) => {
|
@@ -1067,7 +1047,7 @@ function requireFactory$3 () {
|
|
1067
1047
|
return this.wrapSync({ uuid, name });
|
1068
1048
|
}
|
1069
1049
|
}
|
1070
|
-
Factory$6.
|
1050
|
+
Factory$6.default = ViewModule;
|
1071
1051
|
return Factory$6;
|
1072
1052
|
}
|
1073
1053
|
|
@@ -1897,12 +1877,8 @@ var main = {};
|
|
1897
1877
|
|
1898
1878
|
Object.defineProperty(main, "__esModule", { value: true });
|
1899
1879
|
main.WebContents = void 0;
|
1900
|
-
const base_1$k = base
|
1880
|
+
const base_1$k = base;
|
1901
1881
|
class WebContents extends base_1$k.EmitterBase {
|
1902
|
-
/**
|
1903
|
-
* @param identity The identity of the {@link OpenFin.WebContentsEvents WebContents}.
|
1904
|
-
* @param entityType The type of the {@link OpenFin.WebContentsEvents WebContents}.
|
1905
|
-
*/
|
1906
1882
|
constructor(wire, identity, entityType) {
|
1907
1883
|
super(wire, entityType, identity.uuid, identity.name);
|
1908
1884
|
this.identity = identity;
|
@@ -1910,7 +1886,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
1910
1886
|
}
|
1911
1887
|
/**
|
1912
1888
|
* Gets a base64 encoded image of all or part of the WebContents.
|
1889
|
+
* @function capturePage
|
1913
1890
|
* @param options Options for the capturePage call.
|
1891
|
+
* @memberOf View
|
1892
|
+
* @instance
|
1914
1893
|
*
|
1915
1894
|
* @example
|
1916
1895
|
*
|
@@ -1955,11 +1934,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
1955
1934
|
* }
|
1956
1935
|
* console.log(await wnd.capturePage(options));
|
1957
1936
|
* ```
|
1958
|
-
*
|
1959
|
-
* @remarks
|
1960
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
1961
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
1962
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
1963
1937
|
*/
|
1964
1938
|
capturePage(options) {
|
1965
1939
|
return this.wire.sendAction('capture-page', { options, ...this.identity }).then(({ payload }) => payload.data);
|
@@ -1968,6 +1942,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
1968
1942
|
* Executes Javascript on the WebContents, restricted to contents you own or contents owned by
|
1969
1943
|
* applications you have created.
|
1970
1944
|
* @param code JavaScript code to be executed on the view.
|
1945
|
+
* @function executeJavaScript
|
1946
|
+
* @memberOf View
|
1947
|
+
* @instance
|
1971
1948
|
*
|
1972
1949
|
* @example
|
1973
1950
|
* View:
|
@@ -1995,10 +1972,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
1995
1972
|
*
|
1996
1973
|
* executeJavaScript(`console.log('Hello, Openfin')`).then(() => console.log('Javascript excuted')).catch(err => console.log(err));
|
1997
1974
|
* ```
|
1998
|
-
* @remarks
|
1999
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2000
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2001
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2002
1975
|
*/
|
2003
1976
|
executeJavaScript(code) {
|
2004
1977
|
return this.wire
|
@@ -2007,6 +1980,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2007
1980
|
}
|
2008
1981
|
/**
|
2009
1982
|
* Returns the zoom level of the WebContents.
|
1983
|
+
* @function getZoomLevel
|
1984
|
+
* @memberOf View
|
1985
|
+
* @instance
|
2010
1986
|
*
|
2011
1987
|
* @example
|
2012
1988
|
* View:
|
@@ -2038,10 +2014,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2038
2014
|
*
|
2039
2015
|
* getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
|
2040
2016
|
* ```
|
2041
|
-
* @remarks
|
2042
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2043
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2044
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2045
2017
|
*/
|
2046
2018
|
getZoomLevel() {
|
2047
2019
|
return this.wire.sendAction('get-zoom-level', this.identity).then(({ payload }) => payload.data);
|
@@ -2049,6 +2021,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2049
2021
|
/**
|
2050
2022
|
* Sets the zoom level of the WebContents.
|
2051
2023
|
* @param level The zoom level
|
2024
|
+
* @function setZoomLevel
|
2025
|
+
* @memberOf View
|
2026
|
+
* @instance
|
2052
2027
|
*
|
2053
2028
|
* @example
|
2054
2029
|
* View:
|
@@ -2080,10 +2055,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2080
2055
|
*
|
2081
2056
|
* setZoomLevel(4).then(() => console.log('Setting a zoom level')).catch(err => console.log(err));
|
2082
2057
|
* ```
|
2083
|
-
* @remarks
|
2084
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2085
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2086
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2087
2058
|
*/
|
2088
2059
|
setZoomLevel(level) {
|
2089
2060
|
return this.wire.sendAction('set-zoom-level', { ...this.identity, level }).then(() => undefined);
|
@@ -2091,9 +2062,12 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2091
2062
|
/**
|
2092
2063
|
* Navigates the WebContents to a specified URL.
|
2093
2064
|
*
|
2094
|
-
*
|
2065
|
+
* @remarks The url must contain the protocol prefix such as http:// or https://.
|
2095
2066
|
* @param url - The URL to navigate the WebContents to.
|
2096
2067
|
*
|
2068
|
+
* @function navigate
|
2069
|
+
* @memberof View
|
2070
|
+
* @instance
|
2097
2071
|
* @example
|
2098
2072
|
* View:
|
2099
2073
|
* ```js
|
@@ -2121,16 +2095,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2121
2095
|
* navigate().then(() => console.log('Navigate to tutorial')).catch(err => console.log(err));
|
2122
2096
|
* ```
|
2123
2097
|
* @experimental
|
2124
|
-
* @remarks
|
2125
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2126
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2127
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2128
2098
|
*/
|
2129
2099
|
navigate(url) {
|
2130
2100
|
return this.wire.sendAction('navigate-window', { ...this.identity, url }).then(() => undefined);
|
2131
2101
|
}
|
2132
2102
|
/**
|
2133
2103
|
* Navigates the WebContents back one page.
|
2104
|
+
* @function navigateBack
|
2105
|
+
* @memberOf View
|
2106
|
+
* @instance
|
2134
2107
|
*
|
2135
2108
|
* @example
|
2136
2109
|
* View:
|
@@ -2152,16 +2125,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2152
2125
|
* }
|
2153
2126
|
* navigateBack().then(() => console.log('Navigated back')).catch(err => console.log(err));
|
2154
2127
|
* ```
|
2155
|
-
* @remarks
|
2156
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2157
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2158
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2159
2128
|
*/
|
2160
2129
|
navigateBack() {
|
2161
2130
|
return this.wire.sendAction('navigate-window-back', { ...this.identity }).then(() => undefined);
|
2162
2131
|
}
|
2163
2132
|
/**
|
2164
2133
|
* Navigates the WebContents forward one page.
|
2134
|
+
* @function navigateForward
|
2135
|
+
* @memberOf View
|
2136
|
+
* @instance
|
2165
2137
|
*
|
2166
2138
|
* @example
|
2167
2139
|
* View:
|
@@ -2185,16 +2157,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2185
2157
|
* }
|
2186
2158
|
* navigateForward().then(() => console.log('Navigated forward')).catch(err => console.log(err));
|
2187
2159
|
* ```
|
2188
|
-
* @remarks
|
2189
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2190
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2191
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2192
2160
|
*/
|
2193
2161
|
async navigateForward() {
|
2194
2162
|
await this.wire.sendAction('navigate-window-forward', { ...this.identity });
|
2195
2163
|
}
|
2196
2164
|
/**
|
2197
2165
|
* Stops any current navigation the WebContents is performing.
|
2166
|
+
* @function stopNavigation
|
2167
|
+
* @memberOf View
|
2168
|
+
* @instance
|
2198
2169
|
*
|
2199
2170
|
* @example
|
2200
2171
|
* View:
|
@@ -2216,16 +2187,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2216
2187
|
* }
|
2217
2188
|
* stopNavigation().then(() => console.log('you shall not navigate')).catch(err => console.log(err));
|
2218
2189
|
* ```
|
2219
|
-
* @remarks
|
2220
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2221
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2222
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2223
2190
|
*/
|
2224
2191
|
stopNavigation() {
|
2225
2192
|
return this.wire.sendAction('stop-window-navigation', { ...this.identity }).then(() => undefined);
|
2226
2193
|
}
|
2227
2194
|
/**
|
2228
2195
|
* Reloads the WebContents
|
2196
|
+
* @function reload
|
2197
|
+
* @memberOf View
|
2198
|
+
* @instance
|
2229
2199
|
*
|
2230
2200
|
* @example
|
2231
2201
|
* View:
|
@@ -2257,10 +2227,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2257
2227
|
* console.log('Reloaded window')
|
2258
2228
|
* }).catch(err => console.log(err));
|
2259
2229
|
* ```
|
2260
|
-
* @remarks
|
2261
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2262
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2263
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2264
2230
|
*/
|
2265
2231
|
reload(ignoreCache = false) {
|
2266
2232
|
return this.wire
|
@@ -2273,8 +2239,11 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2273
2239
|
/**
|
2274
2240
|
* Prints the WebContents.
|
2275
2241
|
* @param options Printer Options
|
2242
|
+
* @function print
|
2243
|
+
* @memberOf View
|
2244
|
+
* @instance
|
2276
2245
|
*
|
2277
|
-
*
|
2246
|
+
* @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
|
2278
2247
|
* is empty and the default settings for printing.
|
2279
2248
|
*
|
2280
2249
|
* Use the CSS style `page-break-before: always;` to force print to a new page.
|
@@ -2287,10 +2256,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2287
2256
|
* console.log('print call has been sent to the system');
|
2288
2257
|
* });
|
2289
2258
|
* ```
|
2290
|
-
* @remarks
|
2291
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2292
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2293
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2294
2259
|
*/
|
2295
2260
|
print(options = {}) {
|
2296
2261
|
return this.wire.sendAction('print', { ...this.identity, options }).then(() => undefined);
|
@@ -2299,8 +2264,11 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2299
2264
|
* Find and highlight text on a page.
|
2300
2265
|
* @param searchTerm Term to find in page
|
2301
2266
|
* @param options Search options
|
2267
|
+
* @function findInPage
|
2268
|
+
* @memberOf View
|
2269
|
+
* @instance
|
2302
2270
|
*
|
2303
|
-
*
|
2271
|
+
* @remarks By default, each subsequent call will highlight the next text that matches the search term.
|
2304
2272
|
*
|
2305
2273
|
* Returns a promise with the results for the request. By subscribing to the
|
2306
2274
|
* found-in-page event, you can get the results of this call as well.
|
@@ -2335,10 +2303,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2335
2303
|
* console.log(result)
|
2336
2304
|
* });
|
2337
2305
|
* ```
|
2338
|
-
* @remarks
|
2339
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2340
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2341
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2342
2306
|
*/
|
2343
2307
|
findInPage(searchTerm, options) {
|
2344
2308
|
return this.wire
|
@@ -2382,10 +2346,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2382
2346
|
* console.log(results);
|
2383
2347
|
* });
|
2384
2348
|
* ```
|
2385
|
-
* @remarks
|
2386
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2387
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2388
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2389
2349
|
*/
|
2390
2350
|
stopFindInPage(action) {
|
2391
2351
|
return this.wire.sendAction('stop-find-in-page', { ...this.identity, action }).then(() => undefined);
|
@@ -2393,6 +2353,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2393
2353
|
/**
|
2394
2354
|
* Returns an array with all system printers
|
2395
2355
|
* @deprecated use System.getPrinters instead
|
2356
|
+
* @function getPrinters
|
2357
|
+
* @memberOf View
|
2358
|
+
* @instance
|
2396
2359
|
*
|
2397
2360
|
* @example
|
2398
2361
|
* View:
|
@@ -2428,10 +2391,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2428
2391
|
* console.log(err);
|
2429
2392
|
* });
|
2430
2393
|
* ```
|
2431
|
-
* @remarks
|
2432
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2433
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2434
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2435
2394
|
*/
|
2436
2395
|
getPrinters() {
|
2437
2396
|
return this.wire.sendAction('get-printers', { ...this.identity }).then(({ payload }) => payload.data);
|
@@ -2439,6 +2398,10 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2439
2398
|
/**
|
2440
2399
|
* Gives focus to the WebContents.
|
2441
2400
|
*
|
2401
|
+
* @function focus
|
2402
|
+
* @emits focused
|
2403
|
+
* @memberOf Window
|
2404
|
+
* @instance
|
2442
2405
|
* @example
|
2443
2406
|
* ```js
|
2444
2407
|
* async function focusWindow() {
|
@@ -2454,16 +2417,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2454
2417
|
*
|
2455
2418
|
* focusWindow().then(() => console.log('Window focused')).catch(err => console.log(err));
|
2456
2419
|
* ```
|
2457
|
-
* @remarks
|
2458
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2459
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2460
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2461
2420
|
*/
|
2462
2421
|
async focus({ emitSynthFocused } = { emitSynthFocused: true }) {
|
2463
2422
|
await this.wire.sendAction('focus-window', { emitSynthFocused, ...this.identity });
|
2464
2423
|
}
|
2465
2424
|
/**
|
2466
2425
|
* Shows the Chromium Developer Tools
|
2426
|
+
* @function showDeveloperTools
|
2427
|
+
* @memberOf View
|
2428
|
+
* @instance
|
2467
2429
|
*
|
2468
2430
|
* @example
|
2469
2431
|
* View:
|
@@ -2489,10 +2451,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2489
2451
|
* .then(() => console.log('Showing dev tools'))
|
2490
2452
|
* .catch(err => console.error(err));
|
2491
2453
|
* ```
|
2492
|
-
* @remarks
|
2493
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2494
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2495
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2496
2454
|
*/
|
2497
2455
|
async showDeveloperTools() {
|
2498
2456
|
// Note this hits the system action map in core state for legacy reasons.
|
@@ -2501,7 +2459,11 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2501
2459
|
/**
|
2502
2460
|
* Retrieves the process information associated with a WebContents.
|
2503
2461
|
*
|
2504
|
-
*
|
2462
|
+
* @remarks This includes any iframes associated with the WebContents
|
2463
|
+
*
|
2464
|
+
* @function getProcessInfo
|
2465
|
+
* @memberOf View
|
2466
|
+
* @instance
|
2505
2467
|
*
|
2506
2468
|
* @example
|
2507
2469
|
* View:
|
@@ -2515,10 +2477,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2515
2477
|
* const win = await fin.Window.getCurrent();
|
2516
2478
|
* const processInfo = await win.getProcessInfo();
|
2517
2479
|
* ```
|
2518
|
-
* @remarks
|
2519
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2520
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2521
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2522
2480
|
*/
|
2523
2481
|
async getProcessInfo() {
|
2524
2482
|
const { payload: { data } } = await this.wire.sendAction('get-process-info', this.identity);
|
@@ -2526,6 +2484,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2526
2484
|
}
|
2527
2485
|
/**
|
2528
2486
|
* Retrieves information on all Shared Workers.
|
2487
|
+
* @function getSharedWorkers
|
2488
|
+
* @memberOf View
|
2489
|
+
* @instance
|
2529
2490
|
*
|
2530
2491
|
* @example
|
2531
2492
|
* View:
|
@@ -2554,16 +2515,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2554
2515
|
* const win = await fin.Window.create(winOption);
|
2555
2516
|
* const sharedWorkers = await win.getSharedWorkers();
|
2556
2517
|
* ```
|
2557
|
-
* @remarks
|
2558
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2559
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2560
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2561
2518
|
*/
|
2562
2519
|
async getSharedWorkers() {
|
2563
2520
|
return this.wire.sendAction('get-shared-workers', this.identity).then(({ payload }) => payload.data);
|
2564
2521
|
}
|
2565
2522
|
/**
|
2566
2523
|
* Opens the developer tools for the shared worker context.
|
2524
|
+
* @function inspectSharedWorker
|
2525
|
+
* @memberOf View
|
2526
|
+
* @instance
|
2567
2527
|
*
|
2568
2528
|
* @example
|
2569
2529
|
* View:
|
@@ -2592,10 +2552,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2592
2552
|
* const win = await fin.Window.create(winOption);
|
2593
2553
|
* await win.inspectSharedWorker();
|
2594
2554
|
* ```
|
2595
|
-
* @remarks
|
2596
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2597
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2598
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2599
2555
|
*/
|
2600
2556
|
async inspectSharedWorker() {
|
2601
2557
|
await this.wire.sendAction('inspect-shared-worker', { ...this.identity });
|
@@ -2603,6 +2559,9 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2603
2559
|
/**
|
2604
2560
|
* Inspects the shared worker based on its ID.
|
2605
2561
|
* @param workerId - The id of the shared worker.
|
2562
|
+
* @function inspectSharedWorkerById
|
2563
|
+
* @memberOf View
|
2564
|
+
* @instance
|
2606
2565
|
*
|
2607
2566
|
* @example
|
2608
2567
|
* View:
|
@@ -2633,16 +2592,15 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2633
2592
|
* const sharedWorkers = await win.getSharedWorkers();
|
2634
2593
|
* await win.inspectSharedWorkerById(sharedWorkers[0].id);
|
2635
2594
|
* ```
|
2636
|
-
* @remarks
|
2637
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2638
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2639
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2640
2595
|
*/
|
2641
2596
|
async inspectSharedWorkerById(workerId) {
|
2642
2597
|
await this.wire.sendAction('inspect-shared-worker-by-id', { ...this.identity, workerId });
|
2643
2598
|
}
|
2644
2599
|
/**
|
2645
2600
|
* Opens the developer tools for the service worker context.
|
2601
|
+
* @function inspectServiceWorker
|
2602
|
+
* @memberOf View
|
2603
|
+
* @instance
|
2646
2604
|
*
|
2647
2605
|
* @example
|
2648
2606
|
* View:
|
@@ -2671,10 +2629,6 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2671
2629
|
* const win = await fin.Window.create(winOption);
|
2672
2630
|
* await win.inspectServiceWorker();
|
2673
2631
|
* ```
|
2674
|
-
* @remarks
|
2675
|
-
* `WebContents` refers to shared functionality between {@link OpenFin.Window} and {@link OpenFin.View}.
|
2676
|
-
* We do not expose an explicit superclass for this functionality, but it does have its own
|
2677
|
-
* {@link OpenFin.WebContentsEvents event namespace}.
|
2678
2632
|
*/
|
2679
2633
|
async inspectServiceWorker() {
|
2680
2634
|
await this.wire.sendAction('inspect-service-worker', { ...this.identity });
|
@@ -2682,7 +2636,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2682
2636
|
/**
|
2683
2637
|
* Shows a popup window.
|
2684
2638
|
*
|
2685
|
-
*
|
2639
|
+
* @remarks If this WebContents is a view and its attached window has a popup open, this will close it.
|
2686
2640
|
*
|
2687
2641
|
* Shows a popup window. Including a `name` in `options` will attempt to show an existing window as a popup, if
|
2688
2642
|
* that window doesn't exist or no `name` is included a window will be created. If the caller view or the caller
|
@@ -2690,7 +2644,7 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2690
2644
|
* open popup window before showing the new popup window. Also, if the caller view is destroyed or detached, the popup
|
2691
2645
|
* will be dismissed.
|
2692
2646
|
*
|
2693
|
-
*
|
2647
|
+
* NOTE: in the case where the window being shown as a popup needs to be created, it is a child of the caller view's parent window.
|
2694
2648
|
*
|
2695
2649
|
* @example
|
2696
2650
|
*
|
@@ -2885,10 +2839,11 @@ class WebContents extends base_1$k.EmitterBase {
|
|
2885
2839
|
* onPopupReady: popupWindowCallback;
|
2886
2840
|
* });
|
2887
2841
|
* ```
|
2888
|
-
* @
|
2889
|
-
*
|
2890
|
-
*
|
2891
|
-
*
|
2842
|
+
* @function showPopupWindow
|
2843
|
+
* @memberOf View
|
2844
|
+
* @instance
|
2845
|
+
* @param options
|
2846
|
+
*
|
2892
2847
|
*/
|
2893
2848
|
async showPopupWindow(options) {
|
2894
2849
|
this.wire.sendAction(`${this.entityType}-show-popup-window`, this.identity).catch(() => {
|
@@ -3465,6 +3420,7 @@ function requireInstance$2 () {
|
|
3465
3420
|
};
|
3466
3421
|
/**
|
3467
3422
|
* Updates the view's options.
|
3423
|
+
* @param options
|
3468
3424
|
*
|
3469
3425
|
* @example
|
3470
3426
|
* ```js
|
@@ -3505,6 +3461,7 @@ function requireInstance$2 () {
|
|
3505
3461
|
/**
|
3506
3462
|
* Retrieves the window the view is currently attached to.
|
3507
3463
|
*
|
3464
|
+
* @experimental
|
3508
3465
|
* @example
|
3509
3466
|
* ```js
|
3510
3467
|
* const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
|
@@ -3512,7 +3469,6 @@ function requireInstance$2 () {
|
|
3512
3469
|
* .then(win => console.log('current window', win))
|
3513
3470
|
* .catch(err => console.log(err));)
|
3514
3471
|
* ```
|
3515
|
-
* @experimental
|
3516
3472
|
*/
|
3517
3473
|
this.getCurrentWindow = async () => {
|
3518
3474
|
const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
|
@@ -3618,6 +3574,10 @@ function requireInstance$2 () {
|
|
3618
3574
|
/**
|
3619
3575
|
* Focuses the view
|
3620
3576
|
*
|
3577
|
+
* @function focus
|
3578
|
+
* @memberof View
|
3579
|
+
* @emits focused
|
3580
|
+
* @instance
|
3621
3581
|
* @example
|
3622
3582
|
* ```js
|
3623
3583
|
* const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
|
@@ -3640,7 +3600,7 @@ function requireInstance$2 () {
|
|
3640
3600
|
var hasRequiredView;
|
3641
3601
|
|
3642
3602
|
function requireView () {
|
3643
|
-
if (hasRequiredView) return view
|
3603
|
+
if (hasRequiredView) return view;
|
3644
3604
|
hasRequiredView = 1;
|
3645
3605
|
(function (exports) {
|
3646
3606
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
@@ -3659,20 +3619,19 @@ function requireView () {
|
|
3659
3619
|
};
|
3660
3620
|
Object.defineProperty(exports, "__esModule", { value: true });
|
3661
3621
|
/**
|
3662
|
-
* Entry
|
3663
|
-
*
|
3664
|
-
* * {@link ViewModule} contains static members of the `View` API, accessible through `fin.View`.
|
3665
|
-
* * {@link View} describes an instance of an OpenFin View, e.g. as returned by `fin.View.getCurrent`.
|
3622
|
+
* Entry point for the OpenFin View namespace.
|
3666
3623
|
*
|
3667
|
-
*
|
3668
|
-
*
|
3624
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "ViewModule" is used for
|
3625
|
+
* the module containing static members of the `View` namespace (available under `fin.View`), while `View` documents
|
3626
|
+
* instances of the OpenFin `View` class.
|
3669
3627
|
*
|
3670
3628
|
* @packageDocumentation
|
3671
3629
|
*/
|
3672
|
-
|
3630
|
+
const Factory_1 = requireFactory$3();
|
3631
|
+
exports.default = Factory_1.default;
|
3673
3632
|
__exportStar(requireInstance$2(), exports);
|
3674
|
-
} (view
|
3675
|
-
return view
|
3633
|
+
} (view));
|
3634
|
+
return view;
|
3676
3635
|
}
|
3677
3636
|
|
3678
3637
|
var hasRequiredInstance$1;
|
@@ -3683,7 +3642,7 @@ function requireInstance$1 () {
|
|
3683
3642
|
Object.defineProperty(Instance$6, "__esModule", { value: true });
|
3684
3643
|
Instance$6.Application = void 0;
|
3685
3644
|
/* eslint-disable import/prefer-default-export */
|
3686
|
-
const base_1 = base
|
3645
|
+
const base_1 = base;
|
3687
3646
|
const window_1 = requireWindow();
|
3688
3647
|
const view_1 = requireView();
|
3689
3648
|
/**
|
@@ -4158,7 +4117,6 @@ function requireInstance$1 () {
|
|
4158
4117
|
/**
|
4159
4118
|
* Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
|
4160
4119
|
* If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
|
4161
|
-
*
|
4162
4120
|
* Note: If the "name" property is omitted it defaults to "tasks".
|
4163
4121
|
* @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
|
4164
4122
|
*
|
@@ -4459,7 +4417,6 @@ function requireInstance$1 () {
|
|
4459
4417
|
}
|
4460
4418
|
/**
|
4461
4419
|
* Sets file auto download location. It's only allowed in the same application.
|
4462
|
-
*
|
4463
4420
|
* Note: This method is restricted by default and must be enabled via
|
4464
4421
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
4465
4422
|
* @param downloadLocation file auto download location
|
@@ -4485,7 +4442,6 @@ function requireInstance$1 () {
|
|
4485
4442
|
}
|
4486
4443
|
/**
|
4487
4444
|
* Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
|
4488
|
-
*
|
4489
4445
|
* Note: This method is restricted by default and must be enabled via
|
4490
4446
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
4491
4447
|
*
|
@@ -4512,16 +4468,13 @@ function requireFactory$2 () {
|
|
4512
4468
|
if (hasRequiredFactory$2) return Factory$7;
|
4513
4469
|
hasRequiredFactory$2 = 1;
|
4514
4470
|
Object.defineProperty(Factory$7, "__esModule", { value: true });
|
4515
|
-
|
4516
|
-
const base_1 = base$1;
|
4471
|
+
const base_1 = base;
|
4517
4472
|
const validate_1 = validate;
|
4518
4473
|
const Instance_1 = requireInstance$1();
|
4519
|
-
/**
|
4520
|
-
* Static namespace for OpenFin API methods that interact with the {@link Application} class, available under `fin.Application`.
|
4521
|
-
*/
|
4522
4474
|
class ApplicationModule extends base_1.Base {
|
4523
4475
|
/**
|
4524
4476
|
* Asynchronously returns an Application object that represents an existing application.
|
4477
|
+
* @param identity
|
4525
4478
|
*
|
4526
4479
|
* @example
|
4527
4480
|
*
|
@@ -4532,6 +4485,7 @@ function requireFactory$2 () {
|
|
4532
4485
|
* .catch(err => console.log(err));
|
4533
4486
|
* ```
|
4534
4487
|
*
|
4488
|
+
* @static
|
4535
4489
|
*/
|
4536
4490
|
async wrap(identity) {
|
4537
4491
|
this.wire.sendAction('wrap-application').catch((e) => {
|
@@ -4545,6 +4499,7 @@ function requireFactory$2 () {
|
|
4545
4499
|
}
|
4546
4500
|
/**
|
4547
4501
|
* Synchronously returns an Application object that represents an existing application.
|
4502
|
+
* @param identity
|
4548
4503
|
*
|
4549
4504
|
* @example
|
4550
4505
|
*
|
@@ -4553,6 +4508,7 @@ function requireFactory$2 () {
|
|
4553
4508
|
* await app.close();
|
4554
4509
|
* ```
|
4555
4510
|
*
|
4511
|
+
* @static
|
4556
4512
|
*/
|
4557
4513
|
wrapSync(identity) {
|
4558
4514
|
this.wire.sendAction('wrap-application-sync').catch((e) => {
|
@@ -4577,6 +4533,8 @@ function requireFactory$2 () {
|
|
4577
4533
|
}
|
4578
4534
|
/**
|
4579
4535
|
* DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
|
4536
|
+
* @param appOptions
|
4537
|
+
*
|
4580
4538
|
*
|
4581
4539
|
* @example
|
4582
4540
|
*
|
@@ -4605,6 +4563,7 @@ function requireFactory$2 () {
|
|
4605
4563
|
}
|
4606
4564
|
/**
|
4607
4565
|
* Creates and starts a new Application.
|
4566
|
+
* @param appOptions
|
4608
4567
|
*
|
4609
4568
|
* @example
|
4610
4569
|
*
|
@@ -4620,6 +4579,8 @@ function requireFactory$2 () {
|
|
4620
4579
|
* start().then(() => console.log('Application is running')).catch(err => console.log(err));
|
4621
4580
|
* ```
|
4622
4581
|
*
|
4582
|
+
*
|
4583
|
+
* @static
|
4623
4584
|
*/
|
4624
4585
|
async start(appOptions) {
|
4625
4586
|
this.wire.sendAction('start-application').catch((e) => {
|
@@ -4632,8 +4593,10 @@ function requireFactory$2 () {
|
|
4632
4593
|
/**
|
4633
4594
|
* Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
|
4634
4595
|
* Returns once the RVM is finished attempting to launch the applications.
|
4596
|
+
* @param applications
|
4635
4597
|
* @param opts - Parameters that the RVM will use.
|
4636
4598
|
*
|
4599
|
+
* @static
|
4637
4600
|
* @example
|
4638
4601
|
*
|
4639
4602
|
* ```js
|
@@ -4685,6 +4648,8 @@ function requireFactory$2 () {
|
|
4685
4648
|
* });
|
4686
4649
|
*
|
4687
4650
|
* ```
|
4651
|
+
*
|
4652
|
+
* @static
|
4688
4653
|
*/
|
4689
4654
|
getCurrent() {
|
4690
4655
|
this.wire.sendAction('get-current-application').catch((e) => {
|
@@ -4710,6 +4675,8 @@ function requireFactory$2 () {
|
|
4710
4675
|
* });
|
4711
4676
|
*
|
4712
4677
|
* ```
|
4678
|
+
*
|
4679
|
+
* @static
|
4713
4680
|
*/
|
4714
4681
|
getCurrentSync() {
|
4715
4682
|
this.wire.sendAction('get-current-application-sync').catch((e) => {
|
@@ -4730,6 +4697,8 @@ function requireFactory$2 () {
|
|
4730
4697
|
* // For a local manifest file:
|
4731
4698
|
* fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
|
4732
4699
|
* ```
|
4700
|
+
*
|
4701
|
+
* @static
|
4733
4702
|
*/
|
4734
4703
|
async startFromManifest(manifestUrl, opts) {
|
4735
4704
|
this.wire.sendAction('application-start-from-manifest').catch((e) => {
|
@@ -4774,14 +4743,14 @@ function requireFactory$2 () {
|
|
4774
4743
|
});
|
4775
4744
|
}
|
4776
4745
|
}
|
4777
|
-
Factory$7.
|
4746
|
+
Factory$7.default = ApplicationModule;
|
4778
4747
|
return Factory$7;
|
4779
4748
|
}
|
4780
4749
|
|
4781
4750
|
var hasRequiredApplication;
|
4782
4751
|
|
4783
4752
|
function requireApplication () {
|
4784
|
-
if (hasRequiredApplication) return application
|
4753
|
+
if (hasRequiredApplication) return application;
|
4785
4754
|
hasRequiredApplication = 1;
|
4786
4755
|
(function (exports) {
|
4787
4756
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
@@ -4800,20 +4769,19 @@ function requireApplication () {
|
|
4800
4769
|
};
|
4801
4770
|
Object.defineProperty(exports, "__esModule", { value: true });
|
4802
4771
|
/**
|
4803
|
-
* Entry
|
4804
|
-
*
|
4805
|
-
* * {@link ApplicationModule} contains static members of the `Application` API, accessible through `fin.Application`.
|
4806
|
-
* * {@link Application} describes an instance of an OpenFin Application, e.g. as returned by `fin.Application.getCurrent`.
|
4772
|
+
* Entry point for the OpenFin Application namespace.
|
4807
4773
|
*
|
4808
|
-
*
|
4809
|
-
*
|
4774
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "ApplicationModule" is used for
|
4775
|
+
* the module containing static members of the `Application` namespace (available under `fin.Application`), while `Application` documents
|
4776
|
+
* instances of the OpenFin `Application` class.
|
4810
4777
|
*
|
4811
4778
|
* @packageDocumentation
|
4812
4779
|
*/
|
4813
|
-
|
4780
|
+
const Factory_1 = requireFactory$2();
|
4814
4781
|
__exportStar(requireInstance$1(), exports);
|
4815
|
-
|
4816
|
-
|
4782
|
+
exports.default = Factory_1.default;
|
4783
|
+
} (application));
|
4784
|
+
return application;
|
4817
4785
|
}
|
4818
4786
|
|
4819
4787
|
var hasRequiredInstance;
|
@@ -4830,7 +4798,6 @@ function requireInstance () {
|
|
4830
4798
|
const application_1 = requireApplication();
|
4831
4799
|
const main_1 = main;
|
4832
4800
|
const view_1 = requireView();
|
4833
|
-
const warnings_1 = warnings;
|
4834
4801
|
/**
|
4835
4802
|
* @PORTED
|
4836
4803
|
* @typedef { object } Margins
|
@@ -5315,6 +5282,7 @@ function requireInstance () {
|
|
5315
5282
|
*/
|
5316
5283
|
constructor(wire, identity) {
|
5317
5284
|
super(wire, identity, 'window');
|
5285
|
+
this.identity = identity;
|
5318
5286
|
}
|
5319
5287
|
/**
|
5320
5288
|
* Adds a listener to the end of the listeners array for the specified event.
|
@@ -5440,7 +5408,6 @@ function requireInstance () {
|
|
5440
5408
|
if (options.autoShow === undefined) {
|
5441
5409
|
options.autoShow = true;
|
5442
5410
|
}
|
5443
|
-
(0, warnings_1.handleDeprecatedWarnings)(options);
|
5444
5411
|
const windowCreation = this.wire.environment.createChildContent({ entityType: 'window', options });
|
5445
5412
|
Promise.all([pageResponse, windowCreation])
|
5446
5413
|
.then((resolvedArr) => {
|
@@ -6146,12 +6113,11 @@ function requireInstance () {
|
|
6146
6113
|
* moveBy(580, 300).then(() => console.log('Moved')).catch(err => console.log(err));
|
6147
6114
|
* ```
|
6148
6115
|
*/
|
6149
|
-
moveBy(deltaLeft, deltaTop
|
6116
|
+
moveBy(deltaLeft, deltaTop) {
|
6150
6117
|
return this.wire
|
6151
6118
|
.sendAction('move-window-by', {
|
6152
6119
|
deltaLeft,
|
6153
6120
|
deltaTop,
|
6154
|
-
positioningOptions,
|
6155
6121
|
...this.identity
|
6156
6122
|
})
|
6157
6123
|
.then(() => undefined);
|
@@ -6181,12 +6147,11 @@ function requireInstance () {
|
|
6181
6147
|
* moveTo(580, 300).then(() => console.log('Moved')).catch(err => console.log(err))
|
6182
6148
|
* ```
|
6183
6149
|
*/
|
6184
|
-
moveTo(left, top
|
6150
|
+
moveTo(left, top) {
|
6185
6151
|
return this.wire
|
6186
6152
|
.sendAction('move-window', {
|
6187
6153
|
left,
|
6188
6154
|
top,
|
6189
|
-
positioningOptions,
|
6190
6155
|
...this.identity
|
6191
6156
|
})
|
6192
6157
|
.then(() => undefined);
|
@@ -6219,13 +6184,12 @@ function requireInstance () {
|
|
6219
6184
|
* resizeBy(580, 300, 'top-right').then(() => console.log('Resized')).catch(err => console.log(err));
|
6220
6185
|
* ```
|
6221
6186
|
*/
|
6222
|
-
resizeBy(deltaWidth, deltaHeight, anchor
|
6187
|
+
resizeBy(deltaWidth, deltaHeight, anchor) {
|
6223
6188
|
return this.wire
|
6224
6189
|
.sendAction('resize-window-by', {
|
6225
6190
|
deltaWidth: Math.floor(deltaWidth),
|
6226
6191
|
deltaHeight: Math.floor(deltaHeight),
|
6227
6192
|
anchor,
|
6228
|
-
positioningOptions,
|
6229
6193
|
...this.identity
|
6230
6194
|
})
|
6231
6195
|
.then(() => undefined);
|
@@ -6258,13 +6222,12 @@ function requireInstance () {
|
|
6258
6222
|
* resizeTo(580, 300, 'top-left').then(() => console.log('Resized')).catch(err => console.log(err));
|
6259
6223
|
* ```
|
6260
6224
|
*/
|
6261
|
-
resizeTo(width, height, anchor
|
6225
|
+
resizeTo(width, height, anchor) {
|
6262
6226
|
return this.wire
|
6263
6227
|
.sendAction('resize-window', {
|
6264
6228
|
width: Math.floor(width),
|
6265
6229
|
height: Math.floor(height),
|
6266
6230
|
anchor,
|
6267
|
-
positioningOptions,
|
6268
6231
|
...this.identity
|
6269
6232
|
})
|
6270
6233
|
.then(() => undefined);
|
@@ -6323,6 +6286,7 @@ function requireInstance () {
|
|
6323
6286
|
}
|
6324
6287
|
/**
|
6325
6288
|
* Sets the window's size and position.
|
6289
|
+
* @property { Bounds } bounds This is a * @type {string} name - name of the window.object that holds the propertys of
|
6326
6290
|
*
|
6327
6291
|
* @example
|
6328
6292
|
* ```js
|
@@ -6349,10 +6313,8 @@ function requireInstance () {
|
|
6349
6313
|
* }).then(() => console.log('Bounds set to window')).catch(err => console.log(err));
|
6350
6314
|
* ```
|
6351
6315
|
*/
|
6352
|
-
setBounds(bounds
|
6353
|
-
return this.wire
|
6354
|
-
.sendAction('set-window-bounds', { ...bounds, ...this.identity, positioningOptions })
|
6355
|
-
.then(() => undefined);
|
6316
|
+
setBounds(bounds) {
|
6317
|
+
return this.wire.sendAction('set-window-bounds', { ...bounds, ...this.identity }).then(() => undefined);
|
6356
6318
|
}
|
6357
6319
|
/**
|
6358
6320
|
* Shows the window if it is hidden.
|
@@ -6494,10 +6456,7 @@ function requireInstance () {
|
|
6494
6456
|
* Calling this method will close previously opened menus.
|
6495
6457
|
* @experimental
|
6496
6458
|
* @param options
|
6497
|
-
*
|
6498
|
-
* [union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
|
6499
|
-
* of all possible data shapes for the entire menu, and the click handler should process
|
6500
|
-
* these with a "reducer" pattern.
|
6459
|
+
*
|
6501
6460
|
* @example
|
6502
6461
|
* This could be used to show a drop down menu over views in a platform window:
|
6503
6462
|
* ```js
|
@@ -6587,7 +6546,6 @@ function requireInstance () {
|
|
6587
6546
|
return this.wire.sendAction('close-popup-menu', { ...this.identity }).then(() => undefined);
|
6588
6547
|
}
|
6589
6548
|
/**
|
6590
|
-
* @PORTED
|
6591
6549
|
* @typedef {object} PopupOptions
|
6592
6550
|
* @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
|
6593
6551
|
* @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
|
@@ -6605,7 +6563,6 @@ function requireInstance () {
|
|
6605
6563
|
* @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
6606
6564
|
*/
|
6607
6565
|
/**
|
6608
|
-
* @PORTED
|
6609
6566
|
* @typedef {object} PopupResult
|
6610
6567
|
* @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
|
6611
6568
|
* @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
|
@@ -6695,16 +6652,13 @@ function requireFactory$1 () {
|
|
6695
6652
|
if (hasRequiredFactory$1) return Factory$8;
|
6696
6653
|
hasRequiredFactory$1 = 1;
|
6697
6654
|
Object.defineProperty(Factory$8, "__esModule", { value: true });
|
6698
|
-
|
6699
|
-
const base_1 = base$1;
|
6655
|
+
const base_1 = base;
|
6700
6656
|
const validate_1 = validate;
|
6701
6657
|
const Instance_1 = requireInstance();
|
6702
|
-
/**
|
6703
|
-
* Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
|
6704
|
-
*/
|
6705
6658
|
class _WindowModule extends base_1.Base {
|
6706
6659
|
/**
|
6707
6660
|
* Asynchronously returns a Window object that represents an existing window.
|
6661
|
+
* @param identity
|
6708
6662
|
*
|
6709
6663
|
* @example
|
6710
6664
|
* ```js
|
@@ -6721,6 +6675,7 @@ function requireFactory$1 () {
|
|
6721
6675
|
* .then(win => console.log('wrapped window'))
|
6722
6676
|
* .catch(err => console.log(err));
|
6723
6677
|
* ```
|
6678
|
+
* @static
|
6724
6679
|
*/
|
6725
6680
|
async wrap(identity) {
|
6726
6681
|
this.wire.sendAction('window-wrap').catch((e) => {
|
@@ -6734,6 +6689,7 @@ function requireFactory$1 () {
|
|
6734
6689
|
}
|
6735
6690
|
/**
|
6736
6691
|
* Synchronously returns a Window object that represents an existing window.
|
6692
|
+
* @param identity
|
6737
6693
|
*
|
6738
6694
|
* @example
|
6739
6695
|
* ```js
|
@@ -6749,6 +6705,7 @@ function requireFactory$1 () {
|
|
6749
6705
|
* await createWin();
|
6750
6706
|
* let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
|
6751
6707
|
* ```
|
6708
|
+
* @static
|
6752
6709
|
*/
|
6753
6710
|
wrapSync(identity) {
|
6754
6711
|
this.wire.sendAction('window-wrap-sync').catch((e) => {
|
@@ -6780,6 +6737,7 @@ function requireFactory$1 () {
|
|
6780
6737
|
*
|
6781
6738
|
* createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
|
6782
6739
|
* ```
|
6740
|
+
* @static
|
6783
6741
|
*/
|
6784
6742
|
create(options) {
|
6785
6743
|
this.wire.sendAction('create-window').catch((e) => {
|
@@ -6798,6 +6756,7 @@ function requireFactory$1 () {
|
|
6798
6756
|
* .catch(err => console.log(err));
|
6799
6757
|
*
|
6800
6758
|
* ```
|
6759
|
+
* @static
|
6801
6760
|
*/
|
6802
6761
|
getCurrent() {
|
6803
6762
|
this.wire.sendAction('get-current-window').catch((e) => {
|
@@ -6819,6 +6778,7 @@ function requireFactory$1 () {
|
|
6819
6778
|
* console.log(info);
|
6820
6779
|
*
|
6821
6780
|
* ```
|
6781
|
+
* @static
|
6822
6782
|
*/
|
6823
6783
|
getCurrentSync() {
|
6824
6784
|
this.wire.sendAction('get-current-window-sync').catch((e) => {
|
@@ -6831,14 +6791,14 @@ function requireFactory$1 () {
|
|
6831
6791
|
return this.wrapSync({ uuid, name });
|
6832
6792
|
}
|
6833
6793
|
}
|
6834
|
-
Factory$8.
|
6794
|
+
Factory$8.default = _WindowModule;
|
6835
6795
|
return Factory$8;
|
6836
6796
|
}
|
6837
6797
|
|
6838
6798
|
var hasRequiredWindow;
|
6839
6799
|
|
6840
6800
|
function requireWindow () {
|
6841
|
-
if (hasRequiredWindow) return window$
|
6801
|
+
if (hasRequiredWindow) return window$1;
|
6842
6802
|
hasRequiredWindow = 1;
|
6843
6803
|
(function (exports) {
|
6844
6804
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
@@ -6857,34 +6817,25 @@ function requireWindow () {
|
|
6857
6817
|
};
|
6858
6818
|
Object.defineProperty(exports, "__esModule", { value: true });
|
6859
6819
|
/**
|
6860
|
-
* Entry
|
6861
|
-
*
|
6862
|
-
* * {@link _WindowModule} contains static members of the `Window` API, accessible through `fin.Window`.
|
6863
|
-
* * {@link _Window} describes an instance of an OpenFin Window, e.g. as returned by `fin.Window.getCurrent`.
|
6820
|
+
* Entry point for the OpenFin Window namespace.
|
6864
6821
|
*
|
6865
|
-
*
|
6866
|
-
*
|
6822
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "WindowModule" is used for
|
6823
|
+
* the module containing static members of the `Window` namespace (available under `fin.Window`), while `Window` documents
|
6824
|
+
* instances of the OpenFin `Window` class.
|
6867
6825
|
*
|
6868
|
-
*
|
6826
|
+
* Because the `Window` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
|
6869
6827
|
*
|
6870
6828
|
* @packageDocumentation
|
6871
6829
|
*/
|
6872
|
-
|
6830
|
+
const Factory_1 = requireFactory$1();
|
6831
|
+
exports.default = Factory_1.default;
|
6873
6832
|
__exportStar(requireInstance(), exports);
|
6874
|
-
} (window$
|
6875
|
-
return window$
|
6833
|
+
} (window$1));
|
6834
|
+
return window$1;
|
6876
6835
|
}
|
6877
6836
|
|
6878
|
-
|
6879
|
-
|
6880
|
-
*
|
6881
|
-
* * {@link System} contains static members of the `System` API (available under `fin.System`)
|
6882
|
-
*
|
6883
|
-
* @packageDocumentation
|
6884
|
-
*/
|
6885
|
-
Object.defineProperty(system$1, "__esModule", { value: true });
|
6886
|
-
system$1.System = void 0;
|
6887
|
-
const base_1$j = base$1;
|
6837
|
+
Object.defineProperty(system, "__esModule", { value: true });
|
6838
|
+
const base_1$j = base;
|
6888
6839
|
const transport_errors_1$2 = transportErrors;
|
6889
6840
|
const window_1 = requireWindow();
|
6890
6841
|
const events_1$6 = eventsExports;
|
@@ -7199,6 +7150,7 @@ class System extends base_1$j.EmitterBase {
|
|
7199
7150
|
* ```js
|
7200
7151
|
* fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
|
7201
7152
|
* ```
|
7153
|
+
* @static
|
7202
7154
|
*/
|
7203
7155
|
getUniqueUserId() {
|
7204
7156
|
return this.wire.sendAction('get-unique-user-id').then(({ payload }) => payload.data);
|
@@ -7889,8 +7841,7 @@ class System extends base_1$j.EmitterBase {
|
|
7889
7841
|
}
|
7890
7842
|
/**
|
7891
7843
|
* Attempt to close an external process. The process will be terminated if it
|
7892
|
-
* has not closed after the elapsed timeout in milliseconds
|
7893
|
-
*
|
7844
|
+
* has not closed after the elapsed timeout in milliseconds.<br>
|
7894
7845
|
* Note: This method is restricted by default and must be enabled via
|
7895
7846
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
7896
7847
|
* @param options A object defined in the TerminateExternalRequestType interface
|
@@ -7926,8 +7877,7 @@ class System extends base_1$j.EmitterBase {
|
|
7926
7877
|
return this.wire.sendAction('update-proxy', options).then(() => undefined);
|
7927
7878
|
}
|
7928
7879
|
/**
|
7929
|
-
* Downloads the given application asset
|
7930
|
-
*
|
7880
|
+
* Downloads the given application asset<br>
|
7931
7881
|
* Note: This method is restricted by default and must be enabled via
|
7932
7882
|
* <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
|
7933
7883
|
* @param appAsset App asset object
|
@@ -8471,6 +8421,7 @@ class System extends base_1$j.EmitterBase {
|
|
8471
8421
|
* }
|
8472
8422
|
* });
|
8473
8423
|
* ```
|
8424
|
+
* @static
|
8474
8425
|
*/
|
8475
8426
|
async launchManifest(manifestUrl, opts = {}) {
|
8476
8427
|
const { subscribe, ..._sendOpts } = opts;
|
@@ -8730,7 +8681,7 @@ class System extends base_1$j.EmitterBase {
|
|
8730
8681
|
await this.wire.sendAction('set-domain-settings', { domainSettings, ...this.identity });
|
8731
8682
|
}
|
8732
8683
|
}
|
8733
|
-
system
|
8684
|
+
system.default = System;
|
8734
8685
|
|
8735
8686
|
var interappbus = {};
|
8736
8687
|
|
@@ -9141,7 +9092,6 @@ var __classPrivateFieldSet$b = (commonjsGlobal && commonjsGlobal.__classPrivateF
|
|
9141
9092
|
};
|
9142
9093
|
var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
|
9143
9094
|
Object.defineProperty(client, "__esModule", { value: true });
|
9144
|
-
client.ChannelClient = void 0;
|
9145
9095
|
const channel_1$1 = channel;
|
9146
9096
|
const channelClientsByEndpointId = new Map();
|
9147
9097
|
/**
|
@@ -9150,17 +9100,17 @@ const channelClientsByEndpointId = new Map();
|
|
9150
9100
|
* provider via {@link ChannelClient#dispatch dispatch} and to listen for communication
|
9151
9101
|
* from the provider by registering an action via {@link ChannelClient#register register}.
|
9152
9102
|
*
|
9153
|
-
*
|
9103
|
+
* Synchronous Methods:
|
9154
9104
|
* * {@link ChannelClient#onDisconnection onDisconnection(listener)}
|
9155
9105
|
* * {@link ChannelClient#register register(action, listener)}
|
9156
9106
|
* * {@link ChannelClient#remove remove(action)}
|
9157
9107
|
*
|
9158
|
-
*
|
9108
|
+
* Asynchronous Methods:
|
9159
9109
|
* * {@link ChannelClient#disconnect disconnect()}
|
9160
9110
|
* * {@link ChannelClient#dispatch dispatch(action, payload)}
|
9161
9111
|
*
|
9162
|
-
*
|
9163
|
-
* Middleware functions receive the following arguments: (action, payload, senderId).
|
9112
|
+
* Middleware:
|
9113
|
+
* <br>Middleware functions receive the following arguments: (action, payload, senderId).
|
9164
9114
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
9165
9115
|
* unless it is undefined, in which case the original payload is used. Middleware can be used for side effects.
|
9166
9116
|
* * {@link ChannelClient#setDefaultAction setDefaultAction(middleware)}
|
@@ -9307,7 +9257,7 @@ class ChannelClient extends channel_1$1.ChannelBase {
|
|
9307
9257
|
});
|
9308
9258
|
}
|
9309
9259
|
}
|
9310
|
-
client.
|
9260
|
+
client.default = ChannelClient;
|
9311
9261
|
_ChannelClient_protectedObj = new WeakMap(), _ChannelClient_strategy = new WeakMap(), _ChannelClient_close = new WeakMap();
|
9312
9262
|
|
9313
9263
|
var connectionManager = {};
|
@@ -9672,7 +9622,7 @@ var iceManager = {};
|
|
9672
9622
|
|
9673
9623
|
Object.defineProperty(iceManager, "__esModule", { value: true });
|
9674
9624
|
iceManager.RTCICEManager = void 0;
|
9675
|
-
const base_1$i = base
|
9625
|
+
const base_1$i = base;
|
9676
9626
|
/*
|
9677
9627
|
Singleton that facilitates Offer and Answer exchange required for establishing RTC connections.
|
9678
9628
|
*/
|
@@ -9850,20 +9800,20 @@ const runtimeVersioning_1 = runtimeVersioning;
|
|
9850
9800
|
* a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
|
9851
9801
|
* and to listen for communication from clients by registering an action via {@link ChannelProvider#register register}.
|
9852
9802
|
*
|
9853
|
-
*
|
9803
|
+
* Synchronous Methods:
|
9854
9804
|
* * {@link ChannelProvider#onConnection onConnection(listener)}
|
9855
9805
|
* * {@link ChannelProvider#onDisconnection onDisconnection(listener)}
|
9856
9806
|
* * {@link ChannelProvider#publish publish(action, payload)}
|
9857
9807
|
* * {@link ChannelProvider#register register(action, listener)}
|
9858
9808
|
* * {@link ChannelProvider#remove remove(action)}
|
9859
9809
|
*
|
9860
|
-
*
|
9810
|
+
* Asynchronous Methods:
|
9861
9811
|
* * {@link ChannelProvider#destroy destroy()}
|
9862
9812
|
* * {@link ChannelProvider#dispatch dispatch(to, action, payload)}
|
9863
9813
|
* * {@link ChannelProvider#getAllClientInfo getAllClientInfo()}
|
9864
9814
|
*
|
9865
|
-
*
|
9866
|
-
* Middleware functions receive the following arguments: (action, payload, senderId).
|
9815
|
+
* Middleware:
|
9816
|
+
* <br>Middleware functions receive the following arguments: (action, payload, senderId).
|
9867
9817
|
* The return value of the middleware function will be passed on as the payload from beforeAction, to the action listener, to afterAction
|
9868
9818
|
* unless it is undefined, in which case the most recently defined payload is used. Middleware can be used for side effects.
|
9869
9819
|
* * {@link ChannelProvider#setDefaultAction setDefaultAction(middleware)}
|
@@ -10172,7 +10122,7 @@ var messageReceiver = {};
|
|
10172
10122
|
Object.defineProperty(messageReceiver, "__esModule", { value: true });
|
10173
10123
|
messageReceiver.MessageReceiver = void 0;
|
10174
10124
|
const client_1$1 = client;
|
10175
|
-
const base_1$h = base
|
10125
|
+
const base_1$h = base;
|
10176
10126
|
/*
|
10177
10127
|
This is a singleton (per fin object) tasked with routing messages coming off the ipc to the correct endpoint.
|
10178
10128
|
It needs to be a singleton because there can only be one per wire. It tracks both clients and providers' processAction passed in via the strategy.
|
@@ -10232,7 +10182,7 @@ class MessageReceiver extends base_1$h.Base {
|
|
10232
10182
|
const endpointIdFromPreviousConnection = this.latestEndpointIdByChannelId.get(channelId);
|
10233
10183
|
if (endpointIdFromPreviousConnection) {
|
10234
10184
|
// Not convinced by this way of doing things, but pushing up for now.
|
10235
|
-
client_1$1.
|
10185
|
+
client_1$1.default.closeChannelByEndpointId(endpointIdFromPreviousConnection);
|
10236
10186
|
// eslint-disable-next-line no-console
|
10237
10187
|
console.warn('You have created a second connection to an older provider. First connection has been removed from the clientMap');
|
10238
10188
|
// eslint-disable-next-line no-console
|
@@ -10362,7 +10312,7 @@ var _ConnectionManager_messageReceiver, _ConnectionManager_rtcConnectionManager;
|
|
10362
10312
|
Object.defineProperty(connectionManager, "__esModule", { value: true });
|
10363
10313
|
connectionManager.ConnectionManager = void 0;
|
10364
10314
|
const exhaustive_1 = exhaustive;
|
10365
|
-
const base_1$g = base
|
10315
|
+
const base_1$g = base;
|
10366
10316
|
const strategy_1 = strategy$2;
|
10367
10317
|
const strategy_2 = strategy$1;
|
10368
10318
|
const ice_manager_1 = iceManager;
|
@@ -10593,15 +10543,6 @@ class ConnectionManager extends base_1$g.Base {
|
|
10593
10543
|
connectionManager.ConnectionManager = ConnectionManager;
|
10594
10544
|
_ConnectionManager_messageReceiver = new WeakMap(), _ConnectionManager_rtcConnectionManager = new WeakMap();
|
10595
10545
|
|
10596
|
-
/**
|
10597
|
-
* Entry points for the `Channel` subset of the `InterApplicationBus` API (`fin.InterApplicationBus.Channel`).
|
10598
|
-
*
|
10599
|
-
* * {@link Channel} contains static members of the `Channel` API, accessible through `fin.InterApplicationBus.Channel`.
|
10600
|
-
* * {@link OpenFin.ChannelClient} describes a client of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.connect`.
|
10601
|
-
* * {@link OpenFin.ChannelProvider} describes a provider of a channel, e.g. as returned by `fin.InterApplicationBus.Channel.create`.
|
10602
|
-
*
|
10603
|
-
* @packageDocumentation
|
10604
|
-
*/
|
10605
10546
|
var __classPrivateFieldSet$5 = (commonjsGlobal && commonjsGlobal.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
10606
10547
|
if (kind === "m") throw new TypeError("Private method is not writable");
|
10607
10548
|
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
@@ -10619,7 +10560,7 @@ channel$1.Channel = void 0;
|
|
10619
10560
|
/* eslint-disable no-console */
|
10620
10561
|
const events_1$5 = eventsExports;
|
10621
10562
|
const lazy_1$1 = lazy;
|
10622
|
-
const base_1$f = base
|
10563
|
+
const base_1$f = base;
|
10623
10564
|
const client_1 = client;
|
10624
10565
|
const connection_manager_1 = connectionManager;
|
10625
10566
|
const provider_1 = provider;
|
@@ -10662,7 +10603,7 @@ class Channel extends base_1$f.EmitterBase {
|
|
10662
10603
|
_Channel_readyToConnect.set(this, new lazy_1$1.AsyncRetryableLazy(async () => {
|
10663
10604
|
await Promise.all([
|
10664
10605
|
this.on('disconnected', (eventPayload) => {
|
10665
|
-
client_1.
|
10606
|
+
client_1.default.handleProviderDisconnect(eventPayload);
|
10666
10607
|
}),
|
10667
10608
|
this.on('connected', (...args) => {
|
10668
10609
|
__classPrivateFieldGet$7(this, _Channel_internalEmitter, "f").emit('connected', ...args);
|
@@ -10853,7 +10794,7 @@ class Channel extends base_1$f.EmitterBase {
|
|
10853
10794
|
};
|
10854
10795
|
const routingInfo = await this.safeConnect(channelName, opts.wait, connectPayload);
|
10855
10796
|
const strategy = await __classPrivateFieldGet$7(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
|
10856
|
-
const channel = new client_1.
|
10797
|
+
const channel = new client_1.default(routingInfo, this.wire, strategy);
|
10857
10798
|
// It is the client's responsibility to handle endpoint disconnection to the provider.
|
10858
10799
|
// If the endpoint dies, the client will force a disconnection through the core.
|
10859
10800
|
// The provider does not care about endpoint disconnection.
|
@@ -10865,7 +10806,7 @@ class Channel extends base_1$f.EmitterBase {
|
|
10865
10806
|
console.warn(`Something went wrong during disconnect for client with uuid: ${routingInfo.uuid} / name: ${routingInfo.name} / endpointId: ${routingInfo.endpointId}.`);
|
10866
10807
|
}
|
10867
10808
|
finally {
|
10868
|
-
client_1.
|
10809
|
+
client_1.default.handleProviderDisconnect(routingInfo);
|
10869
10810
|
}
|
10870
10811
|
});
|
10871
10812
|
return channel;
|
@@ -10936,16 +10877,9 @@ channel$1.Channel = Channel;
|
|
10936
10877
|
_Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();
|
10937
10878
|
|
10938
10879
|
Object.defineProperty(interappbus, "__esModule", { value: true });
|
10939
|
-
interappbus.InterAppPayload =
|
10940
|
-
/**
|
10941
|
-
* Entry point for the OpenFin `InterApplicationBus` API (`fin.InterApplicationBus`).
|
10942
|
-
*
|
10943
|
-
* * {@link InterApplicationBus} contains static members of the `InterApplicationBus` API, accessible through `fin.InterApplicationBus`.
|
10944
|
-
*
|
10945
|
-
* @packageDocumentation
|
10946
|
-
*/
|
10880
|
+
interappbus.InterAppPayload = void 0;
|
10947
10881
|
const events_1$4 = eventsExports;
|
10948
|
-
const base_1$e = base
|
10882
|
+
const base_1$e = base;
|
10949
10883
|
const ref_counter_1 = refCounter;
|
10950
10884
|
const index_1$2 = channel$1;
|
10951
10885
|
const validate_1$3 = validate;
|
@@ -11135,7 +11069,7 @@ class InterApplicationBus extends base_1$e.Base {
|
|
11135
11069
|
return true;
|
11136
11070
|
}
|
11137
11071
|
}
|
11138
|
-
interappbus.
|
11072
|
+
interappbus.default = InterApplicationBus;
|
11139
11073
|
/**
|
11140
11074
|
* @internal
|
11141
11075
|
*/
|
@@ -11152,16 +11086,8 @@ function createKey(...toHash) {
|
|
11152
11086
|
|
11153
11087
|
var clipboard = {};
|
11154
11088
|
|
11155
|
-
/**
|
11156
|
-
* Entry point for the OpenFin `Clipboard` API (`fin.Clipboard`).
|
11157
|
-
*
|
11158
|
-
* * {@link Clipboard} contains static members of the `Clipboard` API, accessible through `fin.Clipboard`.
|
11159
|
-
*
|
11160
|
-
* @packageDocumentation
|
11161
|
-
*/
|
11162
11089
|
Object.defineProperty(clipboard, "__esModule", { value: true });
|
11163
|
-
|
11164
|
-
const base_1$d = base$1;
|
11090
|
+
const base_1$d = base;
|
11165
11091
|
/**
|
11166
11092
|
* @PORTED
|
11167
11093
|
* WriteRequestType interface
|
@@ -11358,9 +11284,9 @@ class Clipboard extends base_1$d.Base {
|
|
11358
11284
|
return payload.data;
|
11359
11285
|
}
|
11360
11286
|
}
|
11361
|
-
clipboard.
|
11287
|
+
clipboard.default = Clipboard;
|
11362
11288
|
|
11363
|
-
var externalApplication
|
11289
|
+
var externalApplication = {};
|
11364
11290
|
|
11365
11291
|
var Factory$5 = {};
|
11366
11292
|
|
@@ -11369,11 +11295,11 @@ var Instance$4 = {};
|
|
11369
11295
|
Object.defineProperty(Instance$4, "__esModule", { value: true });
|
11370
11296
|
Instance$4.ExternalApplication = void 0;
|
11371
11297
|
/* eslint-disable import/prefer-default-export */
|
11372
|
-
const base_1$c = base
|
11298
|
+
const base_1$c = base;
|
11373
11299
|
/**
|
11374
11300
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
11375
11301
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
11376
|
-
* Discovery of connections is provided by
|
11302
|
+
* Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
|
11377
11303
|
*
|
11378
11304
|
* Processes that can be wrapped as `ExternalApplication`s include the following:
|
11379
11305
|
* - Processes which have connected to an OpenFin runtime via an adapter
|
@@ -11484,12 +11410,8 @@ class ExternalApplication extends base_1$c.EmitterBase {
|
|
11484
11410
|
Instance$4.ExternalApplication = ExternalApplication;
|
11485
11411
|
|
11486
11412
|
Object.defineProperty(Factory$5, "__esModule", { value: true });
|
11487
|
-
|
11488
|
-
const base_1$b = base$1;
|
11413
|
+
const base_1$b = base;
|
11489
11414
|
const Instance_1$4 = Instance$4;
|
11490
|
-
/**
|
11491
|
-
* Static namespace for OpenFin API methods that interact with the {@link ExternalApplication} class, available under `fin.ExternalApplication`.
|
11492
|
-
*/
|
11493
11415
|
class ExternalApplicationModule extends base_1$b.Base {
|
11494
11416
|
/**
|
11495
11417
|
* Asynchronously returns an External Application object that represents an external application.
|
@@ -11503,6 +11425,7 @@ class ExternalApplicationModule extends base_1$b.Base {
|
|
11503
11425
|
* .then(extApp => console.log('wrapped external application'))
|
11504
11426
|
* .catch(err => console.log(err));
|
11505
11427
|
* ```
|
11428
|
+
* @static
|
11506
11429
|
*/
|
11507
11430
|
wrap(uuid) {
|
11508
11431
|
this.wire.sendAction('external-application-wrap').catch((e) => {
|
@@ -11522,6 +11445,7 @@ class ExternalApplicationModule extends base_1$b.Base {
|
|
11522
11445
|
* const info = await extApp.getInfo();
|
11523
11446
|
* console.log(info);
|
11524
11447
|
* ```
|
11448
|
+
* @static
|
11525
11449
|
*/
|
11526
11450
|
wrapSync(uuid) {
|
11527
11451
|
this.wire.sendAction('external-application-wrap-sync').catch((e) => {
|
@@ -11530,9 +11454,18 @@ class ExternalApplicationModule extends base_1$b.Base {
|
|
11530
11454
|
return new Instance_1$4.ExternalApplication(this.wire, { uuid });
|
11531
11455
|
}
|
11532
11456
|
}
|
11533
|
-
Factory$5.
|
11457
|
+
Factory$5.default = ExternalApplicationModule;
|
11534
11458
|
|
11535
11459
|
(function (exports) {
|
11460
|
+
/**
|
11461
|
+
* Entry point for the OpenFin ExternalApplication namespace.
|
11462
|
+
*
|
11463
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "ExternalApplicationModule" is used for
|
11464
|
+
* the module containing static members of the `ExternalApplication` namespace (available under `fin.ExternalApplication`), while `ExternalApplication`
|
11465
|
+
* documents instances of the OpenFin `ExternalApplication` class.
|
11466
|
+
*
|
11467
|
+
* @packageDocumentation
|
11468
|
+
*/
|
11536
11469
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
11537
11470
|
if (k2 === undefined) k2 = k;
|
11538
11471
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
@@ -11548,22 +11481,12 @@ Factory$5.ExternalApplicationModule = ExternalApplicationModule;
|
|
11548
11481
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
11549
11482
|
};
|
11550
11483
|
Object.defineProperty(exports, "__esModule", { value: true });
|
11551
|
-
|
11552
|
-
|
11553
|
-
*
|
11554
|
-
* * {@link ExternalApplicationModule} contains static members of the `ExternalApplication` type, accessible through `fin.ExternalApplication`.
|
11555
|
-
* * {@link ExternalApplication} describes an instance of an OpenFin ExternalApplication, e.g. as returned by `fin.ExternalApplication.getCurrent`.
|
11556
|
-
*
|
11557
|
-
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
11558
|
-
* both of these were documented on the same page.
|
11559
|
-
*
|
11560
|
-
* @packageDocumentation
|
11561
|
-
*/
|
11562
|
-
__exportStar(Factory$5, exports);
|
11484
|
+
const Factory_1 = Factory$5;
|
11485
|
+
exports.default = Factory_1.default;
|
11563
11486
|
__exportStar(Instance$4, exports);
|
11564
|
-
} (externalApplication
|
11487
|
+
} (externalApplication));
|
11565
11488
|
|
11566
|
-
var frame
|
11489
|
+
var frame = {};
|
11567
11490
|
|
11568
11491
|
var Factory$4 = {};
|
11569
11492
|
|
@@ -11572,7 +11495,7 @@ var Instance$3 = {};
|
|
11572
11495
|
Object.defineProperty(Instance$3, "__esModule", { value: true });
|
11573
11496
|
Instance$3._Frame = void 0;
|
11574
11497
|
/* eslint-disable import/prefer-default-export */
|
11575
|
-
const base_1$a = base
|
11498
|
+
const base_1$a = base;
|
11576
11499
|
/**
|
11577
11500
|
* An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
|
11578
11501
|
* has its own DOM and global JS context (which may or may not be linked to that of the parent depending
|
@@ -11713,13 +11636,9 @@ class _Frame extends base_1$a.EmitterBase {
|
|
11713
11636
|
Instance$3._Frame = _Frame;
|
11714
11637
|
|
11715
11638
|
Object.defineProperty(Factory$4, "__esModule", { value: true });
|
11716
|
-
|
11717
|
-
const base_1$9 = base$1;
|
11639
|
+
const base_1$9 = base;
|
11718
11640
|
const validate_1$2 = validate;
|
11719
11641
|
const Instance_1$3 = Instance$3;
|
11720
|
-
/**
|
11721
|
-
* Static namespace for OpenFin API methods that interact with the {@link _Frame} class, available under `fin.Frame`.
|
11722
|
-
*/
|
11723
11642
|
class _FrameModule extends base_1$9.Base {
|
11724
11643
|
/**
|
11725
11644
|
* Asynchronously returns a reference to the specified frame. The frame does not have to exist
|
@@ -11731,6 +11650,7 @@ class _FrameModule extends base_1$9.Base {
|
|
11731
11650
|
* .then(frm => console.log('wrapped frame'))
|
11732
11651
|
* .catch(err => console.log(err));
|
11733
11652
|
* ```
|
11653
|
+
* @static
|
11734
11654
|
*/
|
11735
11655
|
async wrap(identity) {
|
11736
11656
|
this.wire.sendAction('frame-wrap').catch((e) => {
|
@@ -11752,6 +11672,7 @@ class _FrameModule extends base_1$9.Base {
|
|
11752
11672
|
* const info = await frm.getInfo();
|
11753
11673
|
* console.log(info);
|
11754
11674
|
* ```
|
11675
|
+
* @static
|
11755
11676
|
*/
|
11756
11677
|
wrapSync(identity) {
|
11757
11678
|
this.wire.sendAction('frame-wrap-sync').catch((e) => {
|
@@ -11772,6 +11693,7 @@ class _FrameModule extends base_1$9.Base {
|
|
11772
11693
|
* .then(frm => console.log('current frame'))
|
11773
11694
|
* .catch(err => console.log(err));
|
11774
11695
|
* ```
|
11696
|
+
* @static
|
11775
11697
|
*/
|
11776
11698
|
getCurrent() {
|
11777
11699
|
this.wire.sendAction('frame-get-current').catch((e) => {
|
@@ -11788,6 +11710,7 @@ class _FrameModule extends base_1$9.Base {
|
|
11788
11710
|
* const info = await frm.getInfo();
|
11789
11711
|
* console.log(info);
|
11790
11712
|
* ```
|
11713
|
+
* @static
|
11791
11714
|
*/
|
11792
11715
|
getCurrentSync() {
|
11793
11716
|
this.wire.sendAction('frame-get-current-sync').catch((e) => {
|
@@ -11796,19 +11719,17 @@ class _FrameModule extends base_1$9.Base {
|
|
11796
11719
|
return new Instance_1$3._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
|
11797
11720
|
}
|
11798
11721
|
}
|
11799
|
-
Factory$4.
|
11722
|
+
Factory$4.default = _FrameModule;
|
11800
11723
|
|
11801
11724
|
(function (exports) {
|
11802
11725
|
/**
|
11803
|
-
* Entry
|
11804
|
-
*
|
11805
|
-
* * {@link _FrameModule} contains static members of the `Frame` API, accessible through `fin.Frame`.
|
11806
|
-
* * {@link _Frame} describes an instance of an OpenFin Frame, e.g. as returned by `fin.Frame.getCurrent`.
|
11726
|
+
* Entry point for the OpenFin Frame namespace.
|
11807
11727
|
*
|
11808
|
-
*
|
11809
|
-
*
|
11728
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "FrameModule" is used for
|
11729
|
+
* the module containing static members of the `Frame` namespace (available under `fin.Frame`), while `Frame` documents
|
11730
|
+
* instances of the OpenFin `Frame` class.
|
11810
11731
|
*
|
11811
|
-
*
|
11732
|
+
* Because the `Frame` name aliases a DOM entity, the documentation pipeline prefixes the name with an underscore.
|
11812
11733
|
*
|
11813
11734
|
* @packageDocumentation
|
11814
11735
|
*/
|
@@ -11827,15 +11748,15 @@ Factory$4._FrameModule = _FrameModule;
|
|
11827
11748
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
11828
11749
|
};
|
11829
11750
|
Object.defineProperty(exports, "__esModule", { value: true });
|
11830
|
-
|
11751
|
+
const Factory_1 = Factory$4;
|
11752
|
+
exports.default = Factory_1.default;
|
11831
11753
|
__exportStar(Instance$3, exports);
|
11832
|
-
} (frame
|
11754
|
+
} (frame));
|
11833
11755
|
|
11834
|
-
var globalHotkey
|
11756
|
+
var globalHotkey = {};
|
11835
11757
|
|
11836
|
-
Object.defineProperty(globalHotkey
|
11837
|
-
|
11838
|
-
const base_1$8 = base$1;
|
11758
|
+
Object.defineProperty(globalHotkey, "__esModule", { value: true });
|
11759
|
+
const base_1$8 = base;
|
11839
11760
|
/**
|
11840
11761
|
* The GlobalHotkey module can register/unregister a global hotkeys.
|
11841
11762
|
*
|
@@ -11964,9 +11885,9 @@ class GlobalHotkey extends base_1$8.EmitterBase {
|
|
11964
11885
|
return data;
|
11965
11886
|
}
|
11966
11887
|
}
|
11967
|
-
globalHotkey
|
11888
|
+
globalHotkey.default = GlobalHotkey;
|
11968
11889
|
|
11969
|
-
var platform
|
11890
|
+
var platform = {};
|
11970
11891
|
|
11971
11892
|
var Factory$3 = {};
|
11972
11893
|
|
@@ -11981,14 +11902,16 @@ var _Platform_connectToProvider;
|
|
11981
11902
|
Object.defineProperty(Instance$2, "__esModule", { value: true });
|
11982
11903
|
Instance$2.Platform = void 0;
|
11983
11904
|
/* eslint-disable import/prefer-default-export, no-undef */
|
11984
|
-
const base_1$7 = base
|
11905
|
+
const base_1$7 = base;
|
11985
11906
|
const validate_1$1 = validate;
|
11986
11907
|
// Reuse clients to avoid overwriting already-registered client in provider
|
11987
11908
|
const clientMap = new Map();
|
11988
11909
|
/** Manages the life cycle of windows and views in the application.
|
11989
11910
|
*
|
11990
|
-
* Enables taking snapshots of itself and
|
11911
|
+
* Enables taking snapshots of itself and applyi
|
11912
|
+
* ng them to restore a previous configuration
|
11991
11913
|
* as well as listen to {@link OpenFin.PlatformEvents platform events}.
|
11914
|
+
*
|
11992
11915
|
*/
|
11993
11916
|
class Platform extends base_1$7.EmitterBase {
|
11994
11917
|
/**
|
@@ -12347,11 +12270,12 @@ class Platform extends base_1$7.EmitterBase {
|
|
12347
12270
|
});
|
12348
12271
|
}
|
12349
12272
|
/**
|
12350
|
-
* ***DEPRECATED - please use
|
12273
|
+
* ***DEPRECATED - please use Platform.createView.***
|
12351
12274
|
* Reparents a specified view in a new target window.
|
12352
12275
|
* @param viewIdentity View identity
|
12353
12276
|
* @param target new owner window identity
|
12354
12277
|
*
|
12278
|
+
* @tutorial Platform.createView
|
12355
12279
|
*/
|
12356
12280
|
async reparentView(viewIdentity, target) {
|
12357
12281
|
var _a;
|
@@ -12841,142 +12765,10 @@ Object.defineProperty(Instance$1, "__esModule", { value: true });
|
|
12841
12765
|
Instance$1.Layout = void 0;
|
12842
12766
|
const lazy_1 = lazy;
|
12843
12767
|
const validate_1 = validate;
|
12844
|
-
const base_1$6 = base
|
12768
|
+
const base_1$6 = base;
|
12845
12769
|
const common_utils_1 = commonUtils;
|
12846
12770
|
const layout_entities_1 = layoutEntities;
|
12847
12771
|
const layout_constants_1 = layout_constants;
|
12848
|
-
/**
|
12849
|
-
*
|
12850
|
-
* Layouts give app providers the ability to embed multiple views in a single window. The Layout namespace
|
12851
|
-
* enables the initialization and manipulation of a window's Layout. A Layout will
|
12852
|
-
* emit events locally on the DOM element representing the layout-container.
|
12853
|
-
*
|
12854
|
-
*
|
12855
|
-
* ### Layout.DOMEvents
|
12856
|
-
*
|
12857
|
-
* When a Layout is created, it emits events onto the DOM element representing the Layout container.
|
12858
|
-
* This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
|
12859
|
-
* You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
|
12860
|
-
* The events are emitted synchronously and only in the process where the Layout exists.
|
12861
|
-
* Any values returned by the called listeners are ignored and will be discarded.
|
12862
|
-
* If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
|
12863
|
-
*
|
12864
|
-
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
12865
|
-
*
|
12866
|
-
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
12867
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
12868
|
-
* @example
|
12869
|
-
* ```js
|
12870
|
-
* const myLayoutContainer = document.getElementById('layout-container');
|
12871
|
-
*
|
12872
|
-
* myLayoutContainer.addEventListener('tab-created', function(event) {
|
12873
|
-
* const { tabSelector } = event.detail;
|
12874
|
-
* const tabElement = document.getElementById(tabSelector);
|
12875
|
-
* const existingColor = tabElement.style.backgroundColor;
|
12876
|
-
* tabElement.style.backgroundColor = "red";
|
12877
|
-
* setTimeout(() => {
|
12878
|
-
* tabElement.style.backgroundColor = existingColor;
|
12879
|
-
* }, 2000);
|
12880
|
-
* });
|
12881
|
-
* ```
|
12882
|
-
*
|
12883
|
-
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
12884
|
-
* Adds a listener to the end of the listeners array for the specified event.
|
12885
|
-
* @example
|
12886
|
-
* ```js
|
12887
|
-
* const myLayoutContainer = document.getElementById('layout-container');
|
12888
|
-
*
|
12889
|
-
* const listener = function(event) {
|
12890
|
-
* console.log(event.detail);
|
12891
|
-
* console.log('container-created event fired once, removing listener');
|
12892
|
-
* myLayoutContainer.removeEventListener('container-created', listener);
|
12893
|
-
* };
|
12894
|
-
*
|
12895
|
-
* myLayoutContainer.addEventListener('container-created', listener);
|
12896
|
-
* ```
|
12897
|
-
*
|
12898
|
-
* ### Supported event types are:
|
12899
|
-
*
|
12900
|
-
* * tab-created
|
12901
|
-
* * container-created
|
12902
|
-
* * layout-state-changed
|
12903
|
-
* * tab-closed
|
12904
|
-
* * tab-dropped
|
12905
|
-
*
|
12906
|
-
* ### Layout DOM Node Events
|
12907
|
-
*
|
12908
|
-
* #### tab-created
|
12909
|
-
* Generated when a tab is created. As a user drags and drops tabs within window, new tabs are created. A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
|
12910
|
-
* ```js
|
12911
|
-
* // The response has the following shape in event.detail:
|
12912
|
-
* {
|
12913
|
-
* containerSelector: "container-component_A",
|
12914
|
-
* name: "component_A",
|
12915
|
-
* tabSelector: "tab-component_A",
|
12916
|
-
* topic: "openfin-DOM-event",
|
12917
|
-
* type: "tab-created",
|
12918
|
-
* uuid: "OpenFin POC"
|
12919
|
-
* }
|
12920
|
-
* ```
|
12921
|
-
*
|
12922
|
-
* #### container-created
|
12923
|
-
* Generated when a container is created. A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view. To discover when the container is destroyed, please listen to view-detached event.
|
12924
|
-
* ```js
|
12925
|
-
* // The response has the following shape in event.detail:
|
12926
|
-
* {
|
12927
|
-
* containerSelector: "container-component_A",
|
12928
|
-
* name: "component_A",
|
12929
|
-
* tabSelector: "tab-component_A",
|
12930
|
-
* topic: "openfin-DOM-event",
|
12931
|
-
* type: "container-created",
|
12932
|
-
* uuid: "OpenFin POC"
|
12933
|
-
* }
|
12934
|
-
* ```
|
12935
|
-
*
|
12936
|
-
* ### layout-state-changed
|
12937
|
-
* Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
|
12938
|
-
* ```js
|
12939
|
-
* // The response has the following shape in event.detail
|
12940
|
-
* {
|
12941
|
-
* containerSelector: "container-component_A",
|
12942
|
-
* name: "component_A",
|
12943
|
-
* tabSelector: "tab-component_A",
|
12944
|
-
* topic: "openfin-DOM-event",
|
12945
|
-
* type: "layout-state-changed",
|
12946
|
-
* uuid: "OpenFin POC"
|
12947
|
-
* }
|
12948
|
-
* ```
|
12949
|
-
*
|
12950
|
-
* #### tab-closed
|
12951
|
-
* Generated when a tab is closed.
|
12952
|
-
* ```js
|
12953
|
-
* // The response has the following shape in event.detail:
|
12954
|
-
* {
|
12955
|
-
* containerSelector: "container-component_A",
|
12956
|
-
* name: "component_A",
|
12957
|
-
* tabSelector: "tab-component_A",
|
12958
|
-
* topic: "openfin-DOM-event",
|
12959
|
-
* type: "tab-closed",
|
12960
|
-
* uuid: "OpenFin POC",
|
12961
|
-
* url: "http://openfin.co" // The url of the view that was closed.
|
12962
|
-
* }
|
12963
|
-
* ```
|
12964
|
-
*
|
12965
|
-
* #### tab-dropped
|
12966
|
-
* Generated when a tab is dropped.
|
12967
|
-
* ```js
|
12968
|
-
* // The response has the following shape in event.detail:
|
12969
|
-
* {
|
12970
|
-
* containerSelector: "container-component_A",
|
12971
|
-
* name: "component_A",
|
12972
|
-
* tabSelector: "tab-component_A",
|
12973
|
-
* topic: "openfin-DOM-event",
|
12974
|
-
* type: "tab-dropped",
|
12975
|
-
* uuid: "OpenFin POC",
|
12976
|
-
* url: "http://openfin.co" // The url of the view linked to the dropped tab.
|
12977
|
-
* }
|
12978
|
-
* ```
|
12979
|
-
*/
|
12980
12772
|
class Layout extends base_1$6.Base {
|
12981
12773
|
/**
|
12982
12774
|
* @internal
|
@@ -13202,11 +12994,8 @@ var _LayoutModule_layoutInitializationAttempted;
|
|
13202
12994
|
Object.defineProperty(Factory$2, "__esModule", { value: true });
|
13203
12995
|
Factory$2.LayoutModule = void 0;
|
13204
12996
|
/* eslint-disable no-undef, import/prefer-default-export */
|
13205
|
-
const base_1$5 = base
|
12997
|
+
const base_1$5 = base;
|
13206
12998
|
const Instance_1$2 = Instance$1;
|
13207
|
-
/**
|
13208
|
-
* Static namespace for OpenFin API methods that interact with the {@link Layout} class, available under `fin.Platform.Layout`.
|
13209
|
-
*/
|
13210
12999
|
class LayoutModule extends base_1$5.Base {
|
13211
13000
|
constructor() {
|
13212
13001
|
super(...arguments);
|
@@ -13248,6 +13037,7 @@ class LayoutModule extends base_1$5.Base {
|
|
13248
13037
|
* // the window must have been created with a layout in its window options
|
13249
13038
|
* const layout = await fin.Platform.Layout.init({ containerId });
|
13250
13039
|
* ```
|
13040
|
+
* @static
|
13251
13041
|
*/
|
13252
13042
|
this.init = async (options = {}) => {
|
13253
13043
|
this.wire.sendAction('layout-init').catch((e) => {
|
@@ -13265,6 +13055,7 @@ class LayoutModule extends base_1$5.Base {
|
|
13265
13055
|
}
|
13266
13056
|
/**
|
13267
13057
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
13058
|
+
* @param identity
|
13268
13059
|
*
|
13269
13060
|
* @example
|
13270
13061
|
* ```js
|
@@ -13281,7 +13072,9 @@ class LayoutModule extends base_1$5.Base {
|
|
13281
13072
|
* // Use wrapped instance to control layout, e.g.:
|
13282
13073
|
* const layoutConfig = await layout.getConfig();
|
13283
13074
|
* ```
|
13075
|
+
* @static
|
13284
13076
|
*/
|
13077
|
+
// eslint-disable-next-line class-methods-use-this
|
13285
13078
|
async wrap(identity) {
|
13286
13079
|
this.wire.sendAction('layout-wrap').catch((e) => {
|
13287
13080
|
// don't expose
|
@@ -13290,6 +13083,7 @@ class LayoutModule extends base_1$5.Base {
|
|
13290
13083
|
}
|
13291
13084
|
/**
|
13292
13085
|
* Synchronously returns a Layout object that represents a Window's layout.
|
13086
|
+
* @param identity
|
13293
13087
|
*
|
13294
13088
|
* @example
|
13295
13089
|
* ```js
|
@@ -13306,7 +13100,9 @@ class LayoutModule extends base_1$5.Base {
|
|
13306
13100
|
* // Use wrapped instance to control layout, e.g.:
|
13307
13101
|
* const layoutConfig = await layout.getConfig();
|
13308
13102
|
* ```
|
13103
|
+
* @static
|
13309
13104
|
*/
|
13105
|
+
// eslint-disable-next-line class-methods-use-this
|
13310
13106
|
wrapSync(identity) {
|
13311
13107
|
this.wire.sendAction('layout-wrap-sync').catch((e) => {
|
13312
13108
|
// don't expose
|
@@ -13322,6 +13118,7 @@ class LayoutModule extends base_1$5.Base {
|
|
13322
13118
|
* // Use wrapped instance to control layout, e.g.:
|
13323
13119
|
* const layoutConfig = await layout.getConfig();
|
13324
13120
|
* ```
|
13121
|
+
* @static
|
13325
13122
|
*/
|
13326
13123
|
async getCurrent() {
|
13327
13124
|
this.wire.sendAction('layout-get-current').catch((e) => {
|
@@ -13345,6 +13142,7 @@ class LayoutModule extends base_1$5.Base {
|
|
13345
13142
|
* // Use wrapped instance to control layout, e.g.:
|
13346
13143
|
* const layoutConfig = await layout.getConfig();
|
13347
13144
|
* ```
|
13145
|
+
* @static
|
13348
13146
|
*/
|
13349
13147
|
getCurrentSync() {
|
13350
13148
|
this.wire.sendAction('layout-get-current-sync').catch((e) => {
|
@@ -13362,16 +13160,139 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
|
|
13362
13160
|
|
13363
13161
|
(function (exports) {
|
13364
13162
|
/**
|
13365
|
-
* Entry point for the OpenFin
|
13366
|
-
*
|
13367
|
-
* * {@link LayoutModule} contains static members of the `Layout` API, accessible through `fin.Platform.Layout`.
|
13368
|
-
* * {@link Layout} describes an instance of an OpenFin Layout, e.g. as returned by `fin.Platform.Layout.getCurrent`.
|
13163
|
+
* Entry point for the OpenFin Layout namespace.
|
13369
13164
|
*
|
13370
|
-
*
|
13371
|
-
*
|
13165
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "LayoutModule" is used for
|
13166
|
+
* the module containing static members of the `Layout` namespace (available under `fin.Platform.Layout`), while `Layout` documents
|
13167
|
+
* instances of the OpenFin `Layout` class.
|
13372
13168
|
*
|
13373
13169
|
* @packageDocumentation
|
13374
13170
|
*
|
13171
|
+
*
|
13172
|
+
* ### Layout.DOMEvents
|
13173
|
+
*
|
13174
|
+
* When a Layout is created, it emits events onto the DOM element representing the Layout container.
|
13175
|
+
* This Layout container is the DOM element referenced by containerId in {@link Layout.LayoutModule#init Layout.init}.
|
13176
|
+
* You can use the built-in event emitter to listen to these events using [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener).
|
13177
|
+
* The events are emitted synchronously and only in the process where the Layout exists.
|
13178
|
+
* Any values returned by the called listeners are ignored and will be discarded.
|
13179
|
+
* If the target DOM element is destroyed, any events that have been set up on that element will be destroyed.
|
13180
|
+
*
|
13181
|
+
* @remarks The built-in event emitter is not an OpenFin event emitter so it doesn't share propagation semantics.
|
13182
|
+
*
|
13183
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener addEventListener(type, listener [, options]);}
|
13184
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
13185
|
+
* @example
|
13186
|
+
* ```js
|
13187
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
13188
|
+
*
|
13189
|
+
* myLayoutContainer.addEventListener('tab-created', function(event) {
|
13190
|
+
* const { tabSelector } = event.detail;
|
13191
|
+
* const tabElement = document.getElementById(tabSelector);
|
13192
|
+
* const existingColor = tabElement.style.backgroundColor;
|
13193
|
+
* tabElement.style.backgroundColor = "red";
|
13194
|
+
* setTimeout(() => {
|
13195
|
+
* tabElement.style.backgroundColor = existingColor;
|
13196
|
+
* }, 2000);
|
13197
|
+
* });
|
13198
|
+
* ```
|
13199
|
+
*
|
13200
|
+
* #### {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener removeEventListener(type, listener [, options]);}
|
13201
|
+
* Adds a listener to the end of the listeners array for the specified event.
|
13202
|
+
* @example
|
13203
|
+
* ```js
|
13204
|
+
* const myLayoutContainer = document.getElementById('layout-container');
|
13205
|
+
*
|
13206
|
+
* const listener = function(event) {
|
13207
|
+
* console.log(event.detail);
|
13208
|
+
* console.log('container-created event fired once, removing listener');
|
13209
|
+
* myLayoutContainer.removeEventListener('container-created', listener);
|
13210
|
+
* };
|
13211
|
+
*
|
13212
|
+
* myLayoutContainer.addEventListener('container-created', listener);
|
13213
|
+
* ```
|
13214
|
+
*
|
13215
|
+
* ### Supported event types are:
|
13216
|
+
*
|
13217
|
+
* * tab-created
|
13218
|
+
* * container-created
|
13219
|
+
* * layout-state-changed
|
13220
|
+
* * tab-closed
|
13221
|
+
* * tab-dropped
|
13222
|
+
*
|
13223
|
+
* ### Layout DOM Node Events
|
13224
|
+
*
|
13225
|
+
* #### tab-created
|
13226
|
+
* Generated when a tab is created. As a user drags and drops tabs within window, new tabs are created. A single view may have multiple tabs created and destroyed during its lifetime attached to a single window.
|
13227
|
+
* ```js
|
13228
|
+
* // The response has the following shape in event.detail:
|
13229
|
+
* {
|
13230
|
+
* containerSelector: "container-component_A",
|
13231
|
+
* name: "component_A",
|
13232
|
+
* tabSelector: "tab-component_A",
|
13233
|
+
* topic: "openfin-DOM-event",
|
13234
|
+
* type: "tab-created",
|
13235
|
+
* uuid: "OpenFin POC"
|
13236
|
+
* }
|
13237
|
+
* ```
|
13238
|
+
*
|
13239
|
+
* #### container-created
|
13240
|
+
* Generated when a container is created. A single view will have only one container during its lifetime attached to a single window and the container's lifecycle is tied to the view. To discover when the container is destroyed, please listen to view-detached event.
|
13241
|
+
* ```js
|
13242
|
+
* // The response has the following shape in event.detail:
|
13243
|
+
* {
|
13244
|
+
* containerSelector: "container-component_A",
|
13245
|
+
* name: "component_A",
|
13246
|
+
* tabSelector: "tab-component_A",
|
13247
|
+
* topic: "openfin-DOM-event",
|
13248
|
+
* type: "container-created",
|
13249
|
+
* uuid: "OpenFin POC"
|
13250
|
+
* }
|
13251
|
+
* ```
|
13252
|
+
*
|
13253
|
+
* ### layout-state-changed
|
13254
|
+
* Generated when the state of the layout changes in any way, such as a view added/removed/replaced. Note that this event can fire frequently as the underlying layout can change multiple components from all kinds of changes (resizing for example). Given this, it is recommended to debounce this event and then you can use the {@link Layout#getConfig Layout.getConfig} API to retrieve the most up-to-date state.
|
13255
|
+
* ```js
|
13256
|
+
* // The response has the following shape in event.detail
|
13257
|
+
* {
|
13258
|
+
* containerSelector: "container-component_A",
|
13259
|
+
* name: "component_A",
|
13260
|
+
* tabSelector: "tab-component_A",
|
13261
|
+
* topic: "openfin-DOM-event",
|
13262
|
+
* type: "layout-state-changed",
|
13263
|
+
* uuid: "OpenFin POC"
|
13264
|
+
* }
|
13265
|
+
* ```
|
13266
|
+
*
|
13267
|
+
* #### tab-closed
|
13268
|
+
* Generated when a tab is closed.
|
13269
|
+
* ```js
|
13270
|
+
* // The response has the following shape in event.detail:
|
13271
|
+
* {
|
13272
|
+
* containerSelector: "container-component_A",
|
13273
|
+
* name: "component_A",
|
13274
|
+
* tabSelector: "tab-component_A",
|
13275
|
+
* topic: "openfin-DOM-event",
|
13276
|
+
* type: "tab-closed",
|
13277
|
+
* uuid: "OpenFin POC",
|
13278
|
+
* url: "http://openfin.co" // The url of the view that was closed.
|
13279
|
+
* }
|
13280
|
+
* ```
|
13281
|
+
*
|
13282
|
+
* #### tab-dropped
|
13283
|
+
* Generated when a tab is dropped.
|
13284
|
+
* ```js
|
13285
|
+
* // The response has the following shape in event.detail:
|
13286
|
+
* {
|
13287
|
+
* containerSelector: "container-component_A",
|
13288
|
+
* name: "component_A",
|
13289
|
+
* tabSelector: "tab-component_A",
|
13290
|
+
* topic: "openfin-DOM-event",
|
13291
|
+
* type: "tab-dropped",
|
13292
|
+
* uuid: "OpenFin POC",
|
13293
|
+
* url: "http://openfin.co" // The url of the view linked to the dropped tab.
|
13294
|
+
* }
|
13295
|
+
* ```
|
13375
13296
|
*/
|
13376
13297
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
13377
13298
|
if (k2 === undefined) k2 = k;
|
@@ -13393,13 +13314,9 @@ _LayoutModule_layoutInitializationAttempted = new WeakMap();
|
|
13393
13314
|
} (layout));
|
13394
13315
|
|
13395
13316
|
Object.defineProperty(Factory$3, "__esModule", { value: true });
|
13396
|
-
|
13397
|
-
const base_1$4 = base$1;
|
13317
|
+
const base_1$4 = base;
|
13398
13318
|
const Instance_1$1 = Instance$2;
|
13399
13319
|
const index_1$1 = layout;
|
13400
|
-
/**
|
13401
|
-
* Static namespace for OpenFin API methods that interact with the {@link Platform} class, available under `fin.Platform`.
|
13402
|
-
*/
|
13403
13320
|
class PlatformModule extends base_1$4.Base {
|
13404
13321
|
/**
|
13405
13322
|
* @internal
|
@@ -13465,12 +13382,14 @@ class PlatformModule extends base_1$4.Base {
|
|
13465
13382
|
* fin.Platform.init({overrideCallback});
|
13466
13383
|
* ```
|
13467
13384
|
* @experimental
|
13385
|
+
* @static
|
13468
13386
|
*/
|
13469
13387
|
async init(options) {
|
13470
13388
|
return this.wire.environment.initPlatform(this.fin, options);
|
13471
13389
|
}
|
13472
13390
|
/**
|
13473
13391
|
* Asynchronously returns a Platform object that represents an existing platform.
|
13392
|
+
* @param identity
|
13474
13393
|
*
|
13475
13394
|
* @example
|
13476
13395
|
* ```js
|
@@ -13479,6 +13398,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13479
13398
|
* // Use wrapped instance to control layout, e.g.:
|
13480
13399
|
* const snapshot = await platform.getSnapshot();
|
13481
13400
|
* ```
|
13401
|
+
* @static
|
13482
13402
|
*/
|
13483
13403
|
async wrap(identity) {
|
13484
13404
|
this.wire.sendAction('platform-wrap').catch((e) => {
|
@@ -13488,6 +13408,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13488
13408
|
}
|
13489
13409
|
/**
|
13490
13410
|
* Synchronously returns a Platform object that represents an existing platform.
|
13411
|
+
* @param identity
|
13491
13412
|
*
|
13492
13413
|
* @example
|
13493
13414
|
* ```js
|
@@ -13496,6 +13417,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13496
13417
|
* // Use wrapped instance to control layout, e.g.:
|
13497
13418
|
* const snapshot = await platform.getSnapshot();
|
13498
13419
|
* ```
|
13420
|
+
* @static
|
13499
13421
|
*/
|
13500
13422
|
wrapSync(identity) {
|
13501
13423
|
this.wire.sendAction('platform-wrap-sync').catch((e) => {
|
@@ -13512,6 +13434,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13512
13434
|
* // Use wrapped instance to control layout, e.g.:
|
13513
13435
|
* const snapshot = await platform.getSnapshot();
|
13514
13436
|
* ```
|
13437
|
+
* @static
|
13515
13438
|
*/
|
13516
13439
|
async getCurrent() {
|
13517
13440
|
this.wire.sendAction('platform-get-current').catch((e) => {
|
@@ -13528,6 +13451,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13528
13451
|
* // Use wrapped instance to control layout, e.g.:
|
13529
13452
|
* const snapshot = await platform.getSnapshot();
|
13530
13453
|
* ```
|
13454
|
+
* @static
|
13531
13455
|
*/
|
13532
13456
|
getCurrentSync() {
|
13533
13457
|
this.wire.sendAction('platform-get-current-sync').catch((e) => {
|
@@ -13538,6 +13462,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13538
13462
|
/**
|
13539
13463
|
* Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
|
13540
13464
|
* be used to launch content into the platform. Promise will reject if the platform is already running.
|
13465
|
+
* @param platformOptions
|
13541
13466
|
*
|
13542
13467
|
* @example
|
13543
13468
|
* ```js
|
@@ -13558,6 +13483,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13558
13483
|
* console.error(e);
|
13559
13484
|
* }
|
13560
13485
|
* ```
|
13486
|
+
* @static
|
13561
13487
|
*/
|
13562
13488
|
start(platformOptions) {
|
13563
13489
|
this.wire.sendAction('platform-start').catch((e) => {
|
@@ -13602,6 +13528,7 @@ class PlatformModule extends base_1$4.Base {
|
|
13602
13528
|
* console.error(e);
|
13603
13529
|
* }
|
13604
13530
|
* ```
|
13531
|
+
* @static
|
13605
13532
|
*/
|
13606
13533
|
startFromManifest(manifestUrl, opts) {
|
13607
13534
|
this.wire.sendAction('platform-start-from-manifest').catch((e) => {
|
@@ -13624,9 +13551,18 @@ class PlatformModule extends base_1$4.Base {
|
|
13624
13551
|
});
|
13625
13552
|
}
|
13626
13553
|
}
|
13627
|
-
Factory$3.
|
13554
|
+
Factory$3.default = PlatformModule;
|
13628
13555
|
|
13629
13556
|
(function (exports) {
|
13557
|
+
/**
|
13558
|
+
* Entry point for the OpenFin Platform namespace.
|
13559
|
+
*
|
13560
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "PlatformModule" is used for
|
13561
|
+
* the module containing static members of the `Platform` namespace (available under `fin.Platform`), while `Platform` documents
|
13562
|
+
* instances of the OpenFin `Platform` class.
|
13563
|
+
*
|
13564
|
+
* @packageDocumentation
|
13565
|
+
*/
|
13630
13566
|
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
13631
13567
|
if (k2 === undefined) k2 = k;
|
13632
13568
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
@@ -13642,20 +13578,10 @@ Factory$3.PlatformModule = PlatformModule;
|
|
13642
13578
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
13643
13579
|
};
|
13644
13580
|
Object.defineProperty(exports, "__esModule", { value: true });
|
13645
|
-
|
13646
|
-
|
13647
|
-
*
|
13648
|
-
* * {@link PlatformModule} contains static members of the `Platform` API, accessible through `fin.Platform`.
|
13649
|
-
* * {@link Platform} describes an instance of an OpenFin Platform, e.g. as returned by `fin.Platform.getCurrent`.
|
13650
|
-
*
|
13651
|
-
* These are separate code entities, and are documented separately. In the [previous version of the API documentation](https://cdn.openfin.co/docs/javascript/canary/index.html),
|
13652
|
-
* both of these were documented on the same page.
|
13653
|
-
*
|
13654
|
-
* @packageDocumentation
|
13655
|
-
*/
|
13656
|
-
__exportStar(Factory$3, exports);
|
13581
|
+
const Factory_1 = Factory$3;
|
13582
|
+
exports.default = Factory_1.default;
|
13657
13583
|
__exportStar(Instance$2, exports);
|
13658
|
-
} (platform
|
13584
|
+
} (platform));
|
13659
13585
|
|
13660
13586
|
var me = {};
|
13661
13587
|
|
@@ -13663,9 +13589,9 @@ var me = {};
|
|
13663
13589
|
Object.defineProperty(exports, "__esModule", { value: true });
|
13664
13590
|
exports.getMe = exports.getBaseMe = exports.environmentUnsupportedMessage = void 0;
|
13665
13591
|
const view_1 = requireView();
|
13666
|
-
const frame_1 = frame
|
13592
|
+
const frame_1 = frame;
|
13667
13593
|
const window_1 = requireWindow();
|
13668
|
-
const external_application_1 = externalApplication
|
13594
|
+
const external_application_1 = externalApplication;
|
13669
13595
|
exports.environmentUnsupportedMessage = 'You are not running in OpenFin.';
|
13670
13596
|
function getBaseMe(entityType, uuid, name) {
|
13671
13597
|
const entityTypeHelpers = {
|
@@ -14326,7 +14252,7 @@ function requireInteropBroker () {
|
|
14326
14252
|
hasRequiredInteropBroker = 1;
|
14327
14253
|
Object.defineProperty(InteropBroker, "__esModule", { value: true });
|
14328
14254
|
InteropBroker.InteropBroker = void 0;
|
14329
|
-
const base_1 = base
|
14255
|
+
const base_1 = base;
|
14330
14256
|
const SessionContextGroupBroker_1 = requireSessionContextGroupBroker();
|
14331
14257
|
const utils_1 = utils$1;
|
14332
14258
|
const lodash_1 = require$$3;
|
@@ -14901,8 +14827,7 @@ function requireInteropBroker () {
|
|
14901
14827
|
* ```
|
14902
14828
|
*/
|
14903
14829
|
// eslint-disable-next-line class-methods-use-this
|
14904
|
-
async handleFiredIntent(intent, clientIdentity
|
14905
|
-
) {
|
14830
|
+
async handleFiredIntent(intent, clientIdentity) {
|
14906
14831
|
const warning = (0, utils_1.generateOverrideWarning)('fdc3.raiseIntent', 'InteropBroker.handleFiredIntent', clientIdentity, 'interopClient.fireIntent');
|
14907
14832
|
console.warn(warning);
|
14908
14833
|
throw new Error(utils_1.BROKER_ERRORS.fireIntent);
|
@@ -14969,7 +14894,7 @@ function requireInteropBroker () {
|
|
14969
14894
|
* More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
|
14970
14895
|
*
|
14971
14896
|
* @param options
|
14972
|
-
* @param
|
14897
|
+
* @param clientIdentity Identity of the Client making the request.
|
14973
14898
|
*
|
14974
14899
|
* @example
|
14975
14900
|
* ```js
|
@@ -14986,8 +14911,7 @@ function requireInteropBroker () {
|
|
14986
14911
|
* ```
|
14987
14912
|
*/
|
14988
14913
|
// eslint-disable-next-line class-methods-use-this
|
14989
|
-
async handleInfoForIntent(options, clientIdentity
|
14990
|
-
) {
|
14914
|
+
async handleInfoForIntent(options, clientIdentity) {
|
14991
14915
|
const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntent', 'InteropBroker.handleInfoForIntent', clientIdentity, 'interopClient.getInfoForIntent');
|
14992
14916
|
console.warn(warning);
|
14993
14917
|
throw new Error(utils_1.BROKER_ERRORS.getInfoForIntent);
|
@@ -15033,8 +14957,7 @@ function requireInteropBroker () {
|
|
15033
14957
|
* ```
|
15034
14958
|
*/
|
15035
14959
|
// eslint-disable-next-line class-methods-use-this
|
15036
|
-
async handleInfoForIntentsByContext(context, clientIdentity
|
15037
|
-
) {
|
14960
|
+
async handleInfoForIntentsByContext(context, clientIdentity) {
|
15038
14961
|
const warning = (0, utils_1.generateOverrideWarning)('fdc3.findIntentsByContext', 'InteropBroker.handleInfoForIntentsByContext', clientIdentity, 'interopClient.getInfoForIntentsByContext');
|
15039
14962
|
console.warn(warning);
|
15040
14963
|
throw new Error(utils_1.BROKER_ERRORS.getInfoForIntentsByContext);
|
@@ -15060,7 +14983,7 @@ function requireInteropBroker () {
|
|
15060
14983
|
* More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
|
15061
14984
|
*
|
15062
14985
|
* @param contextForIntent Data passed between entities and applications.
|
15063
|
-
* @param
|
14986
|
+
* @param clientIdentity Identity of the Client making the request.
|
15064
14987
|
*
|
15065
14988
|
* @example
|
15066
14989
|
* ```js
|
@@ -15121,7 +15044,7 @@ function requireInteropBroker () {
|
|
15121
15044
|
/**
|
15122
15045
|
* Responsible for resolving the fdc3.findInstances call.
|
15123
15046
|
* Must be overridden
|
15124
|
-
* @param
|
15047
|
+
* @param app AppIdentifier that was passed to fdc3.findInstances
|
15125
15048
|
* @param clientIdentity Identity of the Client making the request.
|
15126
15049
|
*/
|
15127
15050
|
// eslint-disable-next-line class-methods-use-this
|
@@ -15156,7 +15079,7 @@ function requireInteropBroker () {
|
|
15156
15079
|
* fin.Platform.init({
|
15157
15080
|
* interopOverride: async (InteropBroker) => {
|
15158
15081
|
* class Override extends InteropBroker {
|
15159
|
-
* async invokeContextHandler(
|
15082
|
+
* async invokeContextHandler(options, clientIdentity) {
|
15160
15083
|
* return super.invokeContextHandler(clientIdentity, handlerId, {
|
15161
15084
|
* ...context,
|
15162
15085
|
* contextMetadata: {
|
@@ -15196,7 +15119,7 @@ function requireInteropBroker () {
|
|
15196
15119
|
* fin.Platform.init({
|
15197
15120
|
* interopOverride: async (InteropBroker) => {
|
15198
15121
|
* class Override extends InteropBroker {
|
15199
|
-
* async invokeIntentHandler(
|
15122
|
+
* async invokeIntentHandler(options, clientIdentity) {
|
15200
15123
|
* const { context } = intent;
|
15201
15124
|
* return super.invokeIntentHandler(clientIdentity, handlerId, {
|
15202
15125
|
* ...intent,
|
@@ -15535,8 +15458,7 @@ function requireInteropBroker () {
|
|
15535
15458
|
}
|
15536
15459
|
// Setup Channel Connection Logic
|
15537
15460
|
wireChannel(channel) {
|
15538
|
-
channel.onConnection(async (clientIdentity,
|
15539
|
-
payload) => {
|
15461
|
+
channel.onConnection(async (clientIdentity, payload) => {
|
15540
15462
|
if (!(await this.isConnectionAuthorized(clientIdentity, payload))) {
|
15541
15463
|
throw new Error(`Connection not authorized for ${clientIdentity.uuid}, ${clientIdentity.name}`);
|
15542
15464
|
}
|
@@ -15660,7 +15582,7 @@ var __classPrivateFieldGet$3 = (commonjsGlobal && commonjsGlobal.__classPrivateF
|
|
15660
15582
|
};
|
15661
15583
|
var _SessionContextGroupClient_clientPromise;
|
15662
15584
|
Object.defineProperty(SessionContextGroupClient$1, "__esModule", { value: true });
|
15663
|
-
const base_1$3 = base
|
15585
|
+
const base_1$3 = base;
|
15664
15586
|
const utils_1$3 = utils$1;
|
15665
15587
|
class SessionContextGroupClient extends base_1$3.Base {
|
15666
15588
|
constructor(wire, client, id) {
|
@@ -15747,7 +15669,7 @@ var __classPrivateFieldGet$2 = (commonjsGlobal && commonjsGlobal.__classPrivateF
|
|
15747
15669
|
var _InteropClient_clientPromise, _InteropClient_sessionContextGroups;
|
15748
15670
|
Object.defineProperty(InteropClient$1, "__esModule", { value: true });
|
15749
15671
|
InteropClient$1.InteropClient = void 0;
|
15750
|
-
const base_1$2 = base
|
15672
|
+
const base_1$2 = base;
|
15751
15673
|
const SessionContextGroupClient_1 = SessionContextGroupClient$1;
|
15752
15674
|
const utils_1$2 = utils$1;
|
15753
15675
|
/**
|
@@ -16416,46 +16338,39 @@ class InteropClient extends base_1$2.Base {
|
|
16416
16338
|
InteropClient$1.InteropClient = InteropClient;
|
16417
16339
|
_InteropClient_clientPromise = new WeakMap(), _InteropClient_sessionContextGroups = new WeakMap();
|
16418
16340
|
|
16419
|
-
var overrideCheck = {};
|
16341
|
+
var overrideCheck$1 = {};
|
16420
16342
|
|
16421
|
-
|
16422
|
-
|
16423
|
-
|
16424
|
-
|
16425
|
-
|
16426
|
-
|
16427
|
-
|
16428
|
-
const InteropBroker_1 = requireInteropBroker();
|
16429
|
-
function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
|
16430
|
-
var _a, _b, _c, _d;
|
16431
|
-
const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
|
16432
|
-
return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
|
16433
|
-
}
|
16434
|
-
overrideCheck.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
|
16435
|
-
// TODO: Unit test this
|
16436
|
-
function overrideCheck$1(overriddenBroker, fdc3InteropApi) {
|
16437
|
-
if (fdc3InteropApi && fdc3InteropApi === '2.0') {
|
16438
|
-
const mustOverrideAPIs = [
|
16439
|
-
'fdc3HandleFindInstances',
|
16440
|
-
'handleInfoForIntent',
|
16441
|
-
'handleInfoForIntentsByContext',
|
16442
|
-
'fdc3HandleGetAppMetadata',
|
16443
|
-
'fdc3HandleGetInfo',
|
16444
|
-
'fdc3HandleOpen',
|
16445
|
-
'handleFiredIntent',
|
16446
|
-
'handleFiredIntentForContext'
|
16447
|
-
];
|
16448
|
-
const notOverridden = mustOverrideAPIs.filter((api) => {
|
16449
|
-
return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
|
16450
|
-
});
|
16451
|
-
if (notOverridden.length > 0) {
|
16452
|
-
console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
|
16453
|
-
}
|
16454
|
-
}
|
16455
|
-
}
|
16456
|
-
overrideCheck.overrideCheck = overrideCheck$1;
|
16457
|
-
return overrideCheck;
|
16343
|
+
Object.defineProperty(overrideCheck$1, "__esModule", { value: true });
|
16344
|
+
overrideCheck$1.overrideCheck = overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = void 0;
|
16345
|
+
const InteropBroker_1 = requireInteropBroker();
|
16346
|
+
function getDefaultViewFdc3VersionFromAppInfo({ manifest, initialOptions }) {
|
16347
|
+
var _a, _b, _c, _d;
|
16348
|
+
const setVersion = (_c = (_b = (_a = manifest.platform) === null || _a === void 0 ? void 0 : _a.defaultViewOptions) === null || _b === void 0 ? void 0 : _b.fdc3InteropApi) !== null && _c !== void 0 ? _c : (_d = initialOptions.defaultViewOptions) === null || _d === void 0 ? void 0 : _d.fdc3InteropApi;
|
16349
|
+
return ['1.2', '2.0'].includes(setVersion !== null && setVersion !== void 0 ? setVersion : '') ? setVersion : undefined;
|
16458
16350
|
}
|
16351
|
+
overrideCheck$1.getDefaultViewFdc3VersionFromAppInfo = getDefaultViewFdc3VersionFromAppInfo;
|
16352
|
+
// TODO: Unit test this
|
16353
|
+
function overrideCheck(overriddenBroker, fdc3InteropApi) {
|
16354
|
+
if (fdc3InteropApi && fdc3InteropApi === '2.0') {
|
16355
|
+
const mustOverrideAPIs = [
|
16356
|
+
'fdc3HandleFindInstances',
|
16357
|
+
'handleInfoForIntent',
|
16358
|
+
'handleInfoForIntentsByContext',
|
16359
|
+
'fdc3HandleGetAppMetadata',
|
16360
|
+
'fdc3HandleGetInfo',
|
16361
|
+
'fdc3HandleOpen',
|
16362
|
+
'handleFiredIntent',
|
16363
|
+
'handleFiredIntentForContext'
|
16364
|
+
];
|
16365
|
+
const notOverridden = mustOverrideAPIs.filter((api) => {
|
16366
|
+
return overriddenBroker[api] === InteropBroker_1.InteropBroker.prototype[api];
|
16367
|
+
});
|
16368
|
+
if (notOverridden.length > 0) {
|
16369
|
+
console.warn(`WARNING: FDC3 2.0 has been set as a default option for Views in this Platform, but the required InteropBroker APIs for FDC3 2.0 compliance have not all been overridden.\nThe following APIs need to be overridden:\n${notOverridden.join('\n')}`);
|
16370
|
+
}
|
16371
|
+
}
|
16372
|
+
}
|
16373
|
+
overrideCheck$1.overrideCheck = overrideCheck;
|
16459
16374
|
|
16460
16375
|
var hasRequiredFactory;
|
16461
16376
|
|
@@ -16463,13 +16378,12 @@ function requireFactory () {
|
|
16463
16378
|
if (hasRequiredFactory) return Factory$1;
|
16464
16379
|
hasRequiredFactory = 1;
|
16465
16380
|
Object.defineProperty(Factory$1, "__esModule", { value: true });
|
16466
|
-
Factory$1.InteropModule = void 0;
|
16467
16381
|
const lodash_1 = require$$3;
|
16468
16382
|
const inaccessibleObject_1 = inaccessibleObject;
|
16469
|
-
const base_1 = base
|
16383
|
+
const base_1 = base;
|
16470
16384
|
const InteropBroker_1 = requireInteropBroker();
|
16471
16385
|
const InteropClient_1 = InteropClient$1;
|
16472
|
-
const overrideCheck_1 =
|
16386
|
+
const overrideCheck_1 = overrideCheck$1;
|
16473
16387
|
const common_utils_1 = commonUtils;
|
16474
16388
|
const defaultOverride = (Class) => new Class();
|
16475
16389
|
const BrokerParamAccessError = 'You have attempted to use or modify InteropBroker parameters, which is not allowed. You are likely using an older InteropBroker override scheme. Please consult our Interop docs for guidance on migrating to the new override scheme.';
|
@@ -16500,6 +16414,7 @@ function requireFactory () {
|
|
16500
16414
|
* const contextGroups = await interopBroker.getContextGroups();
|
16501
16415
|
* console.log(contextGroups);
|
16502
16416
|
* ```
|
16417
|
+
* @static
|
16503
16418
|
*/
|
16504
16419
|
async init(name, override = defaultOverride) {
|
16505
16420
|
var _a;
|
@@ -16557,6 +16472,7 @@ function requireFactory () {
|
|
16557
16472
|
* const contextGroupInfo = await client.getInfoForContextGroup();
|
16558
16473
|
* console.log(contextGroupInfo);
|
16559
16474
|
* ```
|
16475
|
+
* @static
|
16560
16476
|
*/
|
16561
16477
|
connectSync(name, interopConfig) {
|
16562
16478
|
this.wire.sendAction('interop-connect-sync').catch(() => {
|
@@ -16565,7 +16481,7 @@ function requireFactory () {
|
|
16565
16481
|
return new InteropClient_1.InteropClient(this.wire, name, interopConfig);
|
16566
16482
|
}
|
16567
16483
|
}
|
16568
|
-
Factory$1.
|
16484
|
+
Factory$1.default = InteropModule;
|
16569
16485
|
return Factory$1;
|
16570
16486
|
}
|
16571
16487
|
|
@@ -16576,10 +16492,10 @@ function requireInterop () {
|
|
16576
16492
|
hasRequiredInterop = 1;
|
16577
16493
|
(function (exports) {
|
16578
16494
|
/**
|
16579
|
-
* Entry point for the OpenFin
|
16495
|
+
* Entry point for the OpenFin Interop namespace.
|
16580
16496
|
*
|
16581
|
-
*
|
16582
|
-
*
|
16497
|
+
* "InteropModule" contains static members of the `Interop` namespace (available under `fin.Interop`), while `InteropClient` and
|
16498
|
+
* `InteropBroker` document instances of their respective classes.
|
16583
16499
|
*
|
16584
16500
|
* @packageDocumentation
|
16585
16501
|
*/
|
@@ -16598,7 +16514,8 @@ function requireInterop () {
|
|
16598
16514
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
16599
16515
|
};
|
16600
16516
|
Object.defineProperty(exports, "__esModule", { value: true });
|
16601
|
-
|
16517
|
+
const Factory_1 = requireFactory();
|
16518
|
+
exports.default = Factory_1.default;
|
16602
16519
|
__exportStar(InteropClient$1, exports);
|
16603
16520
|
__exportStar(requireInteropBroker(), exports);
|
16604
16521
|
} (interop));
|
@@ -16634,14 +16551,12 @@ var _SnapshotSource_identity, _SnapshotSource_getConnection, _SnapshotSource_get
|
|
16634
16551
|
Object.defineProperty(Instance, "__esModule", { value: true });
|
16635
16552
|
Instance.SnapshotSource = void 0;
|
16636
16553
|
/* eslint-disable @typescript-eslint/no-non-null-assertion */
|
16637
|
-
const base_1$1 = base
|
16554
|
+
const base_1$1 = base;
|
16638
16555
|
const utils_1$1 = utils;
|
16639
16556
|
const connectionMap = new Map();
|
16640
16557
|
/**
|
16641
16558
|
* Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.
|
16642
16559
|
*
|
16643
|
-
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
16644
|
-
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
16645
16560
|
*/
|
16646
16561
|
class SnapshotSource extends base_1$1.Base {
|
16647
16562
|
/**
|
@@ -16776,19 +16691,13 @@ Instance.SnapshotSource = SnapshotSource;
|
|
16776
16691
|
_SnapshotSource_identity = new WeakMap(), _SnapshotSource_getConnection = new WeakMap(), _SnapshotSource_getClient = new WeakMap(), _SnapshotSource_startConnection = new WeakMap(), _SnapshotSource_setUpConnectionListener = new WeakMap();
|
16777
16692
|
|
16778
16693
|
Object.defineProperty(Factory, "__esModule", { value: true });
|
16779
|
-
|
16780
|
-
const base_1 = base$1;
|
16694
|
+
const base_1 = base;
|
16781
16695
|
const Instance_1 = Instance;
|
16782
16696
|
const utils_1 = utils;
|
16783
|
-
/**
|
16784
|
-
* Static namespace for OpenFin API methods that interact with the {@link SnapshotSource} class, available under `fin.SnapshotSource`.
|
16785
|
-
*/
|
16786
16697
|
class SnapshotSourceModule extends base_1.Base {
|
16787
16698
|
/**
|
16788
16699
|
* Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
|
16789
|
-
*
|
16790
|
-
* @typeParam Snapshot Implementation-defined shape of an application snapshot. Allows
|
16791
|
-
* custom snapshot implementations for legacy applications to define their own snapshot format.
|
16700
|
+
* @param provider
|
16792
16701
|
*
|
16793
16702
|
* @example
|
16794
16703
|
* ```js
|
@@ -16805,7 +16714,7 @@ class SnapshotSourceModule extends base_1.Base {
|
|
16805
16714
|
*
|
16806
16715
|
* await fin.SnapshotSource.init(snapshotProvider);
|
16807
16716
|
* ```
|
16808
|
-
*
|
16717
|
+
* @static
|
16809
16718
|
*/
|
16810
16719
|
async init(provider) {
|
16811
16720
|
this.wire.sendAction('snapshot-source-init').catch((e) => {
|
@@ -16825,6 +16734,7 @@ class SnapshotSourceModule extends base_1.Base {
|
|
16825
16734
|
}
|
16826
16735
|
/**
|
16827
16736
|
* Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
16737
|
+
* @param identity
|
16828
16738
|
*
|
16829
16739
|
* @example
|
16830
16740
|
* ```js
|
@@ -16832,6 +16742,7 @@ class SnapshotSourceModule extends base_1.Base {
|
|
16832
16742
|
* // Use wrapped instance's getSnapshot method, e.g.:
|
16833
16743
|
* const snapshot = await snapshotSource.getSnapshot();
|
16834
16744
|
* ```
|
16745
|
+
* @static
|
16835
16746
|
*/
|
16836
16747
|
wrapSync(identity) {
|
16837
16748
|
this.wire.sendAction('snapshot-source-wrap-sync').catch((e) => {
|
@@ -16841,6 +16752,7 @@ class SnapshotSourceModule extends base_1.Base {
|
|
16841
16752
|
}
|
16842
16753
|
/**
|
16843
16754
|
* Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
|
16755
|
+
* @param identity
|
16844
16756
|
*
|
16845
16757
|
* @example
|
16846
16758
|
* ```js
|
@@ -16848,6 +16760,7 @@ class SnapshotSourceModule extends base_1.Base {
|
|
16848
16760
|
* // Use wrapped instance's getSnapshot method, e.g.:
|
16849
16761
|
* const snapshot = await snapshotSource.getSnapshot();
|
16850
16762
|
* ```
|
16763
|
+
* @static
|
16851
16764
|
*/
|
16852
16765
|
async wrap(identity) {
|
16853
16766
|
this.wire.sendAction('snapshot-source-wrap').catch((e) => {
|
@@ -16856,17 +16769,15 @@ class SnapshotSourceModule extends base_1.Base {
|
|
16856
16769
|
return this.wrapSync(identity);
|
16857
16770
|
}
|
16858
16771
|
}
|
16859
|
-
Factory.
|
16772
|
+
Factory.default = SnapshotSourceModule;
|
16860
16773
|
|
16861
16774
|
(function (exports) {
|
16862
16775
|
/**
|
16863
|
-
* Entry
|
16864
|
-
*
|
16865
|
-
* * {@link SnapshotSourceModule} contains static members of the `SnapshotSource` API, accessible through `fin.SnapshotSource`.
|
16866
|
-
* * {@link SnapshotSource} describes an instance of an OpenFin SnapshotSource, e.g. as returned by `fin.SnapshotSource.wrap`.
|
16776
|
+
* Entry point for the OpenFin SnapshotSource namespace.
|
16867
16777
|
*
|
16868
|
-
*
|
16869
|
-
*
|
16778
|
+
* Because TypeDoc does not currently support multiple modules with the same name, the module alias "SnapshotSourceModule" is used for
|
16779
|
+
* the module containing static members of the `SnapshotSource` namespace (available under `fin.SnapshotSource`), while `SnapshotSource` documents
|
16780
|
+
* instances of the OpenFin `SnapshotSource` class.
|
16870
16781
|
*
|
16871
16782
|
* @packageDocumentation
|
16872
16783
|
*/
|
@@ -16885,30 +16796,27 @@ Factory.SnapshotSourceModule = SnapshotSourceModule;
|
|
16885
16796
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
16886
16797
|
};
|
16887
16798
|
Object.defineProperty(exports, "__esModule", { value: true });
|
16888
|
-
|
16799
|
+
const Factory_1 = Factory;
|
16800
|
+
exports.default = Factory_1.default;
|
16889
16801
|
__exportStar(Instance, exports);
|
16890
16802
|
} (snapshotSource));
|
16891
16803
|
|
16892
16804
|
Object.defineProperty(fin, "__esModule", { value: true });
|
16893
|
-
fin.Fin = void 0;
|
16894
16805
|
const events_1$3 = eventsExports;
|
16895
16806
|
// Import from the file rather than the directory in case someone consuming types is using module resolution other than "node"
|
16896
|
-
const index_1 = system
|
16807
|
+
const index_1 = system;
|
16897
16808
|
const index_2 = requireWindow();
|
16898
16809
|
const index_3 = requireApplication();
|
16899
16810
|
const index_4 = interappbus;
|
16900
16811
|
const index_5 = clipboard;
|
16901
|
-
const index_6 = externalApplication
|
16902
|
-
const index_7 = frame
|
16903
|
-
const index_8 = globalHotkey
|
16812
|
+
const index_6 = externalApplication;
|
16813
|
+
const index_7 = frame;
|
16814
|
+
const index_8 = globalHotkey;
|
16904
16815
|
const index_9 = requireView();
|
16905
|
-
const index_10 = platform
|
16816
|
+
const index_10 = platform;
|
16906
16817
|
const me_1$1 = me;
|
16907
16818
|
const interop_1 = requireInterop();
|
16908
16819
|
const snapshot_source_1 = snapshotSource;
|
16909
|
-
/**
|
16910
|
-
* @internal
|
16911
|
-
*/
|
16912
16820
|
class Fin extends events_1$3.EventEmitter {
|
16913
16821
|
/**
|
16914
16822
|
* @internal
|
@@ -16916,18 +16824,18 @@ class Fin extends events_1$3.EventEmitter {
|
|
16916
16824
|
constructor(wire) {
|
16917
16825
|
super();
|
16918
16826
|
this.wire = wire;
|
16919
|
-
this.System = new index_1.
|
16920
|
-
this.Window = new index_2.
|
16921
|
-
this.Application = new index_3.
|
16922
|
-
this.InterApplicationBus = new index_4.
|
16923
|
-
this.Clipboard = new index_5.
|
16924
|
-
this.ExternalApplication = new index_6.
|
16925
|
-
this.Frame = new index_7.
|
16926
|
-
this.GlobalHotkey = new index_8.
|
16927
|
-
this.Platform = new index_10.
|
16928
|
-
this.View = new index_9.
|
16929
|
-
this.Interop = new interop_1.
|
16930
|
-
this.SnapshotSource = new snapshot_source_1.
|
16827
|
+
this.System = new index_1.default(wire);
|
16828
|
+
this.Window = new index_2.default(wire);
|
16829
|
+
this.Application = new index_3.default(wire);
|
16830
|
+
this.InterApplicationBus = new index_4.default(wire);
|
16831
|
+
this.Clipboard = new index_5.default(wire);
|
16832
|
+
this.ExternalApplication = new index_6.default(wire);
|
16833
|
+
this.Frame = new index_7.default(wire);
|
16834
|
+
this.GlobalHotkey = new index_8.default(wire);
|
16835
|
+
this.Platform = new index_10.default(wire, this.InterApplicationBus.Channel);
|
16836
|
+
this.View = new index_9.default(wire);
|
16837
|
+
this.Interop = new interop_1.default(wire);
|
16838
|
+
this.SnapshotSource = new snapshot_source_1.default(wire);
|
16931
16839
|
wire.registerFin(this);
|
16932
16840
|
this.me = (0, me_1$1.getMe)(wire);
|
16933
16841
|
// Handle disconnect events
|
@@ -16936,7 +16844,7 @@ class Fin extends events_1$3.EventEmitter {
|
|
16936
16844
|
});
|
16937
16845
|
}
|
16938
16846
|
}
|
16939
|
-
fin.
|
16847
|
+
fin.default = Fin;
|
16940
16848
|
|
16941
16849
|
var wire = {};
|
16942
16850
|
|
@@ -18238,7 +18146,7 @@ function requireMain () {
|
|
18238
18146
|
Object.defineProperty(exports, "__esModule", { value: true });
|
18239
18147
|
exports.ChannelProvider = exports.ChannelClient = exports.Frame = exports.View = exports.System = exports.Window = exports.Application = exports.Fin = exports.launch = exports.connect = void 0;
|
18240
18148
|
const fin_1 = fin;
|
18241
|
-
|
18149
|
+
exports.Fin = fin_1.default;
|
18242
18150
|
const index_1 = requireApplication();
|
18243
18151
|
Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return index_1.Application; } });
|
18244
18152
|
const window_1 = requireWindow();
|
@@ -18246,13 +18154,13 @@ function requireMain () {
|
|
18246
18154
|
const view_1 = requireView();
|
18247
18155
|
Object.defineProperty(exports, "View", { enumerable: true, get: function () { return view_1.View; } });
|
18248
18156
|
const client_1 = client;
|
18249
|
-
|
18157
|
+
exports.ChannelClient = client_1.default;
|
18250
18158
|
const provider_1 = provider;
|
18251
18159
|
Object.defineProperty(exports, "ChannelProvider", { enumerable: true, get: function () { return provider_1.ChannelProvider; } });
|
18252
|
-
const frame_1 = frame
|
18160
|
+
const frame_1 = frame;
|
18253
18161
|
Object.defineProperty(exports, "Frame", { enumerable: true, get: function () { return frame_1._Frame; } });
|
18254
|
-
const system_1 = system
|
18255
|
-
|
18162
|
+
const system_1 = system;
|
18163
|
+
exports.System = system_1.default;
|
18256
18164
|
const wire_1 = wire;
|
18257
18165
|
const node_env_1 = requireNodeEnv();
|
18258
18166
|
const transport_1 = transport;
|
@@ -18269,7 +18177,7 @@ function requireMain () {
|
|
18269
18177
|
name: (_a = normalized.name) !== null && _a !== void 0 ? _a : normalized.uuid
|
18270
18178
|
});
|
18271
18179
|
await wire.connect(normalized);
|
18272
|
-
return new fin_1.
|
18180
|
+
return new fin_1.default(wire);
|
18273
18181
|
}
|
18274
18182
|
exports.connect = connect;
|
18275
18183
|
async function launch(config) {
|
@@ -18287,261 +18195,15 @@ function requireMain () {
|
|
18287
18195
|
|
18288
18196
|
var mainExports = requireMain();
|
18289
18197
|
|
18290
|
-
var OpenFin$
|
18291
|
-
|
18292
|
-
var events = {};
|
18293
|
-
|
18294
|
-
var application = {};
|
18295
|
-
|
18296
|
-
/**
|
18297
|
-
* Namespace for events that can be emitted by an {@link OpenFin.Application}. Includes events
|
18298
|
-
* re-propagated from the {@link OpenFin.Window} (and, transitively, {@link OpenFin.View}) level, prefixed with `window-` (and also, if applicable, `view-`).
|
18299
|
-
* For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
|
18300
|
-
*
|
18301
|
-
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18302
|
-
*
|
18303
|
-
* This namespace contains only payload shapes for events that are unique to `Application`. Events that propagate to `Application` from
|
18304
|
-
* child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
|
18305
|
-
* {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all* application events, see {@link Application.on Application.on}.
|
18306
|
-
*
|
18307
|
-
* {@link ApplicationSourcedEvent Application-sourced events} (i.e. those that have not propagated from {@link OpenFin.ViewEvents Views}
|
18308
|
-
* or {@link OpenFin.WindowEvents Windows} re-propagate to {@link OpenFin.SystemEvents System} with their type string prefixed with `application-`.
|
18309
|
-
* {@link ApplicationWindowEvent Application events that are tied to Windows but do not propagate from them}
|
18310
|
-
* are propagated to `System` without any type string prefixing.
|
18311
|
-
*
|
18312
|
-
* "Requested" events (e.g. {@link RunRequestedEvent}) do not propagate.
|
18313
|
-
*
|
18314
|
-
* @packageDocumentation
|
18315
|
-
*/
|
18316
|
-
Object.defineProperty(application, "__esModule", { value: true });
|
18317
|
-
|
18318
|
-
var base = {};
|
18319
|
-
|
18320
|
-
/**
|
18321
|
-
* Namespace for shared event payloads and utility types common to all event emitters.
|
18322
|
-
*
|
18323
|
-
* @packageDocumentation
|
18324
|
-
*/
|
18325
|
-
Object.defineProperty(base, "__esModule", { value: true });
|
18326
|
-
|
18327
|
-
var externalApplication = {};
|
18328
|
-
|
18329
|
-
/**
|
18330
|
-
* Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
|
18331
|
-
*
|
18332
|
-
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18333
|
-
*
|
18334
|
-
* For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
|
18335
|
-
*
|
18336
|
-
* @packageDocumentation
|
18337
|
-
*/
|
18338
|
-
Object.defineProperty(externalApplication, "__esModule", { value: true });
|
18339
|
-
|
18340
|
-
var frame = {};
|
18341
|
-
|
18342
|
-
Object.defineProperty(frame, "__esModule", { value: true });
|
18343
|
-
|
18344
|
-
var globalHotkey = {};
|
18345
|
-
|
18346
|
-
Object.defineProperty(globalHotkey, "__esModule", { value: true });
|
18347
|
-
|
18348
|
-
var platform = {};
|
18349
|
-
|
18350
|
-
/**
|
18351
|
-
*
|
18352
|
-
* Namespace for events that can emitted by a {@link OpenFin.Platform}.
|
18353
|
-
*
|
18354
|
-
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18355
|
-
*
|
18356
|
-
* The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
|
18357
|
-
* meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
|
18358
|
-
* Platform-specific events listed here. For a list of valid string keys for *all* platform events, see
|
18359
|
-
* {@link Platform.on Platform.on}.
|
18360
|
-
*
|
18361
|
-
* @packageDocumentation
|
18362
|
-
*/
|
18363
|
-
Object.defineProperty(platform, "__esModule", { value: true });
|
18364
|
-
|
18365
|
-
var system = {};
|
18366
|
-
|
18367
|
-
/**
|
18368
|
-
* Namespace for runtime-wide OpenFin events emitted by {@link System.System}. Includes events
|
18369
|
-
* re-propagated from {@link OpenFin.Application}, {@link OpenFin.Window}, and {@link OpenFin.View} (prefixed with `application-`, `window-`, and `view-`). All
|
18370
|
-
* event propagations are visible at the System level. Propagated events from WebContents (windows, views, frames) to the Application level will *not*
|
18371
|
-
* transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
|
18372
|
-
* of the application. For example, an application's "closed" event will fire as 'application-closed' at the system level. A view's 'shown' event
|
18373
|
-
* will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
|
18374
|
-
*
|
18375
|
-
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18376
|
-
*
|
18377
|
-
* This namespace contains only payload shapes for events that are unique to `System`. Events that propagate to `System` from
|
18378
|
-
* child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
|
18379
|
-
* {@link OpenFin.ApplicationEvents}, {@link OpenFin.WindowEvents}, and {@link OpenFin.ViewEvents} namespaces. For a list of valid string keys for *all*
|
18380
|
-
* system events, see {@link System.on System.on}.
|
18381
|
-
*
|
18382
|
-
* @packageDocumentation
|
18383
|
-
*/
|
18384
|
-
Object.defineProperty(system, "__esModule", { value: true });
|
18385
|
-
|
18386
|
-
var view = {};
|
18387
|
-
|
18388
|
-
/**
|
18389
|
-
* Namespace for events that can be emitted by a {@link OpenFin.View}.
|
18390
|
-
*
|
18391
|
-
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18392
|
-
*
|
18393
|
-
* This namespace contains only payload shapes for events that are unique to `View`. Events that are shared between all `WebContents`
|
18394
|
-
* (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. For a list
|
18395
|
-
* of valid string keys for *all* View events, see {@link View.on View.on}.
|
18396
|
-
*
|
18397
|
-
* View events propagate to their parent {@link OpenFin.WindowEvents Window}, {@link OpenFin.ApplicationEvents Application},
|
18398
|
-
* and {@link OpenFin.SystemEvents System} with an added `viewIdentity` property and their event types prefixed with `'view-'`.
|
18399
|
-
*
|
18400
|
-
* @packageDocumentation
|
18401
|
-
*/
|
18402
|
-
Object.defineProperty(view, "__esModule", { value: true });
|
18403
|
-
|
18404
|
-
var webcontents = {};
|
18405
|
-
|
18406
|
-
/**
|
18407
|
-
* Namespace for events shared by all OpenFin WebContents elements (i.e. {@link OpenFin.Window},
|
18408
|
-
* {@link OpenFin.View}).
|
18409
|
-
*
|
18410
|
-
* WebContents events are divided into two groups: {@link WillPropagateWebContentsEvent} and {@link NonPropagatedWebContentsEvent}. Propagating events
|
18411
|
-
* will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
|
18412
|
-
* parent window, and propagating events in a window will also be emitted on the window's parent {@link OpenFin.Application}.
|
18413
|
-
*
|
18414
|
-
* Non-propagating events will not re-emit on parent entities.
|
18415
|
-
*
|
18416
|
-
* @packageDocumentation
|
18417
|
-
*/
|
18418
|
-
Object.defineProperty(webcontents, "__esModule", { value: true });
|
18419
|
-
|
18420
|
-
var window$1 = {};
|
18421
|
-
|
18422
|
-
/**
|
18423
|
-
* Namespace for events that can be emitted by a {@link OpenFin.Window}.
|
18424
|
-
*
|
18425
|
-
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18426
|
-
*
|
18427
|
-
* This namespace contains only payload shapes for events that are unique to `Window`. Events that are shared between all `WebContents`
|
18428
|
-
* (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
|
18429
|
-
* propagate from `View` are defined in {@link OpenFin.ViewEvents}. For a list of valid string keys for *all* Window events, see
|
18430
|
-
* {@link Window.on Window.on}
|
18431
|
-
*
|
18432
|
-
* {@link OpenFin.WindowEvents.WindowSourcedEvent Window-sourced events} (i.e. those that are not propagated from a
|
18433
|
-
* {@link OpenFin.ViewEvents View}) propagate to their parent {@link OpenFin.ApplicationEvents Application} and
|
18434
|
-
* {@link OpenFin.SystemEvents System} with their event types prefixed with `'window-'`).
|
18435
|
-
*
|
18436
|
-
* "Requested" events (e.g. {@link AuthRequestedEvent}) do not propagate to `System. The {@link OpenFin.WindowEvents.WindowCloseRequestedEvent}
|
18437
|
-
* does not propagate at all.
|
18438
|
-
*
|
18439
|
-
* @packageDocumentation
|
18440
|
-
*/
|
18441
|
-
Object.defineProperty(window$1, "__esModule", { value: true });
|
18442
|
-
|
18443
|
-
/**
|
18444
|
-
* Namespace for OpenFin event types. Each entity that emits OpenFin events has its own sub-namespace. Event payloads
|
18445
|
-
* themselves are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
18446
|
-
*
|
18447
|
-
* #### Event emitters
|
18448
|
-
*
|
18449
|
-
* The following entities emit OpenFin events, and have corresponding sub-namespaces:
|
18450
|
-
*
|
18451
|
-
* * {@link OpenFin.Application}: {@link OpenFin.ApplicationEvents}
|
18452
|
-
* * {@link OpenFin.ExternalApplication}: {@link OpenFin.ExternalApplicationEvents}
|
18453
|
-
* * {@link OpenFin.Frame}: {@link OpenFin.FrameEvents}
|
18454
|
-
* * {@link OpenFin.GlobalHotkey}: {@link OpenFin.GlobalHotkeyEvents}
|
18455
|
-
* * {@link OpenFin.Platform}: {@link OpenFin.PlatformEvents}
|
18456
|
-
* * {@link OpenFin.System}: {@link OpenFin.SystemEvents}
|
18457
|
-
* * {@link OpenFin.View}: {@link OpenFin.ViewEvents}
|
18458
|
-
* * {@link OpenFin.Window}: {@link OpenFin.WindowEvents}
|
18459
|
-
*
|
18460
|
-
* These `EventEmitter` entities share a common set of methods for interacting with the OpenFin event bus, which can be
|
18461
|
-
* seen on the individual documentation pages for each entity type.
|
18462
|
-
*
|
18463
|
-
* Registering event handlers is an asynchronous operation. It is important to ensure that the returned Promises are awaited to reduce the
|
18464
|
-
* risk of race conditions.
|
18465
|
-
*
|
18466
|
-
* When the `EventEmitter` receives an event from the browser process and emits on the renderer, all of the functions attached to that
|
18467
|
-
* specific event are called synchronously. Any values returned by the called listeners are ignored and will be discarded. If the window document
|
18468
|
-
* is destroyed by page navigation or reload, its registered event listeners will be removed.
|
18469
|
-
*
|
18470
|
-
* We recommend using Arrow Functions for event listeners to ensure the this scope is consistent with the original function context.
|
18471
|
-
*
|
18472
|
-
* Events re-propagate from smaller/more-local scopes to larger/more-global scopes. For example, an event emitted on a specific
|
18473
|
-
* view will propagate to the window in which the view is embedded, and then to the application in which the window is running, and
|
18474
|
-
* finally to the OpenFin runtime itself at the "system" level. For details on propagation semantics, see the namespace for
|
18475
|
-
* the propagating (or propagated-to) entity.
|
18476
|
-
*
|
18477
|
-
* If you need the payload type for a specific type of event (especially propagated events), use the emitting topic's `Payload` generic
|
18478
|
-
* (e.g. {@link WindowEvents.Payload}) with the event's `type` string. For example, the payload of
|
18479
|
-
* a {@link ViewEvents.CreatedEvent} after it has propagated to its parent {@link WindowEvents Window} can be found with
|
18480
|
-
* `WindowEvents.Payload<'view-created'>`.
|
18481
|
-
*
|
18482
|
-
* @packageDocumentation
|
18483
|
-
*/
|
18484
|
-
Object.defineProperty(events, "__esModule", { value: true });
|
18485
|
-
events.WindowEvents = events.WebContentsEvents = events.ViewEvents = events.SystemEvents = events.PlatformEvents = events.GlobalHotkeyEvents = events.FrameEvents = events.ExternalApplicationEvents = events.BaseEvents = events.ApplicationEvents = void 0;
|
18486
|
-
const ApplicationEvents = application;
|
18487
|
-
events.ApplicationEvents = ApplicationEvents;
|
18488
|
-
const BaseEvents = base;
|
18489
|
-
events.BaseEvents = BaseEvents;
|
18490
|
-
const ExternalApplicationEvents = externalApplication;
|
18491
|
-
events.ExternalApplicationEvents = ExternalApplicationEvents;
|
18492
|
-
const FrameEvents = frame;
|
18493
|
-
events.FrameEvents = FrameEvents;
|
18494
|
-
const GlobalHotkeyEvents = globalHotkey;
|
18495
|
-
events.GlobalHotkeyEvents = GlobalHotkeyEvents;
|
18496
|
-
const PlatformEvents = platform;
|
18497
|
-
events.PlatformEvents = PlatformEvents;
|
18498
|
-
const SystemEvents = system;
|
18499
|
-
events.SystemEvents = SystemEvents;
|
18500
|
-
const ViewEvents = view;
|
18501
|
-
events.ViewEvents = ViewEvents;
|
18502
|
-
const WebContentsEvents = webcontents;
|
18503
|
-
events.WebContentsEvents = WebContentsEvents;
|
18504
|
-
const WindowEvents = window$1;
|
18505
|
-
events.WindowEvents = WindowEvents;
|
18506
|
-
|
18507
|
-
(function (exports) {
|
18508
|
-
/**
|
18509
|
-
* Top-level namespace for types referenced by the OpenFin API. Contains:
|
18510
|
-
*
|
18511
|
-
* * The type of the global `fin` entry point ({@link FinApi})
|
18512
|
-
* * Classes that act as static namespaces returned from the `fin` global (e.g. {@link ApplicationModule}, accessible via `fin.Application`)
|
18513
|
-
* * Instance classes that are returned from API calls (e.g. {@link Application}, accessible via `fin.Application.getCurrentSync()`)
|
18514
|
-
* * Parameter shapes for API methods (e.g. {@link ApplicationOptions}, used in `fin.Application.start()`)
|
18515
|
-
* * Event namespaces and payload union types (e.g. {@link ApplicationEvents} and {@link ApplicationEvent})
|
18516
|
-
*
|
18517
|
-
* @packageDocumentation
|
18518
|
-
*/
|
18519
|
-
var __createBinding = (commonjsGlobal && commonjsGlobal.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
18520
|
-
if (k2 === undefined) k2 = k;
|
18521
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
18522
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
18523
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
18524
|
-
}
|
18525
|
-
Object.defineProperty(o, k2, desc);
|
18526
|
-
}) : (function(o, m, k, k2) {
|
18527
|
-
if (k2 === undefined) k2 = k;
|
18528
|
-
o[k2] = m[k];
|
18529
|
-
}));
|
18530
|
-
var __exportStar = (commonjsGlobal && commonjsGlobal.__exportStar) || function(m, exports) {
|
18531
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
18532
|
-
};
|
18533
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
18534
|
-
// Deprecated shim to preserve v30 namespace names
|
18535
|
-
__exportStar(events, exports);
|
18536
|
-
} (OpenFin$2));
|
18198
|
+
var OpenFin$1 = {};
|
18537
18199
|
|
18538
|
-
|
18200
|
+
Object.defineProperty(OpenFin$1, "__esModule", { value: true });
|
18539
18201
|
|
18540
|
-
var OpenFin
|
18202
|
+
var OpenFin = /*#__PURE__*/_mergeNamespaces({
|
18541
18203
|
__proto__: null,
|
18542
|
-
default: OpenFin
|
18543
|
-
}, [OpenFin$
|
18204
|
+
default: OpenFin$1
|
18205
|
+
}, [OpenFin$1]);
|
18544
18206
|
|
18545
18207
|
exports.connect = mainExports.connect;
|
18546
|
-
exports.default = OpenFin
|
18208
|
+
exports.default = OpenFin;
|
18547
18209
|
exports.launch = mainExports.launch;
|