@openfin/core 29.73.14 → 29.73.15

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "29.73.14",
+    "version": "29.73.15",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/api/interop/fdc3/fdc3-2.0.d.ts

@@ -171,14 +171,14 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial findInstances
+     * @tutorial fdc3v2.findInstances
      */
     findInstances(app: FDC3v2.AppIdentifier): Promise<Array<FDC3v2.AppIdentifier>>;
     /**
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial getAppMetadata
+     * @tutorial fdc3v2.getAppMetadata
      */
     getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3v2.AppMetadata>;
     /**
@@ -210,7 +210,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial findIntentsByContext
+     * @tutorial fdc3v2.findIntentsByContext
      */
     findIntentsByContext(context: FDC3v2.Context, resultType?: string): Promise<Array<FDC3v2.AppIntent>>;
     /**
@@ -219,7 +219,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     raiseIntent(intent: string, context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
@@ -227,7 +227,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     raiseIntentForContext(context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
@@ -244,17 +244,17 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * @returns { Promise<Channel> }
      * @tutorial fdc3.getOrCreateChannel
      */
-    getOrCreateChannel(channelId: string): Promise<FDC3v1.Channel>;
+    getOrCreateChannel(channelId: string): Promise<FDC3v2.Channel>;
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial createPrivateChannel
+     * @tutorial fdc3v2.createPrivateChannel
      */
     createPrivateChannel(): Promise<FDC3v2.PrivateChannel>;
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial getUserChannels
+     * @tutorial fdc3v2.getUserChannels
      */
     getUserChannels(): Promise<Array<FDC3v1.SystemChannel>>;
     /**
@@ -268,7 +268,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial joinUserChannel
+     * @tutorial fdc3v2.joinUserChannel
      */
     joinUserChannel(channelId: string): Promise<void>;
     /**
@@ -282,6 +282,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
     /**
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
+     * @tutorial fdc3.getCurrentChannel
      */
     getCurrentChannel(): Promise<FDC3v2.Channel | null>;
     /**
@@ -294,7 +295,7 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial getInfo
+     * @tutorial fdc3v2.getInfo
      */
     getInfo(): Promise<FDC3v2.ImplementationMetadata>;
 }

package/src/api/interop/fdc3/fdc3-2.0.js

@@ -180,7 +180,7 @@ class Fdc3Module2 extends base_1.Base {
      * Find all the available instances for a particular application.
      * @param { AppIdentifier } app
      * @returns { Promise<Array<AppIdentifier>> }
-     * @tutorial findInstances
+     * @tutorial fdc3v2.findInstances
      */
     async findInstances(app) {
         this.wire.sendAction('fdc3-find-instances').catch((e) => {
@@ -198,7 +198,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves the AppMetadata for an AppIdentifier, which provides additional metadata (such as icons, a title and description) from the App Directory record for the application, that may be used for display purposes.
      * @param { AppIdentifier } app
      * @returns { Promise<AppMetadata(2)> }
-     * @tutorial getAppMetadata
+     * @tutorial fdc3v2.getAppMetadata
      */
     async getAppMetadata(app) {
         this.wire.sendAction('fdc3-get-app-metadata').catch((e) => {
@@ -276,7 +276,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context
      * @param { string } [resultType] The type of result returned for any intent specified during resolution.
      * @returns { Promise<Array<AppIntent(2)>> }
-     * @tutorial findIntentsByContext
+     * @tutorial fdc3v2.findIntentsByContext
      */
     async findIntentsByContext(context, resultType) {
         this.wire.sendAction('fdc3-find-intents-by-context').catch((e) => {
@@ -297,7 +297,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntent
+     * @tutorial fdc3v2.raiseIntent
      */
     async raiseIntent(intent, context, app) {
         this.wire.sendAction('fdc3-raise-intent').catch((e) => {
@@ -316,7 +316,7 @@ class Fdc3Module2 extends base_1.Base {
      * @param { Context } context Context associated with the Intent
      * @param { AppIdentifier | TargetApp } [app]
      * @returns { Promise<IntentResolution(2)> }
-     * @tutorial raiseIntentForContext
+     * @tutorial fdc3v2.raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
         // TODO: We have to do the same thing we do for raiseIntent here as well.
@@ -384,7 +384,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns a Channel with an auto-generated identity that is intended for private communication between applications. Primarily used to create channels that will be returned to other applications via an IntentResolution for a raised intent.
      * @returns { Promise<PrivateChannel> }
-     * @tutorial createPrivateChannel
+     * @tutorial fdc3v2.createPrivateChannel
      */
     async createPrivateChannel() {
         const channelId = (0, utils_1.generateId)();
@@ -396,7 +396,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Retrieves a list of the User Channels available for the app to join.
      * @returns { Promise<Channel[]>}
-     * @tutorial getUserChannels
+     * @tutorial fdc3v2.getUserChannels
      */
     async getUserChannels() {
         const channels = await this.fin.me.interop.getContextGroups();
@@ -420,7 +420,7 @@ class Fdc3Module2 extends base_1.Base {
      * Join an app to a specified User channel.
      * @param { string } channelId Channel name
      * @returns { Promise<void> }
-     * @tutorial joinUserChannel
+     * @tutorial fdc3v2.joinUserChannel
      */
     async joinUserChannel(channelId) {
         return this.fdc3Module.joinChannel(channelId);
@@ -439,6 +439,7 @@ class Fdc3Module2 extends base_1.Base {
     /**
      * Returns the Channel object for the current User channel membership
      * @returns { Promise<FDC3.Channel | null> }
+     * @tutorial fdc3.getCurrentChannel
      */
     async getCurrentChannel() {
         const currentChannel = await this.fdc3Module.getCurrentChannel();
@@ -463,7 +464,7 @@ class Fdc3Module2 extends base_1.Base {
      * Retrieves information about the FDC3 implementation, including the supported version of the FDC3 specification, the name of the provider of the implementation, its own version number, details of whether optional API features are implemented and the metadata of the calling application according to the desktop agent.
      * fdc3HandleGetInfo must be overridden in the InteropBroker so that the ImplementationMetadata will have the appMetadata info.
      * @returns { Promise<ImplementationMetadata(2)> }
-     * @tutorial getInfo
+     * @tutorial fdc3v2.getInfo
      */
     async getInfo() {
         return InteropClient_1.InteropClient.ferryFdc3Call(fin.me.interop, 'fdc3v2GetInfo', { fdc3Version: '2.0' });

package/src/api/interop/fdc3/shapes/fdc3v2.d.ts

@@ -63,7 +63,7 @@ export interface DesktopAgent {
     addContextListener(contextType: string | null, handler: ContextHandler): Promise<Listener>;
     getUserChannels(): Promise<Array<SystemChannel>>;
     joinUserChannel(channelId: string): Promise<void>;
-    getOrCreateChannel(channelId: string): Promise<ChannelV1>;
+    getOrCreateChannel(channelId: string): Promise<Channel>;
     createPrivateChannel(): Promise<PrivateChannel>;
     getCurrentChannel(): Promise<ChannelV1 | null>;
     leaveCurrentChannel(): Promise<void>;

package/src/api/view/Instance.d.ts

@@ -54,6 +54,11 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
  * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {object} [autoResize] AutoResize options
  *
  * @property {object} [bounds] initial bounds given relative to the window.

package/src/api/view/Instance.js

@@ -58,6 +58,11 @@ const bounds_observer_1 = require("../platform/layout/utils/bounds-observer");
  * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
  * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {object} [autoResize] AutoResize options
  *
  * @property {object} [bounds] initial bounds given relative to the window.

package/src/api/window/Instance.d.ts

@@ -127,6 +127,11 @@ import WindowEvents = OpenFin.WindowEvents;
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
  * an aspect ratio will not be enforced.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {boolean} [autoShow=true]
  * A flag to automatically show the window when it is created.
  *

package/src/api/window/Instance.js

@@ -134,6 +134,11 @@ const view_1 = require("../view");
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
  * an aspect ratio will not be enforced.
  *
+ * @property {string} [autoplayPolicy="no-user-gesture-required"]
+ * Autoplay policy to apply to content in the window, can be
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
+ *
  * @property {boolean} [autoShow=true]
  * A flag to automatically show the window when it is created.
  *