@openfin/core 25.68.30 → 25.70.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/OpenFin.d.ts +30 -826
  2. package/README.md +12 -2
  3. package/package.json +1 -1
  4. package/src/api/application/Factory.d.ts +145 -145
  5. package/src/api/application/Factory.js +229 -229
  6. package/src/api/application/Instance.d.ts +301 -302
  7. package/src/api/application/Instance.js +412 -412
  8. package/src/api/application/index.d.ts +3 -3
  9. package/src/api/application/index.js +15 -15
  10. package/src/api/base.d.ts +43 -43
  11. package/src/api/base.js +177 -177
  12. package/src/api/clipboard/index.d.ts +69 -69
  13. package/src/api/clipboard/index.js +88 -88
  14. package/src/api/events/application.d.ts +69 -0
  15. package/src/api/events/application.js +2 -0
  16. package/src/api/events/base.d.ts +17 -0
  17. package/src/api/events/base.js +2 -0
  18. package/src/api/events/channel.d.ts +10 -11
  19. package/src/api/events/channel.js +2 -2
  20. package/src/api/events/emitterMap.d.ts +11 -11
  21. package/src/api/events/emitterMap.js +35 -35
  22. package/src/api/events/eventAggregator.d.ts +5 -5
  23. package/src/api/events/eventAggregator.js +43 -43
  24. package/src/api/events/externalApplication.d.ts +5 -0
  25. package/src/api/events/externalApplication.js +2 -0
  26. package/src/api/events/frame.d.ts +9 -0
  27. package/src/api/events/frame.js +2 -0
  28. package/src/api/events/globalHotkey.d.ts +10 -0
  29. package/src/api/events/globalHotkey.js +2 -0
  30. package/src/api/events/platform.d.ts +18 -0
  31. package/src/api/events/platform.js +2 -0
  32. package/src/api/events/system.d.ts +22 -0
  33. package/src/api/events/system.js +2 -0
  34. package/src/api/events/view.d.ts +56 -0
  35. package/src/api/events/view.js +2 -0
  36. package/src/api/events/webcontents.d.ts +48 -0
  37. package/src/api/events/webcontents.js +2 -0
  38. package/src/api/events/window.d.ts +176 -0
  39. package/src/api/events/window.js +2 -0
  40. package/src/api/external-application/Factory.d.ts +26 -26
  41. package/src/api/external-application/Factory.js +40 -40
  42. package/src/api/external-application/Instance.d.ts +101 -102
  43. package/src/api/external-application/Instance.js +109 -109
  44. package/src/api/external-application/index.d.ts +3 -3
  45. package/src/api/external-application/index.js +15 -15
  46. package/src/api/fin.d.ts +49 -49
  47. package/src/api/fin.js +43 -43
  48. package/src/api/frame/Factory.d.ts +36 -36
  49. package/src/api/frame/Factory.js +69 -69
  50. package/src/api/frame/Instance.d.ts +121 -121
  51. package/src/api/frame/Instance.js +130 -130
  52. package/src/api/frame/index.d.ts +3 -3
  53. package/src/api/frame/index.js +15 -15
  54. package/src/api/global-hotkey/index.d.ts +38 -38
  55. package/src/api/global-hotkey/index.js +58 -58
  56. package/src/api/interappbus/channel/channel.d.ts +26 -26
  57. package/src/api/interappbus/channel/channel.js +77 -77
  58. package/src/api/interappbus/channel/channels-docs.d.ts +318 -318
  59. package/src/api/interappbus/channel/channels-docs.js +376 -376
  60. package/src/api/interappbus/channel/client.d.ts +22 -22
  61. package/src/api/interappbus/channel/client.js +84 -84
  62. package/src/api/interappbus/channel/connection-manager.d.ts +28 -28
  63. package/src/api/interappbus/channel/connection-manager.js +244 -244
  64. package/src/api/interappbus/channel/index.d.ts +22 -23
  65. package/src/api/interappbus/channel/index.js +121 -121
  66. package/src/api/interappbus/channel/protocols/classic/message-receiver.d.ts +13 -13
  67. package/src/api/interappbus/channel/protocols/classic/message-receiver.js +73 -73
  68. package/src/api/interappbus/channel/protocols/classic/strategy.d.ts +22 -22
  69. package/src/api/interappbus/channel/protocols/classic/strategy.js +84 -84
  70. package/src/api/interappbus/channel/protocols/combined/strategy.d.ts +20 -20
  71. package/src/api/interappbus/channel/protocols/combined/strategy.js +58 -58
  72. package/src/api/interappbus/channel/protocols/index.d.ts +44 -44
  73. package/src/api/interappbus/channel/protocols/index.js +2 -2
  74. package/src/api/interappbus/channel/protocols/protocol-manager.d.ts +10 -10
  75. package/src/api/interappbus/channel/protocols/protocol-manager.js +43 -43
  76. package/src/api/interappbus/channel/protocols/rtc/endpoint.d.ts +23 -23
  77. package/src/api/interappbus/channel/protocols/rtc/endpoint.js +135 -135
  78. package/src/api/interappbus/channel/protocols/rtc/ice-manager.d.ts +30 -30
  79. package/src/api/interappbus/channel/protocols/rtc/ice-manager.js +131 -131
  80. package/src/api/interappbus/channel/protocols/rtc/strategy.d.ts +22 -22
  81. package/src/api/interappbus/channel/protocols/rtc/strategy.js +87 -87
  82. package/src/api/interappbus/channel/protocols/strategy-types.d.ts +13 -13
  83. package/src/api/interappbus/channel/protocols/strategy-types.js +2 -2
  84. package/src/api/interappbus/channel/protocols/strategy.d.ts +15 -15
  85. package/src/api/interappbus/channel/protocols/strategy.js +2 -2
  86. package/src/api/interappbus/channel/provider.d.ts +31 -31
  87. package/src/api/interappbus/channel/provider.js +160 -160
  88. package/src/api/interappbus/index.d.ts +85 -86
  89. package/src/api/interappbus/index.js +175 -175
  90. package/src/api/interop/Factory.d.ts +37 -37
  91. package/src/api/interop/Factory.js +54 -54
  92. package/src/api/interop/InteropBroker.d.ts +363 -363
  93. package/src/api/interop/InteropBroker.js +914 -914
  94. package/src/api/interop/InteropClient.d.ts +268 -268
  95. package/src/api/interop/InteropClient.js +450 -450
  96. package/src/api/interop/SessionContextGroupBroker.d.ts +26 -26
  97. package/src/api/interop/SessionContextGroupBroker.js +107 -107
  98. package/src/api/interop/SessionContextGroupClient.d.ts +20 -20
  99. package/src/api/interop/SessionContextGroupClient.js +85 -85
  100. package/src/api/interop/fdc3/fdc3-1.2.d.ts +187 -187
  101. package/src/api/interop/fdc3/fdc3-1.2.js +385 -385
  102. package/src/api/interop/fdc3/fdc3.js +17 -17
  103. package/src/api/interop/fdc3/utils.d.ts +6 -6
  104. package/src/api/interop/fdc3/utils.js +17 -17
  105. package/src/api/interop/index.d.ts +4 -4
  106. package/src/api/interop/index.js +16 -16
  107. package/src/api/interop/utils.d.ts +11 -11
  108. package/src/api/interop/utils.js +36 -36
  109. package/src/api/me.d.ts +38 -35
  110. package/src/api/me.js +128 -60
  111. package/src/api/platform/Factory.d.ts +109 -109
  112. package/src/api/platform/Factory.js +188 -188
  113. package/src/api/platform/Instance.d.ts +122 -122
  114. package/src/api/platform/Instance.js +298 -298
  115. package/src/api/platform/common-utils.d.ts +6 -6
  116. package/src/api/platform/common-utils.js +16 -16
  117. package/src/api/platform/index.d.ts +3 -3
  118. package/src/api/platform/index.js +15 -15
  119. package/src/api/platform/layout/Factory.d.ts +108 -108
  120. package/src/api/platform/layout/Factory.js +189 -189
  121. package/src/api/platform/layout/Instance.d.ts +49 -49
  122. package/src/api/platform/layout/Instance.js +99 -99
  123. package/src/api/platform/layout/index.d.ts +2 -2
  124. package/src/api/platform/layout/index.js +14 -14
  125. package/src/api/platform/layout/shapes.d.ts +11 -0
  126. package/src/api/{window → platform/layout}/shapes.js +2 -2
  127. package/src/api/snapshot-source/Factory.d.ts +36 -36
  128. package/src/api/snapshot-source/Factory.js +65 -65
  129. package/src/api/snapshot-source/Instance.d.ts +30 -30
  130. package/src/api/snapshot-source/Instance.js +134 -134
  131. package/src/api/snapshot-source/index.d.ts +3 -3
  132. package/src/api/snapshot-source/index.js +15 -15
  133. package/src/api/snapshot-source/utils.d.ts +1 -1
  134. package/src/api/snapshot-source/utils.js +5 -5
  135. package/src/api/system/index.d.ts +960 -961
  136. package/src/api/system/index.js +1241 -1241
  137. package/src/api/view/Factory.d.ts +49 -49
  138. package/src/api/view/Factory.js +103 -103
  139. package/src/api/view/Instance.d.ts +387 -380
  140. package/src/api/view/Instance.js +422 -415
  141. package/src/api/view/index.d.ts +3 -3
  142. package/src/api/view/index.js +15 -15
  143. package/src/api/webcontents/main.d.ts +36 -36
  144. package/src/api/webcontents/main.js +82 -82
  145. package/src/api/window/Factory.d.ts +44 -44
  146. package/src/api/window/Factory.js +91 -91
  147. package/src/api/window/Instance.d.ts +972 -966
  148. package/src/api/window/Instance.js +1209 -1202
  149. package/src/api/window/index.d.ts +3 -5
  150. package/src/api/window/index.js +15 -17
  151. package/src/environment/environment.d.ts +28 -25
  152. package/src/environment/environment.js +4 -4
  153. package/src/environment/node-env.d.ts +25 -26
  154. package/src/environment/node-env.js +64 -64
  155. package/src/environment/openfin-env.d.ts +29 -30
  156. package/src/environment/openfin-env.js +107 -107
  157. package/src/mock.d.ts +3 -3
  158. package/src/mock.js +91 -90
  159. package/src/shapes/ERROR_BOX_TYPES.d.ts +1 -0
  160. package/src/shapes/ERROR_BOX_TYPES.js +2 -0
  161. package/src/shapes/WebOptions.d.ts +12 -0
  162. package/src/shapes/WebOptions.js +2 -0
  163. package/src/shapes/WindowOptions.d.ts +42 -0
  164. package/src/shapes/WindowOptions.js +2 -0
  165. package/src/shapes/protocol.d.ts +178 -0
  166. package/src/shapes/protocol.js +2 -0
  167. package/src/transport/fin_store.d.ts +4 -4
  168. package/src/transport/fin_store.js +16 -16
  169. package/src/transport/transport-errors.d.ts +18 -18
  170. package/src/transport/transport-errors.js +37 -37
  171. package/src/transport/transport.d.ts +56 -43
  172. package/src/transport/transport.js +181 -181
  173. package/src/transport/wire.d.ts +71 -11
  174. package/src/transport/wire.js +32 -32
  175. package/src/util/asyncFilter.d.ts +1 -1
  176. package/src/util/asyncFilter.js +7 -7
  177. package/src/util/errors.d.ts +9 -5
  178. package/src/util/errors.js +11 -11
  179. package/src/util/exhaustive.d.ts +1 -1
  180. package/src/util/exhaustive.js +7 -7
  181. package/src/util/http.d.ts +11 -11
  182. package/src/util/http.js +83 -83
  183. package/src/util/normalize-config.d.ts +3 -5
  184. package/src/util/normalize-config.js +47 -47
  185. package/src/util/promises.d.ts +5 -5
  186. package/src/util/promises.js +27 -27
  187. package/src/util/ref-counter.d.ts +7 -7
  188. package/src/util/ref-counter.js +51 -51
  189. package/src/util/runtimeVersioning.d.ts +3 -3
  190. package/src/util/runtimeVersioning.js +25 -25
  191. package/src/util/utilTypes.d.ts +8 -8
  192. package/src/util/utilTypes.js +2 -2
  193. package/src/util/validate.d.ts +3 -3
  194. package/src/util/validate.js +11 -11
  195. package/docs.README(OLD).md +0 -82
  196. package/resources/win/OpenFinRVM.exe +0 -0
  197. package/src/api/window/bounds-changed.d.ts +0 -10
  198. package/src/api/window/bounds-changed.js +0 -6
  199. package/src/api/window/shapes.d.ts +0 -13
@@ -1,69 +1,69 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const base_1 = require("../base");
4
- const validate_1 = require("../../util/validate");
5
- const Instance_1 = require("./Instance");
6
- /**
7
- * @lends Frame
8
- */
9
- class _FrameModule extends base_1.Base {
10
- /**
11
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
12
- * @param {Identity} identity - the identity of the frame you want to wrap
13
- * @return {Promise.<_Frame>}
14
- * @tutorial Frame.wrap
15
- * @static
16
- */
17
- async wrap(identity) {
18
- this.wire.sendAction('frame-wrap').catch((e) => {
19
- // we do not want to expose this error, just continue if this analytics-only call fails
20
- });
21
- const errorMsg = validate_1.validateIdentity(identity);
22
- if (errorMsg) {
23
- throw new Error(errorMsg);
24
- }
25
- return new Instance_1._Frame(this.wire, identity);
26
- }
27
- /**
28
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
29
- * @param {Identity} identity - the identity of the frame you want to wrap
30
- * @return {_Frame}
31
- * @tutorial Frame.wrapSync
32
- * @static
33
- */
34
- wrapSync(identity) {
35
- this.wire.sendAction('frame-wrap-sync').catch((e) => {
36
- // we do not want to expose this error, just continue if this analytics-only call fails
37
- });
38
- const errorMsg = validate_1.validateIdentity(identity);
39
- if (errorMsg) {
40
- throw new Error(errorMsg);
41
- }
42
- return new Instance_1._Frame(this.wire, identity);
43
- }
44
- /**
45
- * Asynchronously returns a reference to the current frame
46
- * @return {Promise.<_Frame>}
47
- * @tutorial Frame.getCurrent
48
- * @static
49
- */
50
- getCurrent() {
51
- this.wire.sendAction('frame-get-current').catch((e) => {
52
- // we do not want to expose this error, just continue if this analytics-only call fails
53
- });
54
- return Promise.resolve(new Instance_1._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity()));
55
- }
56
- /**
57
- * Synchronously returns a reference to the current frame
58
- * @return {_Frame}
59
- * @tutorial Frame.getCurrentSync
60
- * @static
61
- */
62
- getCurrentSync() {
63
- this.wire.sendAction('frame-get-current-sync').catch((e) => {
64
- // we do not want to expose this error, just continue if this analytics-only call fails
65
- });
66
- return new Instance_1._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
67
- }
68
- }
69
- exports.default = _FrameModule;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const base_1 = require("../base");
4
+ const validate_1 = require("../../util/validate");
5
+ const Instance_1 = require("./Instance");
6
+ /**
7
+ * @lends Frame
8
+ */
9
+ class _FrameModule extends base_1.Base {
10
+ /**
11
+ * Asynchronously returns a reference to the specified frame. The frame does not have to exist
12
+ * @param {Identity} identity - the identity of the frame you want to wrap
13
+ * @return {Promise.<_Frame>}
14
+ * @tutorial Frame.wrap
15
+ * @static
16
+ */
17
+ async wrap(identity) {
18
+ this.wire.sendAction('frame-wrap').catch((e) => {
19
+ // we do not want to expose this error, just continue if this analytics-only call fails
20
+ });
21
+ const errorMsg = validate_1.validateIdentity(identity);
22
+ if (errorMsg) {
23
+ throw new Error(errorMsg);
24
+ }
25
+ return new Instance_1._Frame(this.wire, identity);
26
+ }
27
+ /**
28
+ * Synchronously returns a reference to the specified frame. The frame does not have to exist
29
+ * @param {Identity} identity - the identity of the frame you want to wrap
30
+ * @return {_Frame}
31
+ * @tutorial Frame.wrapSync
32
+ * @static
33
+ */
34
+ wrapSync(identity) {
35
+ this.wire.sendAction('frame-wrap-sync').catch((e) => {
36
+ // we do not want to expose this error, just continue if this analytics-only call fails
37
+ });
38
+ const errorMsg = validate_1.validateIdentity(identity);
39
+ if (errorMsg) {
40
+ throw new Error(errorMsg);
41
+ }
42
+ return new Instance_1._Frame(this.wire, identity);
43
+ }
44
+ /**
45
+ * Asynchronously returns a reference to the current frame
46
+ * @return {Promise.<_Frame>}
47
+ * @tutorial Frame.getCurrent
48
+ * @static
49
+ */
50
+ getCurrent() {
51
+ this.wire.sendAction('frame-get-current').catch((e) => {
52
+ // we do not want to expose this error, just continue if this analytics-only call fails
53
+ });
54
+ return Promise.resolve(new Instance_1._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity()));
55
+ }
56
+ /**
57
+ * Synchronously returns a reference to the current frame
58
+ * @return {_Frame}
59
+ * @tutorial Frame.getCurrentSync
60
+ * @static
61
+ */
62
+ getCurrentSync() {
63
+ this.wire.sendAction('frame-get-current-sync').catch((e) => {
64
+ // we do not want to expose this error, just continue if this analytics-only call fails
65
+ });
66
+ return new Instance_1._Frame(this.wire, this.wire.environment.getCurrentEntityIdentity());
67
+ }
68
+ }
69
+ exports.default = _FrameModule;
@@ -1,121 +1,121 @@
1
- import { EmitterBase } from '../base';
2
- import Transport from '../../transport/transport';
3
- import FrameEvents = OpenFin.FrameEvents;
4
- /**
5
- * @classdesc
6
- * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
7
- * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
8
- * on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin
9
- * connection. Iframes may be generated dynamically, or be present on initial page load and each non-CORS
10
- * iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having
11
- * the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes
12
- * from getting the API injected you can set api.frame.sameOriginInjection
13
- * to false <a href="Window.html#~options" target="_blank">(see Window~options)</a>.
14
- *
15
- * To be able to directly address this context for eventing and messaging purposes, it needs a
16
- * unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration
17
- * object in the form of a manifest URL or options object, but there is no configuration object for iframes.
18
- * Just as a call to window.open outside of our Window API returns a new window with a random GUID assigned
19
- * for the name, each iframe that has the API injected will be assigned a GUID as its name, the UUID will be
20
- * the same as the parent window's.
21
- *
22
- * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
23
- * (iframe or main window) as well as the ability to listen for <a href="tutorial-Frame.EventEmitter.html">frame-specific events</a>.
24
- * @class
25
- * @alias Frame
26
- * @hideconstructor
27
- */
28
- export declare class _Frame extends EmitterBase<FrameEvents> {
29
- identity: OpenFin.Identity;
30
- constructor(wire: Transport, identity: OpenFin.Identity);
31
- /**
32
- * Adds the listener function to the end of the listeners array for the specified event type.
33
- * @param { string | symbol } eventType - The type of the event.
34
- * @param { Function } listener - Called whenever an event of the specified type occurs.
35
- * @param { SubOptions } [options] - Option to support event timestamps.
36
- * @return {Promise.<this>}
37
- * @function addListener
38
- * @memberof Frame
39
- * @instance
40
- * @tutorial Frame.EventEmitter
41
- */
42
- /**
43
- * Adds a listener to the end of the listeners array for the specified event.
44
- * @param { string | symbol } eventType - The type of the event.
45
- * @param { Function } listener - Called whenever an event of the specified type occurs.
46
- * @param { SubOptions } [options] - Option to support event timestamps.
47
- * @return {Promise.<this>}
48
- * @function on
49
- * @memberof Frame
50
- * @instance
51
- * @tutorial Frame.EventEmitter
52
- */
53
- /**
54
- * 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.
55
- * @param { string | symbol } eventType - The type of the event.
56
- * @param { Function } listener - The callback function.
57
- * @param { SubOptions } [options] - Option to support event timestamps.
58
- * @return {Promise.<this>}
59
- * @function once
60
- * @memberof Frame
61
- * @instance
62
- * @tutorial Frame.EventEmitter
63
- */
64
- /**
65
- * Adds a listener to the beginning of the listeners array for the specified event.
66
- * @param { string | symbol } eventType - The type of the event.
67
- * @param { Function } listener - The callback function.
68
- * @param { SubOptions } [options] - Option to support event timestamps.
69
- * @return {Promise.<this>}
70
- * @function prependListener
71
- * @memberof Frame
72
- * @instance
73
- * @tutorial Frame.EventEmitter
74
- */
75
- /**
76
- * 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.
77
- * The listener is added to the beginning of the listeners array.
78
- * @param { string | symbol } eventType - The type of the event.
79
- * @param { Function } listener - The callback function.
80
- * @param { SubOptions } [options] - Option to support event timestamps.
81
- * @return {Promise.<this>}
82
- * @function prependOnceListener
83
- * @memberof Frame
84
- * @instance
85
- * @tutorial Frame.EventEmitter
86
- */
87
- /**
88
- * Remove a listener from the listener array for the specified event.
89
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
90
- * @param { string | symbol } eventType - The type of the event.
91
- * @param { Function } listener - The callback function.
92
- * @param { SubOptions } [options] - Option to support event timestamps.
93
- * @return {Promise.<this>}
94
- * @function removeListener
95
- * @memberof Frame
96
- * @instance
97
- * @tutorial Frame.EventEmitter
98
- */
99
- /**
100
- * Removes all listeners, or those of the specified event.
101
- * @param { string | symbol } [eventType] - The type of the event.
102
- * @return {Promise.<this>}
103
- * @function removeAllListeners
104
- * @memberof Frame
105
- * @instance
106
- * @tutorial Frame.EventEmitter
107
- */
108
- /**
109
- * Returns a frame info object for the represented frame
110
- * @return {Promise.<FrameInfo>}
111
- * @tutorial Frame.getInfo
112
- */
113
- getInfo(): Promise<OpenFin.FrameInfo>;
114
- /**
115
- * Returns a frame info object representing the window that the referenced iframe is
116
- * currently embedded in
117
- * @return {Promise.<FrameInfo>}
118
- * @tutorial Frame.getParentWindow
119
- */
120
- getParentWindow(): Promise<OpenFin.FrameInfo>;
121
- }
1
+ import { EmitterBase } from '../base';
2
+ import Transport from '../../transport/transport';
3
+ import FrameEvents = OpenFin.FrameEvents;
4
+ /**
5
+ * @classdesc
6
+ * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
7
+ * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
8
+ * on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin
9
+ * connection. Iframes may be generated dynamically, or be present on initial page load and each non-CORS
10
+ * iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having
11
+ * the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes
12
+ * from getting the API injected you can set api.frame.sameOriginInjection
13
+ * to false <a href="Window.html#~options" target="_blank">(see Window~options)</a>.
14
+ *
15
+ * To be able to directly address this context for eventing and messaging purposes, it needs a
16
+ * unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration
17
+ * object in the form of a manifest URL or options object, but there is no configuration object for iframes.
18
+ * Just as a call to window.open outside of our Window API returns a new window with a random GUID assigned
19
+ * for the name, each iframe that has the API injected will be assigned a GUID as its name, the UUID will be
20
+ * the same as the parent window's.
21
+ *
22
+ * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
23
+ * (iframe or main window) as well as the ability to listen for <a href="tutorial-Frame.EventEmitter.html">frame-specific events</a>.
24
+ * @class
25
+ * @alias Frame
26
+ * @hideconstructor
27
+ */
28
+ export declare class _Frame extends EmitterBase<FrameEvents> {
29
+ identity: OpenFin.Identity;
30
+ constructor(wire: Transport, identity: OpenFin.Identity);
31
+ /**
32
+ * Adds the listener function to the end of the listeners array for the specified event type.
33
+ * @param { string | symbol } eventType - The type of the event.
34
+ * @param { Function } listener - Called whenever an event of the specified type occurs.
35
+ * @param { SubOptions } [options] - Option to support event timestamps.
36
+ * @return {Promise.<this>}
37
+ * @function addListener
38
+ * @memberof Frame
39
+ * @instance
40
+ * @tutorial Frame.EventEmitter
41
+ */
42
+ /**
43
+ * Adds a listener to the end of the listeners array for the specified event.
44
+ * @param { string | symbol } eventType - The type of the event.
45
+ * @param { Function } listener - Called whenever an event of the specified type occurs.
46
+ * @param { SubOptions } [options] - Option to support event timestamps.
47
+ * @return {Promise.<this>}
48
+ * @function on
49
+ * @memberof Frame
50
+ * @instance
51
+ * @tutorial Frame.EventEmitter
52
+ */
53
+ /**
54
+ * 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.
55
+ * @param { string | symbol } eventType - The type of the event.
56
+ * @param { Function } listener - The callback function.
57
+ * @param { SubOptions } [options] - Option to support event timestamps.
58
+ * @return {Promise.<this>}
59
+ * @function once
60
+ * @memberof Frame
61
+ * @instance
62
+ * @tutorial Frame.EventEmitter
63
+ */
64
+ /**
65
+ * Adds a listener to the beginning of the listeners array for the specified event.
66
+ * @param { string | symbol } eventType - The type of the event.
67
+ * @param { Function } listener - The callback function.
68
+ * @param { SubOptions } [options] - Option to support event timestamps.
69
+ * @return {Promise.<this>}
70
+ * @function prependListener
71
+ * @memberof Frame
72
+ * @instance
73
+ * @tutorial Frame.EventEmitter
74
+ */
75
+ /**
76
+ * 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.
77
+ * The listener is added to the beginning of the listeners array.
78
+ * @param { string | symbol } eventType - The type of the event.
79
+ * @param { Function } listener - The callback function.
80
+ * @param { SubOptions } [options] - Option to support event timestamps.
81
+ * @return {Promise.<this>}
82
+ * @function prependOnceListener
83
+ * @memberof Frame
84
+ * @instance
85
+ * @tutorial Frame.EventEmitter
86
+ */
87
+ /**
88
+ * Remove a listener from the listener array for the specified event.
89
+ * Caution: Calling this method changes the array indices in the listener array behind the listener.
90
+ * @param { string | symbol } eventType - The type of the event.
91
+ * @param { Function } listener - The callback function.
92
+ * @param { SubOptions } [options] - Option to support event timestamps.
93
+ * @return {Promise.<this>}
94
+ * @function removeListener
95
+ * @memberof Frame
96
+ * @instance
97
+ * @tutorial Frame.EventEmitter
98
+ */
99
+ /**
100
+ * Removes all listeners, or those of the specified event.
101
+ * @param { string | symbol } [eventType] - The type of the event.
102
+ * @return {Promise.<this>}
103
+ * @function removeAllListeners
104
+ * @memberof Frame
105
+ * @instance
106
+ * @tutorial Frame.EventEmitter
107
+ */
108
+ /**
109
+ * Returns a frame info object for the represented frame
110
+ * @return {Promise.<FrameInfo>}
111
+ * @tutorial Frame.getInfo
112
+ */
113
+ getInfo(): Promise<OpenFin.FrameInfo>;
114
+ /**
115
+ * Returns a frame info object representing the window that the referenced iframe is
116
+ * currently embedded in
117
+ * @return {Promise.<FrameInfo>}
118
+ * @tutorial Frame.getParentWindow
119
+ */
120
+ getParentWindow(): Promise<OpenFin.FrameInfo>;
121
+ }
@@ -1,130 +1,130 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports._Frame = void 0;
4
- /* eslint-disable import/prefer-default-export */
5
- const base_1 = require("../base");
6
- /**
7
- * @classdesc
8
- * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
9
- * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
10
- * on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin
11
- * connection. Iframes may be generated dynamically, or be present on initial page load and each non-CORS
12
- * iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having
13
- * the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes
14
- * from getting the API injected you can set api.frame.sameOriginInjection
15
- * to false <a href="Window.html#~options" target="_blank">(see Window~options)</a>.
16
- *
17
- * To be able to directly address this context for eventing and messaging purposes, it needs a
18
- * unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration
19
- * object in the form of a manifest URL or options object, but there is no configuration object for iframes.
20
- * Just as a call to window.open outside of our Window API returns a new window with a random GUID assigned
21
- * for the name, each iframe that has the API injected will be assigned a GUID as its name, the UUID will be
22
- * the same as the parent window's.
23
- *
24
- * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
25
- * (iframe or main window) as well as the ability to listen for <a href="tutorial-Frame.EventEmitter.html">frame-specific events</a>.
26
- * @class
27
- * @alias Frame
28
- * @hideconstructor
29
- */
30
- class _Frame extends base_1.EmitterBase {
31
- constructor(wire, identity) {
32
- super(wire, 'frame', identity.uuid, identity.name);
33
- this.identity = identity;
34
- }
35
- /**
36
- * Adds the listener function to the end of the listeners array for the specified event type.
37
- * @param { string | symbol } eventType - The type of the event.
38
- * @param { Function } listener - Called whenever an event of the specified type occurs.
39
- * @param { SubOptions } [options] - Option to support event timestamps.
40
- * @return {Promise.<this>}
41
- * @function addListener
42
- * @memberof Frame
43
- * @instance
44
- * @tutorial Frame.EventEmitter
45
- */
46
- /**
47
- * Adds a listener to the end of the listeners array for the specified event.
48
- * @param { string | symbol } eventType - The type of the event.
49
- * @param { Function } listener - Called whenever an event of the specified type occurs.
50
- * @param { SubOptions } [options] - Option to support event timestamps.
51
- * @return {Promise.<this>}
52
- * @function on
53
- * @memberof Frame
54
- * @instance
55
- * @tutorial Frame.EventEmitter
56
- */
57
- /**
58
- * 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.
59
- * @param { string | symbol } eventType - The type of the event.
60
- * @param { Function } listener - The callback function.
61
- * @param { SubOptions } [options] - Option to support event timestamps.
62
- * @return {Promise.<this>}
63
- * @function once
64
- * @memberof Frame
65
- * @instance
66
- * @tutorial Frame.EventEmitter
67
- */
68
- /**
69
- * Adds a listener to the beginning of the listeners array for the specified event.
70
- * @param { string | symbol } eventType - The type of the event.
71
- * @param { Function } listener - The callback function.
72
- * @param { SubOptions } [options] - Option to support event timestamps.
73
- * @return {Promise.<this>}
74
- * @function prependListener
75
- * @memberof Frame
76
- * @instance
77
- * @tutorial Frame.EventEmitter
78
- */
79
- /**
80
- * 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.
81
- * The listener is added to the beginning of the listeners array.
82
- * @param { string | symbol } eventType - The type of the event.
83
- * @param { Function } listener - The callback function.
84
- * @param { SubOptions } [options] - Option to support event timestamps.
85
- * @return {Promise.<this>}
86
- * @function prependOnceListener
87
- * @memberof Frame
88
- * @instance
89
- * @tutorial Frame.EventEmitter
90
- */
91
- /**
92
- * Remove a listener from the listener array for the specified event.
93
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
94
- * @param { string | symbol } eventType - The type of the event.
95
- * @param { Function } listener - The callback function.
96
- * @param { SubOptions } [options] - Option to support event timestamps.
97
- * @return {Promise.<this>}
98
- * @function removeListener
99
- * @memberof Frame
100
- * @instance
101
- * @tutorial Frame.EventEmitter
102
- */
103
- /**
104
- * Removes all listeners, or those of the specified event.
105
- * @param { string | symbol } [eventType] - The type of the event.
106
- * @return {Promise.<this>}
107
- * @function removeAllListeners
108
- * @memberof Frame
109
- * @instance
110
- * @tutorial Frame.EventEmitter
111
- */
112
- /**
113
- * Returns a frame info object for the represented frame
114
- * @return {Promise.<FrameInfo>}
115
- * @tutorial Frame.getInfo
116
- */
117
- getInfo() {
118
- return this.wire.sendAction('get-frame-info', this.identity).then(({ payload }) => payload.data);
119
- }
120
- /**
121
- * Returns a frame info object representing the window that the referenced iframe is
122
- * currently embedded in
123
- * @return {Promise.<FrameInfo>}
124
- * @tutorial Frame.getParentWindow
125
- */
126
- getParentWindow() {
127
- return this.wire.sendAction('get-parent-window', this.identity).then(({ payload }) => payload.data);
128
- }
129
- }
130
- exports._Frame = _Frame;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports._Frame = void 0;
4
+ /* eslint-disable import/prefer-default-export */
5
+ const base_1 = require("../base");
6
+ /**
7
+ * @classdesc
8
+ * An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page
9
+ * has its own DOM and global JS context (which may or may not be linked to that of the parent depending
10
+ * on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin
11
+ * connection. Iframes may be generated dynamically, or be present on initial page load and each non-CORS
12
+ * iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having
13
+ * the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes
14
+ * from getting the API injected you can set api.frame.sameOriginInjection
15
+ * to false <a href="Window.html#~options" target="_blank">(see Window~options)</a>.
16
+ *
17
+ * To be able to directly address this context for eventing and messaging purposes, it needs a
18
+ * unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration
19
+ * object in the form of a manifest URL or options object, but there is no configuration object for iframes.
20
+ * Just as a call to window.open outside of our Window API returns a new window with a random GUID assigned
21
+ * for the name, each iframe that has the API injected will be assigned a GUID as its name, the UUID will be
22
+ * the same as the parent window's.
23
+ *
24
+ * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
25
+ * (iframe or main window) as well as the ability to listen for <a href="tutorial-Frame.EventEmitter.html">frame-specific events</a>.
26
+ * @class
27
+ * @alias Frame
28
+ * @hideconstructor
29
+ */
30
+ class _Frame extends base_1.EmitterBase {
31
+ constructor(wire, identity) {
32
+ super(wire, 'frame', identity.uuid, identity.name);
33
+ this.identity = identity;
34
+ }
35
+ /**
36
+ * Adds the listener function to the end of the listeners array for the specified event type.
37
+ * @param { string | symbol } eventType - The type of the event.
38
+ * @param { Function } listener - Called whenever an event of the specified type occurs.
39
+ * @param { SubOptions } [options] - Option to support event timestamps.
40
+ * @return {Promise.<this>}
41
+ * @function addListener
42
+ * @memberof Frame
43
+ * @instance
44
+ * @tutorial Frame.EventEmitter
45
+ */
46
+ /**
47
+ * Adds a listener to the end of the listeners array for the specified event.
48
+ * @param { string | symbol } eventType - The type of the event.
49
+ * @param { Function } listener - Called whenever an event of the specified type occurs.
50
+ * @param { SubOptions } [options] - Option to support event timestamps.
51
+ * @return {Promise.<this>}
52
+ * @function on
53
+ * @memberof Frame
54
+ * @instance
55
+ * @tutorial Frame.EventEmitter
56
+ */
57
+ /**
58
+ * 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.
59
+ * @param { string | symbol } eventType - The type of the event.
60
+ * @param { Function } listener - The callback function.
61
+ * @param { SubOptions } [options] - Option to support event timestamps.
62
+ * @return {Promise.<this>}
63
+ * @function once
64
+ * @memberof Frame
65
+ * @instance
66
+ * @tutorial Frame.EventEmitter
67
+ */
68
+ /**
69
+ * Adds a listener to the beginning of the listeners array for the specified event.
70
+ * @param { string | symbol } eventType - The type of the event.
71
+ * @param { Function } listener - The callback function.
72
+ * @param { SubOptions } [options] - Option to support event timestamps.
73
+ * @return {Promise.<this>}
74
+ * @function prependListener
75
+ * @memberof Frame
76
+ * @instance
77
+ * @tutorial Frame.EventEmitter
78
+ */
79
+ /**
80
+ * 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.
81
+ * The listener is added to the beginning of the listeners array.
82
+ * @param { string | symbol } eventType - The type of the event.
83
+ * @param { Function } listener - The callback function.
84
+ * @param { SubOptions } [options] - Option to support event timestamps.
85
+ * @return {Promise.<this>}
86
+ * @function prependOnceListener
87
+ * @memberof Frame
88
+ * @instance
89
+ * @tutorial Frame.EventEmitter
90
+ */
91
+ /**
92
+ * Remove a listener from the listener array for the specified event.
93
+ * Caution: Calling this method changes the array indices in the listener array behind the listener.
94
+ * @param { string | symbol } eventType - The type of the event.
95
+ * @param { Function } listener - The callback function.
96
+ * @param { SubOptions } [options] - Option to support event timestamps.
97
+ * @return {Promise.<this>}
98
+ * @function removeListener
99
+ * @memberof Frame
100
+ * @instance
101
+ * @tutorial Frame.EventEmitter
102
+ */
103
+ /**
104
+ * Removes all listeners, or those of the specified event.
105
+ * @param { string | symbol } [eventType] - The type of the event.
106
+ * @return {Promise.<this>}
107
+ * @function removeAllListeners
108
+ * @memberof Frame
109
+ * @instance
110
+ * @tutorial Frame.EventEmitter
111
+ */
112
+ /**
113
+ * Returns a frame info object for the represented frame
114
+ * @return {Promise.<FrameInfo>}
115
+ * @tutorial Frame.getInfo
116
+ */
117
+ getInfo() {
118
+ return this.wire.sendAction('get-frame-info', this.identity).then(({ payload }) => payload.data);
119
+ }
120
+ /**
121
+ * Returns a frame info object representing the window that the referenced iframe is
122
+ * currently embedded in
123
+ * @return {Promise.<FrameInfo>}
124
+ * @tutorial Frame.getParentWindow
125
+ */
126
+ getParentWindow() {
127
+ return this.wire.sendAction('get-parent-window', this.identity).then(({ payload }) => payload.data);
128
+ }
129
+ }
130
+ exports._Frame = _Frame;
@@ -1,3 +1,3 @@
1
- import _FrameModule from './Factory';
2
- export default _FrameModule;
3
- export * from './Instance';
1
+ import _FrameModule from './Factory';
2
+ export default _FrameModule;
3
+ export * from './Instance';