@openfin/fdc3-api 41.100.120 → 41.100.122

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.
@@ -12589,6 +12589,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12589
12589
  transitions: OpenFin.Transition;
12590
12590
  options: OpenFin.TransitionOptions;
12591
12591
  }>;
12592
+ 'activate-window-and-focus': ApiCall<{
12593
+ winIdentity: OpenFin.Identity;
12594
+ focusIdentity: OpenFin.Identity;
12595
+ }, boolean>;
12592
12596
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
12593
12597
  'get-window-bounds': IdentityCall<{
12594
12598
  options?: OpenFin.GetBoundsOptions;
@@ -18244,6 +18248,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18244
18248
  * ```
18245
18249
  */
18246
18250
  getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
18251
+ /**
18252
+ * Activates the current window and focuses the child entity if it exists. If this does
18253
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
18254
+ * it will return false.
18255
+ *
18256
+ * @example
18257
+ * ```js
18258
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
18259
+ *
18260
+ * win.getCurrentViews()
18261
+ * .then(([view1]) => {
18262
+ * return win.activateAndFocus(view1.identity);
18263
+ * })
18264
+ * .then(success => {
18265
+ * if (success) {
18266
+ * console.log('Window activated and child focused');
18267
+ * } else {
18268
+ * console.log('Window activation failed, focus state unchanged');
18269
+ * }
18270
+ * })
18271
+ * .catch(console.error);
18272
+ * ```
18273
+ */
18274
+ activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
18247
18275
  /**
18248
18276
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
18249
18277
  *
@@ -12589,6 +12589,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12589
12589
  transitions: OpenFin.Transition;
12590
12590
  options: OpenFin.TransitionOptions;
12591
12591
  }>;
12592
+ 'activate-window-and-focus': ApiCall<{
12593
+ winIdentity: OpenFin.Identity;
12594
+ focusIdentity: OpenFin.Identity;
12595
+ }, boolean>;
12592
12596
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
12593
12597
  'get-window-bounds': IdentityCall<{
12594
12598
  options?: OpenFin.GetBoundsOptions;
@@ -18244,6 +18248,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18244
18248
  * ```
18245
18249
  */
18246
18250
  getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
18251
+ /**
18252
+ * Activates the current window and focuses the child entity if it exists. If this does
18253
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
18254
+ * it will return false.
18255
+ *
18256
+ * @example
18257
+ * ```js
18258
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
18259
+ *
18260
+ * win.getCurrentViews()
18261
+ * .then(([view1]) => {
18262
+ * return win.activateAndFocus(view1.identity);
18263
+ * })
18264
+ * .then(success => {
18265
+ * if (success) {
18266
+ * console.log('Window activated and child focused');
18267
+ * } else {
18268
+ * console.log('Window activation failed, focus state unchanged');
18269
+ * }
18270
+ * })
18271
+ * .catch(console.error);
18272
+ * ```
18273
+ */
18274
+ activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
18247
18275
  /**
18248
18276
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
18249
18277
  *
@@ -12589,6 +12589,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12589
12589
  transitions: OpenFin.Transition;
12590
12590
  options: OpenFin.TransitionOptions;
12591
12591
  }>;
12592
+ 'activate-window-and-focus': ApiCall<{
12593
+ winIdentity: OpenFin.Identity;
12594
+ focusIdentity: OpenFin.Identity;
12595
+ }, boolean>;
12592
12596
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
12593
12597
  'get-window-bounds': IdentityCall<{
12594
12598
  options?: OpenFin.GetBoundsOptions;
@@ -18244,6 +18248,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18244
18248
  * ```
18245
18249
  */
18246
18250
  getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
18251
+ /**
18252
+ * Activates the current window and focuses the child entity if it exists. If this does
18253
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
18254
+ * it will return false.
18255
+ *
18256
+ * @example
18257
+ * ```js
18258
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
18259
+ *
18260
+ * win.getCurrentViews()
18261
+ * .then(([view1]) => {
18262
+ * return win.activateAndFocus(view1.identity);
18263
+ * })
18264
+ * .then(success => {
18265
+ * if (success) {
18266
+ * console.log('Window activated and child focused');
18267
+ * } else {
18268
+ * console.log('Window activation failed, focus state unchanged');
18269
+ * }
18270
+ * })
18271
+ * .catch(console.error);
18272
+ * ```
18273
+ */
18274
+ activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
18247
18275
  /**
18248
18276
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
18249
18277
  *
package/out/fdc3-api.d.ts CHANGED
@@ -12990,6 +12990,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12990
12990
  transitions: OpenFin.Transition;
12991
12991
  options: OpenFin.TransitionOptions;
12992
12992
  }>;
12993
+ 'activate-window-and-focus': ApiCall<{
12994
+ winIdentity: OpenFin.Identity;
12995
+ focusIdentity: OpenFin.Identity;
12996
+ }, boolean>;
12993
12997
  'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
12994
12998
  'get-window-bounds': IdentityCall<{
12995
12999
  options?: OpenFin.GetBoundsOptions;
@@ -18698,6 +18702,30 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18698
18702
  * ```
18699
18703
  */
18700
18704
  getAllFrames(): Promise<Array<OpenFin.FrameInfo>>;
18705
+ /**
18706
+ * Activates the current window and focuses the child entity if it exists. If this does
18707
+ * not succeed - say the child does not belong to this window, or the identity does not exist -
18708
+ * it will return false.
18709
+ *
18710
+ * @example
18711
+ * ```js
18712
+ * const win = fin.Window.wrapSync({ uuid: 'myApp', name: 'myOtherWindow' });
18713
+ *
18714
+ * win.getCurrentViews()
18715
+ * .then(([view1]) => {
18716
+ * return win.activateAndFocus(view1.identity);
18717
+ * })
18718
+ * .then(success => {
18719
+ * if (success) {
18720
+ * console.log('Window activated and child focused');
18721
+ * } else {
18722
+ * console.log('Window activation failed, focus state unchanged');
18723
+ * }
18724
+ * })
18725
+ * .catch(console.error);
18726
+ * ```
18727
+ */
18728
+ activateAndFocus(childIdentityToFocus: OpenFin.Identity): Promise<boolean>;
18701
18729
  /**
18702
18730
  * Gets the current bounds (top, bottom, right, left, width, height) of the window.
18703
18731
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "41.100.120",
3
+ "version": "41.100.122",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,