@openfin/fdc3-api 37.80.24 → 37.80.33

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

@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
  */
 declare class ApplicationModule extends Base {
     /**
-     * Asynchronously returns an Application object that represents an existing application.
+     * Asynchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Application throughout its entire lifecycle.
      *
      * @example
      *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
      */
     wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
     /**
-     * Synchronously returns an Application object that represents an existing application.
+     * Synchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Aplication throughout its entire lifecycle.
      *
      * @example
      *
@@ -3808,7 +3816,7 @@ declare type ConstWindowOptions = {
      */
     viewVisibility?: ViewVisibilityOptions;
     /**
-     * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
      */
     inheritance?: Partial<InheritableOptions>;
 };
@@ -6193,6 +6201,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -6260,8 +6270,11 @@ declare type FrameInfo = {
  */
 declare class _FrameModule extends Base {
     /**
-     * Asynchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Asynchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6272,8 +6285,11 @@ declare class _FrameModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
     /**
-     * Synchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Synchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6331,14 +6347,6 @@ declare type GetLogRequestType_2 = {
      * The name of the running application
      */
     name: string;
-    /**
-     * The file length of the log file
-     */
-    endFile?: string;
-    /**
-     * The size limit of the log file.
-     */
-    sizeLimit?: number;
 };
 
 declare type GetterCall<T> = ApiCall<void, T>;
@@ -16418,7 +16426,11 @@ declare class ViewModule extends Base {
      */
     create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
     /**
-     * Asynchronously returns a View object that represents an existing view.
+     * Asynchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -16430,7 +16442,11 @@ declare class ViewModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
     /**
-     * Synchronously returns a View object that represents an existing view.
+     * Synchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -18878,7 +18894,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
  */
 declare class _WindowModule extends Base {
     /**
-     * Asynchronously returns a Window object that represents an existing window.
+     * Asynchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -18898,7 +18918,11 @@ declare class _WindowModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
     /**
-     * Synchronously returns a Window object that represents an existing window.
+     * Synchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js

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

@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
  */
 declare class ApplicationModule extends Base {
     /**
-     * Asynchronously returns an Application object that represents an existing application.
+     * Asynchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Application throughout its entire lifecycle.
      *
      * @example
      *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
      */
     wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
     /**
-     * Synchronously returns an Application object that represents an existing application.
+     * Synchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Aplication throughout its entire lifecycle.
      *
      * @example
      *
@@ -3808,7 +3816,7 @@ declare type ConstWindowOptions = {
      */
     viewVisibility?: ViewVisibilityOptions;
     /**
-     * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
      */
     inheritance?: Partial<InheritableOptions>;
 };
@@ -6193,6 +6201,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -6260,8 +6270,11 @@ declare type FrameInfo = {
  */
 declare class _FrameModule extends Base {
     /**
-     * Asynchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Asynchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6272,8 +6285,11 @@ declare class _FrameModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
     /**
-     * Synchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Synchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6331,14 +6347,6 @@ declare type GetLogRequestType_2 = {
      * The name of the running application
      */
     name: string;
-    /**
-     * The file length of the log file
-     */
-    endFile?: string;
-    /**
-     * The size limit of the log file.
-     */
-    sizeLimit?: number;
 };
 
 declare type GetterCall<T> = ApiCall<void, T>;
@@ -16418,7 +16426,11 @@ declare class ViewModule extends Base {
      */
     create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
     /**
-     * Asynchronously returns a View object that represents an existing view.
+     * Asynchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -16430,7 +16442,11 @@ declare class ViewModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
     /**
-     * Synchronously returns a View object that represents an existing view.
+     * Synchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -18878,7 +18894,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
  */
 declare class _WindowModule extends Base {
     /**
-     * Asynchronously returns a Window object that represents an existing window.
+     * Asynchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -18898,7 +18918,11 @@ declare class _WindowModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
     /**
-     * Synchronously returns a Window object that represents an existing window.
+     * Synchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js

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

@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
  */
 declare class ApplicationModule extends Base {
     /**
-     * Asynchronously returns an Application object that represents an existing application.
+     * Asynchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Application throughout its entire lifecycle.
      *
      * @example
      *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
      */
     wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
     /**
-     * Synchronously returns an Application object that represents an existing application.
+     * Synchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Aplication throughout its entire lifecycle.
      *
      * @example
      *
@@ -3808,7 +3816,7 @@ declare type ConstWindowOptions = {
      */
     viewVisibility?: ViewVisibilityOptions;
     /**
-     * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
      */
     inheritance?: Partial<InheritableOptions>;
 };
@@ -6193,6 +6201,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -6260,8 +6270,11 @@ declare type FrameInfo = {
  */
 declare class _FrameModule extends Base {
     /**
-     * Asynchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Asynchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6272,8 +6285,11 @@ declare class _FrameModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
     /**
-     * Synchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Synchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6331,14 +6347,6 @@ declare type GetLogRequestType_2 = {
      * The name of the running application
      */
     name: string;
-    /**
-     * The file length of the log file
-     */
-    endFile?: string;
-    /**
-     * The size limit of the log file.
-     */
-    sizeLimit?: number;
 };
 
 declare type GetterCall<T> = ApiCall<void, T>;
@@ -16418,7 +16426,11 @@ declare class ViewModule extends Base {
      */
     create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
     /**
-     * Asynchronously returns a View object that represents an existing view.
+     * Asynchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -16430,7 +16442,11 @@ declare class ViewModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
     /**
-     * Synchronously returns a View object that represents an existing view.
+     * Synchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -18878,7 +18894,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
  */
 declare class _WindowModule extends Base {
     /**
-     * Asynchronously returns a Window object that represents an existing window.
+     * Asynchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -18898,7 +18918,11 @@ declare class _WindowModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
     /**
-     * Synchronously returns a Window object that represents an existing window.
+     * Synchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js

package/out/fdc3-api.d.ts

@@ -989,7 +989,11 @@ declare type ApplicationInfo = {
  */
 declare class ApplicationModule extends Base {
     /**
-     * Asynchronously returns an Application object that represents an existing application.
+     * Asynchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Application throughout its entire lifecycle.
      *
      * @example
      *
@@ -1003,7 +1007,11 @@ declare class ApplicationModule extends Base {
      */
     wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
     /**
-     * Synchronously returns an Application object that represents an existing application.
+     * Synchronously returns an API handle for the given Application identity.
+     *
+     * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for an Aplication throughout its entire lifecycle.
      *
      * @example
      *
@@ -3863,7 +3871,7 @@ declare type ConstWindowOptions = {
      */
     viewVisibility?: ViewVisibilityOptions;
     /**
-     * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
+     * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
      */
     inheritance?: Partial<InheritableOptions>;
 };
@@ -6277,6 +6285,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
      * Returns a frame info object representing the window that the referenced iframe is
      * currently embedded in.
      *
+     * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
+     *
      * @example
      * ```js
      * async function getParentWindow() {
@@ -6344,8 +6354,11 @@ declare type FrameInfo = {
  */
 declare class _FrameModule extends Base {
     /**
-     * Asynchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Asynchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6356,8 +6369,11 @@ declare class _FrameModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
     /**
-     * Synchronously returns a reference to the specified frame. The frame does not have to exist
-     * @param identity - the identity of the frame you want to wrap
+     * Synchronously returns an API handle for the given Frame identity.
+     *
+     * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Frame throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -6415,14 +6431,6 @@ declare type GetLogRequestType_2 = {
      * The name of the running application
      */
     name: string;
-    /**
-     * The file length of the log file
-     */
-    endFile?: string;
-    /**
-     * The size limit of the log file.
-     */
-    sizeLimit?: number;
 };
 
 declare type GetterCall<T> = ApiCall<void, T>;
@@ -16857,7 +16865,11 @@ declare class ViewModule extends Base {
      */
     create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
     /**
-     * Asynchronously returns a View object that represents an existing view.
+     * Asynchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -16869,7 +16881,11 @@ declare class ViewModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
     /**
-     * Synchronously returns a View object that represents an existing view.
+     * Synchronously returns an API handle for the given View identity.
+     *
+     * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a View throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -19324,7 +19340,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
  */
 declare class _WindowModule extends Base {
     /**
-     * Asynchronously returns a Window object that represents an existing window.
+     * Asynchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js
@@ -19344,7 +19364,11 @@ declare class _WindowModule extends Base {
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
     /**
-     * Synchronously returns a Window object that represents an existing window.
+     * Synchronously returns an API handle for the given Window identity.
+     *
+     * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
+     * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
+     * for a Window throughout its entire lifecycle.
      *
      * @example
      * ```js

package/package.json

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