@openfin/core 43.100.23 → 43.100.27

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.
@@ -9192,6 +9192,7 @@ declare type MutableWindowOptions = {
9192
9192
  customData: any;
9193
9193
  /**
9194
9194
  * @defaultValue true
9195
+ * @deprecated Will be removed in runtime version 45
9195
9196
  *
9196
9197
  * Show the window's frame.
9197
9198
  */
@@ -12330,6 +12331,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
12330
12331
  transitions: OpenFin_2.Transition;
12331
12332
  options: OpenFin_2.TransitionOptions;
12332
12333
  }>;
12334
+ 'activate-window-and-focus': ApiCall<{
12335
+ winIdentity: OpenFin_2.Identity;
12336
+ focusIdentity: OpenFin_2.Identity;
12337
+ }, boolean>;
12333
12338
  'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
12334
12339
  'get-window-bounds': IdentityCall<{
12335
12340
  options?: OpenFin_2.GetBoundsOptions;
@@ -17962,6 +17967,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
17962
17967
  * ```
17963
17968
  */
17964
17969
  getAllFrames(): Promise<Array<OpenFin_2.FrameInfo>>;
17970
+ /**
17971
+ * Activates the current window and focuses the child entity if it exists. If this does
17972
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
17973
+ * it will return false.
17974
+ *
17975
+ * @example
17976
+ * ```js
17977
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
17978
+ *
17979
+ * win.getCurrentViews()
17980
+ * .then(([view1]) => {
17981
+ * return win.activateAndFocus(view1.identity);
17982
+ * })
17983
+ * .then(success => {
17984
+ * if (success) {
17985
+ * console.log('Window activated and child focused');
17986
+ * } else {
17987
+ * console.log('Window activation failed, focus state unchanged');
17988
+ * }
17989
+ * })
17990
+ * .catch(console.error);
17991
+ * ```
17992
+ */
17993
+ activateAndFocus(childIdentityToFocus: OpenFin_2.Identity): Promise<boolean>;
17965
17994
  /**
17966
17995
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
17967
17996
  *
@@ -9192,6 +9192,7 @@ declare type MutableWindowOptions = {
9192
9192
  customData: any;
9193
9193
  /**
9194
9194
  * @defaultValue true
9195
+ * @deprecated Will be removed in runtime version 45
9195
9196
  *
9196
9197
  * Show the window's frame.
9197
9198
  */
@@ -12330,6 +12331,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
12330
12331
  transitions: OpenFin_2.Transition;
12331
12332
  options: OpenFin_2.TransitionOptions;
12332
12333
  }>;
12334
+ 'activate-window-and-focus': ApiCall<{
12335
+ winIdentity: OpenFin_2.Identity;
12336
+ focusIdentity: OpenFin_2.Identity;
12337
+ }, boolean>;
12333
12338
  'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
12334
12339
  'get-window-bounds': IdentityCall<{
12335
12340
  options?: OpenFin_2.GetBoundsOptions;
@@ -17962,6 +17967,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
17962
17967
  * ```
17963
17968
  */
17964
17969
  getAllFrames(): Promise<Array<OpenFin_2.FrameInfo>>;
17970
+ /**
17971
+ * Activates the current window and focuses the child entity if it exists. If this does
17972
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
17973
+ * it will return false.
17974
+ *
17975
+ * @example
17976
+ * ```js
17977
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
17978
+ *
17979
+ * win.getCurrentViews()
17980
+ * .then(([view1]) => {
17981
+ * return win.activateAndFocus(view1.identity);
17982
+ * })
17983
+ * .then(success => {
17984
+ * if (success) {
17985
+ * console.log('Window activated and child focused');
17986
+ * } else {
17987
+ * console.log('Window activation failed, focus state unchanged');
17988
+ * }
17989
+ * })
17990
+ * .catch(console.error);
17991
+ * ```
17992
+ */
17993
+ activateAndFocus(childIdentityToFocus: OpenFin_2.Identity): Promise<boolean>;
17965
17994
  /**
17966
17995
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
17967
17996
  *
@@ -9192,6 +9192,7 @@ declare type MutableWindowOptions = {
9192
9192
  customData: any;
9193
9193
  /**
9194
9194
  * @defaultValue true
9195
+ * @deprecated Will be removed in runtime version 45
9195
9196
  *
9196
9197
  * Show the window's frame.
9197
9198
  */
@@ -12330,6 +12331,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
12330
12331
  transitions: OpenFin_2.Transition;
12331
12332
  options: OpenFin_2.TransitionOptions;
12332
12333
  }>;
12334
+ 'activate-window-and-focus': ApiCall<{
12335
+ winIdentity: OpenFin_2.Identity;
12336
+ focusIdentity: OpenFin_2.Identity;
12337
+ }, boolean>;
12333
12338
  'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
12334
12339
  'get-window-bounds': IdentityCall<{
12335
12340
  options?: OpenFin_2.GetBoundsOptions;
@@ -17962,6 +17967,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
17962
17967
  * ```
17963
17968
  */
17964
17969
  getAllFrames(): Promise<Array<OpenFin_2.FrameInfo>>;
17970
+ /**
17971
+ * Activates the current window and focuses the child entity if it exists. If this does
17972
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
17973
+ * it will return false.
17974
+ *
17975
+ * @example
17976
+ * ```js
17977
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
17978
+ *
17979
+ * win.getCurrentViews()
17980
+ * .then(([view1]) => {
17981
+ * return win.activateAndFocus(view1.identity);
17982
+ * })
17983
+ * .then(success => {
17984
+ * if (success) {
17985
+ * console.log('Window activated and child focused');
17986
+ * } else {
17987
+ * console.log('Window activation failed, focus state unchanged');
17988
+ * }
17989
+ * })
17990
+ * .catch(console.error);
17991
+ * ```
17992
+ */
17993
+ activateAndFocus(childIdentityToFocus: OpenFin_2.Identity): Promise<boolean>;
17965
17994
  /**
17966
17995
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
17967
17996
  *
package/out/stub.d.ts CHANGED
@@ -9492,6 +9492,7 @@ declare type MutableWindowOptions = {
9492
9492
  customData: any;
9493
9493
  /**
9494
9494
  * @defaultValue true
9495
+ * @deprecated Will be removed in runtime version 45
9495
9496
  *
9496
9497
  * Show the window's frame.
9497
9498
  */
@@ -12731,6 +12732,10 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
12731
12732
  transitions: OpenFin_2.Transition;
12732
12733
  options: OpenFin_2.TransitionOptions;
12733
12734
  }>;
12735
+ 'activate-window-and-focus': ApiCall<{
12736
+ winIdentity: OpenFin_2.Identity;
12737
+ focusIdentity: OpenFin_2.Identity;
12738
+ }, boolean>;
12734
12739
  'get-all-frames': IdentityCall<{}, OpenFin_2.FrameInfo[]>;
12735
12740
  'get-window-bounds': IdentityCall<{
12736
12741
  options?: OpenFin_2.GetBoundsOptions;
@@ -18416,6 +18421,30 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18416
18421
  * ```
18417
18422
  */
18418
18423
  getAllFrames(): Promise<Array<OpenFin_2.FrameInfo>>;
18424
+ /**
18425
+ * Activates the current window and focuses the child entity if it exists. If this does
18426
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
18427
+ * it will return false.
18428
+ *
18429
+ * @example
18430
+ * ```js
18431
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
18432
+ *
18433
+ * win.getCurrentViews()
18434
+ * .then(([view1]) => {
18435
+ * return win.activateAndFocus(view1.identity);
18436
+ * })
18437
+ * .then(success => {
18438
+ * if (success) {
18439
+ * console.log('Window activated and child focused');
18440
+ * } else {
18441
+ * console.log('Window activation failed, focus state unchanged');
18442
+ * }
18443
+ * })
18444
+ * .catch(console.error);
18445
+ * ```
18446
+ */
18447
+ activateAndFocus(childIdentityToFocus: OpenFin_2.Identity): Promise<boolean>;
18419
18448
  /**
18420
18449
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
18421
18450
  *
package/out/stub.js CHANGED
@@ -4044,6 +4044,37 @@ function requireInstance () {
4044
4044
  getAllFrames() {
4045
4045
  return this.wire.sendAction('get-all-frames', this.identity).then(({ payload }) => payload.data);
4046
4046
  }
4047
+ /**
4048
+ * Activates the current window and focuses the child entity if it exists. If this does
4049
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
4050
+ * it will return false.
4051
+ *
4052
+ * @example
4053
+ * ```js
4054
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
4055
+ *
4056
+ * win.getCurrentViews()
4057
+ * .then(([view1]) => {
4058
+ * return win.activateAndFocus(view1.identity);
4059
+ * })
4060
+ * .then(success => {
4061
+ * if (success) {
4062
+ * console.log('Window activated and child focused');
4063
+ * } else {
4064
+ * console.log('Window activation failed, focus state unchanged');
4065
+ * }
4066
+ * })
4067
+ * .catch(console.error);
4068
+ * ```
4069
+ */
4070
+ activateAndFocus(childIdentityToFocus) {
4071
+ return this.wire
4072
+ .sendAction('activate-window-and-focus', {
4073
+ winIdentity: this.identity,
4074
+ focusIdentity: childIdentityToFocus
4075
+ })
4076
+ .then(({ payload }) => payload.data);
4077
+ }
4047
4078
  /**
4048
4079
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
4049
4080
  *
@@ -4995,6 +5026,9 @@ function requireInstance () {
4995
5026
  * ```
4996
5027
  */
4997
5028
  updateOptions(options) {
5029
+ if ('frame' in options) {
5030
+ console.warn(`Deprecation Warning: Starting with version 45 it will not be possible to change the frame value after window has been created.`);
5031
+ }
4998
5032
  return this.wire.sendAction('update-window-options', { options, ...this.identity }).then(() => undefined);
4999
5033
  }
5000
5034
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "43.100.23",
3
+ "version": "43.100.27",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/stub.js",