@openfin/core 40.82.19 → 40.82.20

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.
@@ -4699,6 +4699,7 @@ declare interface Environment {
4699
4699
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4700
4700
  fdc3Version?: Version;
4701
4701
  }>;
4702
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4702
4703
  readonly type: EnvironmentType;
4703
4704
  }
4704
4705
 
@@ -7521,6 +7522,7 @@ declare type LaunchIntoPlatformPayload = {
7521
7522
  */
7522
7523
  declare class Layout extends Base {
7523
7524
  #private;
7525
+ /* Excluded from this release type: getClient */
7524
7526
  /* Excluded from this release type: init */
7525
7527
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7526
7528
  private platform;
@@ -7620,6 +7622,16 @@ declare class Layout extends Base {
7620
7622
  * ```
7621
7623
  */
7622
7624
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7625
+ /**
7626
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7627
+ *
7628
+ * @example
7629
+ * ```js
7630
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7631
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7632
+ * console.log(await stack.getViews());
7633
+ * ```
7634
+ */
7623
7635
  getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7624
7636
  /**
7625
7637
  * Replaces the specified view with a view with the provided configuration.
@@ -7990,6 +8002,17 @@ declare class LayoutModule extends Base {
7990
8002
  * ```
7991
8003
  */
7992
8004
  getCurrentSync(): OpenFin_2.Layout;
8005
+ /**
8006
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8007
+ *
8008
+ * @example
8009
+ * ```js
8010
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8011
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8012
+ * console.log(await layout.getCurrentViews());
8013
+ * ```
8014
+ */
8015
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
7993
8016
  /**
7994
8017
  * Initialize the window's Layout.
7995
8018
  *
@@ -15420,7 +15443,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15420
15443
  */
15421
15444
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15422
15445
  /**
15423
- * Retrieves the layout for the window the view is attached to.
15446
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15424
15447
  *
15425
15448
  * @example
15426
15449
  * ```js
@@ -4699,6 +4699,7 @@ declare interface Environment {
4699
4699
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4700
4700
  fdc3Version?: Version;
4701
4701
  }>;
4702
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4702
4703
  readonly type: EnvironmentType;
4703
4704
  }
4704
4705
 
@@ -7521,6 +7522,7 @@ declare type LaunchIntoPlatformPayload = {
7521
7522
  */
7522
7523
  declare class Layout extends Base {
7523
7524
  #private;
7525
+ /* Excluded from this release type: getClient */
7524
7526
  /* Excluded from this release type: init */
7525
7527
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7526
7528
  private platform;
@@ -7620,6 +7622,16 @@ declare class Layout extends Base {
7620
7622
  * ```
7621
7623
  */
7622
7624
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7625
+ /**
7626
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7627
+ *
7628
+ * @example
7629
+ * ```js
7630
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7631
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7632
+ * console.log(await stack.getViews());
7633
+ * ```
7634
+ */
7623
7635
  getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7624
7636
  /**
7625
7637
  * Replaces the specified view with a view with the provided configuration.
@@ -7990,6 +8002,17 @@ declare class LayoutModule extends Base {
7990
8002
  * ```
7991
8003
  */
7992
8004
  getCurrentSync(): OpenFin_2.Layout;
8005
+ /**
8006
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8007
+ *
8008
+ * @example
8009
+ * ```js
8010
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8011
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8012
+ * console.log(await layout.getCurrentViews());
8013
+ * ```
8014
+ */
8015
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
7993
8016
  /**
7994
8017
  * Initialize the window's Layout.
7995
8018
  *
@@ -15420,7 +15443,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15420
15443
  */
15421
15444
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15422
15445
  /**
15423
- * Retrieves the layout for the window the view is attached to.
15446
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15424
15447
  *
15425
15448
  * @example
15426
15449
  * ```js
@@ -4699,6 +4699,7 @@ declare interface Environment {
4699
4699
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4700
4700
  fdc3Version?: Version;
4701
4701
  }>;
4702
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4702
4703
  readonly type: EnvironmentType;
4703
4704
  }
4704
4705
 
@@ -7521,6 +7522,7 @@ declare type LaunchIntoPlatformPayload = {
7521
7522
  */
7522
7523
  declare class Layout extends Base {
7523
7524
  #private;
7525
+ /* Excluded from this release type: getClient */
7524
7526
  /* Excluded from this release type: init */
7525
7527
  identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
7526
7528
  private platform;
@@ -7620,6 +7622,16 @@ declare class Layout extends Base {
7620
7622
  * ```
7621
7623
  */
7622
7624
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7625
+ /**
7626
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7627
+ *
7628
+ * @example
7629
+ * ```js
7630
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7631
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7632
+ * console.log(await stack.getViews());
7633
+ * ```
7634
+ */
7623
7635
  getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7624
7636
  /**
7625
7637
  * Replaces the specified view with a view with the provided configuration.
@@ -7990,6 +8002,17 @@ declare class LayoutModule extends Base {
7990
8002
  * ```
7991
8003
  */
7992
8004
  getCurrentSync(): OpenFin_2.Layout;
8005
+ /**
8006
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8007
+ *
8008
+ * @example
8009
+ * ```js
8010
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8011
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8012
+ * console.log(await layout.getCurrentViews());
8013
+ * ```
8014
+ */
8015
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
7993
8016
  /**
7994
8017
  * Initialize the window's Layout.
7995
8018
  *
@@ -15420,7 +15443,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15420
15443
  */
15421
15444
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15422
15445
  /**
15423
- * Retrieves the layout for the window the view is attached to.
15446
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15424
15447
  *
15425
15448
  * @example
15426
15449
  * ```js
package/out/mock.d.ts CHANGED
@@ -4763,6 +4763,7 @@ declare interface Environment {
4763
4763
  getInteropInfo(fin: OpenFin_2.Fin<OpenFin_2.EntityType>): Promise<InternalInteropBrokerOptions & {
4764
4764
  fdc3Version?: Version;
4765
4765
  }>;
4766
+ getViewWindowIdentity(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, identity: OpenFin_2.Identity): Promise<OpenFin_2.Identity>;
4766
4767
  readonly type: EnvironmentType;
4767
4768
  }
4768
4769
 
@@ -7638,6 +7639,10 @@ declare type LaunchIntoPlatformPayload = {
7638
7639
  */
7639
7640
  declare class Layout extends Base {
7640
7641
  #private;
7642
+ /**
7643
+ * @internal
7644
+ */
7645
+ static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
7641
7646
  /**
7642
7647
  * @internal
7643
7648
  */
@@ -7743,6 +7748,16 @@ declare class Layout extends Base {
7743
7748
  * ```
7744
7749
  */
7745
7750
  getRootItem(): Promise<OpenFin_2.ColumnOrRow | OpenFin_2.TabStack>;
7751
+ /**
7752
+ * Retrieves the OpenFin.TabStack instance which the View belongs to.
7753
+ *
7754
+ * @example
7755
+ * ```js
7756
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
7757
+ * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
7758
+ * console.log(await stack.getViews());
7759
+ * ```
7760
+ */
7746
7761
  getStackByViewIdentity(identity: OpenFin_2.Identity): Promise<OpenFin_2.TabStack>;
7747
7762
  /**
7748
7763
  * Replaces the specified view with a view with the provided configuration.
@@ -8113,6 +8128,17 @@ declare class LayoutModule extends Base {
8113
8128
  * ```
8114
8129
  */
8115
8130
  getCurrentSync(): OpenFin_2.Layout;
8131
+ /**
8132
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
8133
+ *
8134
+ * @example
8135
+ * ```js
8136
+ * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
8137
+ * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
8138
+ * console.log(await layout.getCurrentViews());
8139
+ * ```
8140
+ */
8141
+ getLayoutByViewIdentity(viewIdentity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
8116
8142
  /**
8117
8143
  * Initialize the window's Layout.
8118
8144
  *
@@ -15834,7 +15860,7 @@ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
15834
15860
  */
15835
15861
  getInfo: () => Promise<OpenFin_2.ViewInfo>;
15836
15862
  /**
15837
- * Retrieves the layout for the window the view is attached to.
15863
+ * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
15838
15864
  *
15839
15865
  * @example
15840
15866
  * ```js