@openfin/fdc3-api 40.82.19 → 40.82.20

package/out/fdc3-api-alpha.d.ts

@@ -4696,6 +4696,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7863,6 +7864,7 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /* Excluded from this release type: getClient */
     /* Excluded from this release type: init */
     identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
@@ -7962,6 +7964,16 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
     getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
@@ -8332,6 +8344,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -15866,7 +15889,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

package/out/fdc3-api-beta.d.ts

@@ -4696,6 +4696,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7863,6 +7864,7 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /* Excluded from this release type: getClient */
     /* Excluded from this release type: init */
     identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
@@ -7962,6 +7964,16 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
     getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
@@ -8332,6 +8344,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -15866,7 +15889,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

package/out/fdc3-api-public.d.ts

@@ -4696,6 +4696,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7863,6 +7864,7 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /* Excluded from this release type: getClient */
     /* Excluded from this release type: init */
     identity: OpenFin.Identity | OpenFin.LayoutIdentity;
     private platform;
@@ -7962,6 +7964,16 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
     getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
@@ -8332,6 +8344,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -15866,7 +15889,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

package/out/fdc3-api.d.ts

@@ -4760,6 +4760,7 @@ declare interface Environment {
     getInteropInfo(fin: OpenFin.Fin<OpenFin.EntityType>): Promise<InternalInteropBrokerOptions & {
         fdc3Version?: Version;
     }>;
+    getViewWindowIdentity(fin: OpenFin.Fin<OpenFin.EntityType>, identity: OpenFin.Identity): Promise<OpenFin.Identity>;
     readonly type: EnvironmentType;
 }
 
@@ -7980,6 +7981,10 @@ declare type LaunchIntoPlatformPayload = {
  */
 declare class Layout extends Base {
     #private;
+    /**
+     * @internal
+     */
+    static getClient(layout: Layout): Promise<LayoutEntitiesClient>;
     /**
      * @internal
      */
@@ -8085,6 +8090,16 @@ declare class Layout extends Base {
      * ```
      */
     getRootItem(): Promise<OpenFin.ColumnOrRow | OpenFin.TabStack>;
+    /**
+     * Retrieves the OpenFin.TabStack instance which the View belongs to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const stack = await fin.View.wrapSync(viewIdentity).getStackByViewIdentity(viewIdentity);
+     * console.log(await stack.getViews());
+     * ```
+     */
     getStackByViewIdentity(identity: OpenFin.Identity): Promise<OpenFin.TabStack>;
     /**
      * Replaces the specified view with a view with the provided configuration.
@@ -8455,6 +8470,17 @@ declare class LayoutModule extends Base {
      * ```
      */
     getCurrentSync(): OpenFin.Layout;
+    /**
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
+     *
+     * @example
+     * ```js
+     * const viewIdentity = { uuid: 'uuid', name: 'view-name' };
+     * const layout = await fin.Platform.Layout.getLayoutByViewIdentity(viewIdentity);
+     * console.log(await layout.getCurrentViews());
+     * ```
+     */
+    getLayoutByViewIdentity(viewIdentity: OpenFin.Identity): Promise<OpenFin.Layout>;
     /**
      * Initialize the window's Layout.
      *
@@ -16280,7 +16306,7 @@ declare class View_2 extends WebContents<OpenFin.ViewEvent> {
      */
     getInfo: () => Promise<OpenFin.ViewInfo>;
     /**
-     * Retrieves the layout for the window the view is attached to.
+     * Retrieves the OpenFin.Layout instance for the Window the View is attached to.
      *
      * @example
      * ```js

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "40.82.19",
+    "version": "40.82.20",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,