@openfin/core 33.76.27 → 33.76.36

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

@@ -52,11 +52,8 @@ import { Base } from '../../base';
  * @property { string } [providerVersion] The provider runtime version
  */
 /**
- * @class
- * @alias fdc3
  * @version 1.2
- * @hideconstructor
- * @desc The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
+ * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
  * while using our Interop API under the hood. In order to use this set of APIs
  * you will need to set up your own {@link InteropBroker InteropBroker} or use a Platform application, which does the setup for you. Refer to our documentation on
  * our {@link https://developers.openfin.co/of-docs/docs/enable-color-linking Interop API}.
@@ -92,24 +89,24 @@ import { Base } from '../../base';
 export default class Fdc3Module extends Base implements FDC3v1.DesktopAgent {
     /**
      * Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts. If you wish to listen for all incoming contexts, pass `null` for the contextType argument.
-     * @param { string | null } contextType - The type of context you wish to handle.
-     * @param { ContextHandler } handler - Handler for incoming context.
-     * @returns { Listener }
+     * @param contextType - The type of context you wish to handle.
+     * @param handler - Handler for incoming context.
+     *
      * @tutorial fdc3.addContextListener
      * @static
      */
     addContextListener(contextType: string | null, handler: FDC3v1.ContextHandler): FDC3v1.Listener & Promise<FDC3v1.Listener>;
     /**
      * Broadcasts a context for the channel of the current entity.
-     * @param { Context } context - New context to set.
-     * @returns { Promise<void> }
+     * @param context - New context to set.
+     *
      * @tutorial fdc3.broadcast
      * @static
      */
     broadcast(context: FDC3v1.Context): Promise<void>;
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
-     * @returns { Promise<Channel[]>}
+     *
      * @tutorial fdc3.getSystemChannels
      * @static
      */
@@ -120,8 +117,8 @@ export default class Fdc3Module extends Base implements FDC3v1.DesktopAgent {
      * Because multiple Channel connections/Interop Clients can potentially exist at a `uuid`/`name` combo, we currently join all Channel connections/Interop Clients at the given identity to the context group.
      * If an `endpointId` is provided (which is unlikely, unless the call is coming from an external adapter), then we only join that single connection to the context group.
      * For all intents and purposes, there will only be 1 connection present in Platform and Browser implementations, so this point is more-or-less moot.
-     * @param { string } channelId - Id of the context group.
-     * @returns { Promise<void> }
+     * @param channelId - Id of the context group.
+     *
      * @tutorial fdc3.joinChannel
      * @static
      */
@@ -129,77 +126,77 @@ export default class Fdc3Module extends Base implements FDC3v1.DesktopAgent {
     /**
      * Removes the specified target from a context group.
      * If no target is specified, it removes the sender from their context group.
-     * @returns { Promise<void> }
+     *
      * @tutorial fdc3.leaveCurrentChannel
      * @static
      */
     leaveCurrentChannel(): Promise<void>;
     /**
      * Adds a listener for incoming Intents.
-     * @param { string } intent - Name of the Intent
-     * @param { IntentHandler } handler - Handler for incoming Intent
-     * @returns { Listener }
+     * @param intent - Name of the Intent
+     * @param handler - Handler for incoming Intent
+     *
      * @tutorial fdc3.addIntentListener
      * @static
      */
     addIntentListener(intent: string, handler: FDC3v1.ContextHandler): FDC3v1.Listener & Promise<FDC3v1.Listener>;
     /**
      * Raises a specific intent.
-     * @param { string } intent Name of the Intent.
-     * @param { Context } context Context associated with the Intent.
-     * @param { TargetApp }  app App that will resolve the Intent. This is added as metadata to the Intent. Can be accessed by the app provider in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
-     * @returns { IntentResolution }
+     * @param intent Name of the Intent.
+     * @param context Context associated with the Intent.
+     * @param  app App that will resolve the Intent. This is added as metadata to the Intent. Can be accessed by the app provider in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
+     *
      * @tutorial fdc3.raiseIntent
      * @static
      */
     raiseIntent(intent: string, context: FDC3v1.Context, app?: FDC3v1.TargetApp): Promise<FDC3v1.IntentResolution>;
     /**
      * Returns the Channel that the entity is subscribed to. Returns null if not joined to a channel.
-     * @returns { Channel | null }
+     *
      * @tutorial fdc3.getCurrentChannel
      */
     getCurrentChannel(): Promise<FDC3v1.Channel | null>;
     /**
      * Find out more information about a particular intent by passing its name, and optionally its context.
-     * @param { string } intent Name of the Intent
-     * @param { Context } [context]
-     * @return { Promise<AppIntent> }
+     * @param intent Name of the Intent
+     * @param context
+     *
      * @tutorial fdc3.findIntent
      */
     findIntent(intent: string, context?: FDC3v1.Context): Promise<FDC3v1.AppIntent>;
     /**
      * Find all the available intents for a particular context.
-     * @param { Context } context
-     * @return { Promise<Array<AppIntent>> }
+     * @param context
+     *
      * @tutorial fdc3.findIntentsByContext
      */
     findIntentsByContext(context: FDC3v1.Context): Promise<Array<FDC3v1.AppIntent>>;
     /**
      * Finds and raises an intent against a target app based purely on context data.
-     * @param { Context } context
-     * @param { TargetApp } [app]
-     * @return { Promise<IntentResolution> }
+     * @param context
+     * @param app
+     *
      * @tutorial fdc3.raiseIntentForContext
      */
     raiseIntentForContext(context: FDC3v1.Context, app?: FDC3v1.TargetApp): Promise<FDC3v1.IntentResolution>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
-     * @returns { Promise<Channel> }
+     *
      * @tutorial fdc3.getOrCreateChannel
      */
     getOrCreateChannel(channelId: string): Promise<FDC3v1.Channel>;
     /**
      * Returns metadata relating to the FDC3 object and its provider, including the supported version of the FDC3 specification and the name of the provider of the implementation.
-     * @return { Promise<ImplementationMetadata> }
+     *
      * @tutorial fdc3.getInfo
      */
     getInfo(): FDC3v1.ImplementationMetadata;
     /**
      * Launches an app with target information, which can either be a string or an AppMetadata object.
-     * @param { TargetApp } app
-     * @param { Context } [context]
-     * @return { Promise<void> }
+     * @param app
+     * @param context
+     *
      * @tutorial fdc3.open
      */
     open(app: FDC3v1.TargetApp, context?: FDC3v1.Context): Promise<void>;

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

@@ -57,11 +57,8 @@ const lodash_1 = require("lodash");
  * @property { string } [providerVersion] The provider runtime version
  */
 /**
- * @class
- * @alias fdc3
  * @version 1.2
- * @hideconstructor
- * @desc The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
+ * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
  * while using our Interop API under the hood. In order to use this set of APIs
  * you will need to set up your own {@link InteropBroker InteropBroker} or use a Platform application, which does the setup for you. Refer to our documentation on
  * our {@link https://developers.openfin.co/of-docs/docs/enable-color-linking Interop API}.
@@ -97,9 +94,9 @@ const lodash_1 = require("lodash");
 class Fdc3Module extends base_1.Base {
     /**
      * Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts. If you wish to listen for all incoming contexts, pass `null` for the contextType argument.
-     * @param { string | null } contextType - The type of context you wish to handle.
-     * @param { ContextHandler } handler - Handler for incoming context.
-     * @returns { Listener }
+     * @param contextType - The type of context you wish to handle.
+     * @param handler - Handler for incoming context.
+     *
      * @tutorial fdc3.addContextListener
      * @static
      */
@@ -122,8 +119,8 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Broadcasts a context for the channel of the current entity.
-     * @param { Context } context - New context to set.
-     * @returns { Promise<void> }
+     * @param context - New context to set.
+     *
      * @tutorial fdc3.broadcast
      * @static
      */
@@ -135,7 +132,7 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Returns the Interop-Broker-defined context groups available for an entity to join.
-     * @returns { Promise<Channel[]>}
+     *
      * @tutorial fdc3.getSystemChannels
      * @static
      */
@@ -156,8 +153,8 @@ class Fdc3Module extends base_1.Base {
      * Because multiple Channel connections/Interop Clients can potentially exist at a `uuid`/`name` combo, we currently join all Channel connections/Interop Clients at the given identity to the context group.
      * If an `endpointId` is provided (which is unlikely, unless the call is coming from an external adapter), then we only join that single connection to the context group.
      * For all intents and purposes, there will only be 1 connection present in Platform and Browser implementations, so this point is more-or-less moot.
-     * @param { string } channelId - Id of the context group.
-     * @returns { Promise<void> }
+     * @param channelId - Id of the context group.
+     *
      * @tutorial fdc3.joinChannel
      * @static
      */
@@ -184,7 +181,7 @@ class Fdc3Module extends base_1.Base {
     /**
      * Removes the specified target from a context group.
      * If no target is specified, it removes the sender from their context group.
-     * @returns { Promise<void> }
+     *
      * @tutorial fdc3.leaveCurrentChannel
      * @static
      */
@@ -196,9 +193,9 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Adds a listener for incoming Intents.
-     * @param { string } intent - Name of the Intent
-     * @param { IntentHandler } handler - Handler for incoming Intent
-     * @returns { Listener }
+     * @param intent - Name of the Intent
+     * @param handler - Handler for incoming Intent
+     *
      * @tutorial fdc3.addIntentListener
      * @static
      */
@@ -219,10 +216,10 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Raises a specific intent.
-     * @param { string } intent Name of the Intent.
-     * @param { Context } context Context associated with the Intent.
-     * @param { TargetApp }  app App that will resolve the Intent. This is added as metadata to the Intent. Can be accessed by the app provider in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
-     * @returns { IntentResolution }
+     * @param intent Name of the Intent.
+     * @param context Context associated with the Intent.
+     * @param  app App that will resolve the Intent. This is added as metadata to the Intent. Can be accessed by the app provider in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
+     *
      * @tutorial fdc3.raiseIntent
      * @static
      */
@@ -243,7 +240,7 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Returns the Channel that the entity is subscribed to. Returns null if not joined to a channel.
-     * @returns { Channel | null }
+     *
      * @tutorial fdc3.getCurrentChannel
      */
     async getCurrentChannel() {
@@ -258,9 +255,9 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Find out more information about a particular intent by passing its name, and optionally its context.
-     * @param { string } intent Name of the Intent
-     * @param { Context } [context]
-     * @return { Promise<AppIntent> }
+     * @param intent Name of the Intent
+     * @param context
+     *
      * @tutorial fdc3.findIntent
      */
     async findIntent(intent, context) {
@@ -277,8 +274,8 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Find all the available intents for a particular context.
-     * @param { Context } context
-     * @return { Promise<Array<AppIntent>> }
+     * @param context
+     *
      * @tutorial fdc3.findIntentsByContext
      */
     async findIntentsByContext(context) {
@@ -295,9 +292,9 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Finds and raises an intent against a target app based purely on context data.
-     * @param { Context } context
-     * @param { TargetApp } [app]
-     * @return { Promise<IntentResolution> }
+     * @param context
+     * @param app
+     *
      * @tutorial fdc3.raiseIntentForContext
      */
     async raiseIntentForContext(context, app) {
@@ -315,7 +312,7 @@ class Fdc3Module extends base_1.Base {
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
-     * @returns { Promise<Channel> }
+     *
      * @tutorial fdc3.getOrCreateChannel
      */
     async getOrCreateChannel(channelId) {
@@ -338,7 +335,7 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Returns metadata relating to the FDC3 object and its provider, including the supported version of the FDC3 specification and the name of the provider of the implementation.
-     * @return { Promise<ImplementationMetadata> }
+     *
      * @tutorial fdc3.getInfo
      */
     getInfo() {
@@ -357,9 +354,9 @@ class Fdc3Module extends base_1.Base {
     }
     /**
      * Launches an app with target information, which can either be a string or an AppMetadata object.
-     * @param { TargetApp } app
-     * @param { Context } [context]
-     * @return { Promise<void> }
+     * @param app
+     * @param context
+     *
      * @tutorial fdc3.open
      */
     async open(app, context) {

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

@@ -66,16 +66,16 @@ import { Transport } from '../../../transport/transport';
 /**
  * @callback ContextHandler
  * @variation 2
- * @param { Context } context
- * @param { ContextMetadata } [contextMetadata]
- * @returns { void }
+ * @param context
+ * @param contextMetadata
+ *
  */
 /**
  * @callback IntentHandler
  * @variation 2
- * @param { Context } context
- * @param { ContextMetadata } [contextMetadata]
- * @returns { Promise<IntentResult> | void }
+ * @param context
+ * @param contextMetadata
+ *
  */
 /**
  * @typedef { object } IntentMetadata
@@ -93,7 +93,7 @@ import { Transport } from '../../../transport/transport';
 /**
  * @name getResult
  * @function
- * @returns { Promise<IntentResult> }
+ *
  */
 /**
  * @typedef { object } IntentResolution
@@ -119,11 +119,8 @@ import { Transport } from '../../../transport/transport';
  * @property { function } disconnect
  */
 /**
- * @class
- * @alias fdc3v2
  * @version 2.0
- * @hideconstructor
- * @desc The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
+ * The FDC3 Client Library provides a set APIs to be used for FDC3 compliance,
  * while using our Interop API under the hood. In order to use this set of APIs
  * you will need to set up your own {@link InteropBroker InteropBroker} or use a Platform application, which does the setup for you. Refer to our documentation on
  * our {@link https://developers.openfin.co/of-docs/docs/enable-context-sharing Interop API}.
@@ -161,140 +158,140 @@ export default class Fdc3Module2 extends Base implements FDC3v2.DesktopAgent {
     constructor(wire: Transport);
     /**
      * Launches an app, specified via an AppIdentifier object.
-     * @param { AppIdentifier | TargetApp } app
-     * @param { Context } [context]
-     * @returns { Promise<AppIdentifier> }
+     * @param app
+     * @param context
+     *
      * @tutorial fdc3.open
      */
     open(app: FDC3v2.AppIdentifier | FDC3v1.TargetApp, context?: FDC3v2.Context): Promise<FDC3v2.AppIdentifier>;
     /**
      * Find all the available instances for a particular application.
-     * @param { AppIdentifier } app
-     * @returns { Promise<Array<AppIdentifier>> }
+     * @param app
+     *
      * @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)> }
+     * @param app
+     *
      * @tutorial fdc3v2.getAppMetadata
      */
     getAppMetadata(app: FDC3v2.AppIdentifier): Promise<FDC3v2.AppMetadata>;
     /**
      * Broadcasts a context for the channel of the current entity.
-     * @param { Context } context - New context to set.
-     * @returns { Promise<void> }
+     * @param context - New context to set.
+     *
      * @tutorial fdc3.broadcast
      */
     broadcast(context: FDC3v2.Context): Promise<void>;
     /**
      * Add a context handler for incoming context. If an entity is part of a context group, and then sets its context handler, it will receive all of its declared contexts. If you wish to listen for all incoming contexts, pass `null` for the contextType argument.
-     * @param { string | null } contextType
-     * @param { ContextHandler(2) } handler
-     * @returns { Listener }
+     * @param contextType
+     * @param handler
+     *
      * @tutorial fdc3.addContextListener
      */
     addContextListener(contextType: string | null, handler: FDC3v2.ContextHandler): Promise<FDC3v2.Listener>;
     /**
      * Find out more information about a particular intent by passing its name, and optionally its context and resultType.
-     * @param { string } intent Name of the Intent
-     * @param { Context } [context] Context
-     * @param { string } [resultType] The type of result returned for any intent specified during resolution.
-     * @returns { Promise<AppIntent(2)> }
+     * @param intent Name of the Intent
+     * @param context Context
+     * @param resultType The type of result returned for any intent specified during resolution.
+     *
      * @tutorial fdc3.findIntent
      */
     findIntent(intent: string, context?: FDC3v2.Context, resultType?: string): Promise<FDC3v2.AppIntent>;
     /**
      * Find all the available intents for a particular context.
-     * @param { Context } context
-     * @param { string } [resultType] The type of result returned for any intent specified during resolution.
-     * @returns { Promise<Array<AppIntent(2)>> }
+     * @param context
+     * @param resultType The type of result returned for any intent specified during resolution.
+     *
      * @tutorial fdc3v2.findIntentsByContext
      */
     findIntentsByContext(context: FDC3v2.Context, resultType?: string): Promise<Array<FDC3v2.AppIntent>>;
     /**
      * Raises a specific intent for resolution against apps registered with the desktop agent.
-     * @param { string } intent Name of the Intent
-     * @param { Context } context Context associated with the Intent
-     * @param { AppIdentifier | TargetApp } [app]
-     * @returns { Promise<IntentResolution(2)> }
+     * @param intent Name of the Intent
+     * @param context Context associated with the Intent
+     * @param app
+     *
      * @tutorial fdc3v2.raiseIntent
      */
     raiseIntent(intent: string, context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
      * Finds and raises an intent against apps registered with the desktop agent based purely on the type of the context data.
-     * @param { Context } context Context associated with the Intent
-     * @param { AppIdentifier | TargetApp } [app]
-     * @returns { Promise<IntentResolution(2)> }
+     * @param context Context associated with the Intent
+     * @param app
+     *
      * @tutorial fdc3v2.raiseIntentForContext
      */
     raiseIntentForContext(context: FDC3v2.Context, app?: FDC3v2.AppIdentifier | FDC3v1.TargetApp): Promise<FDC3v2.IntentResolution>;
     /**
      * Adds a listener for incoming intents.
-     * @param { string } intent  Name of the Intent
-     * @param { IntentHandler(2) } handler A callback that handles a context event and may return a promise of a Context or Channel object to be returned to the application that raised the intent.
-     * @returns { Promise<Listener> }
+     * @param intent  Name of the Intent
+     * @param handler A callback that handles a context event and may return a promise of a Context or Channel object to be returned to the application that raised the intent.
+     *
      * @tutorial fdc3.addIntentListener
      */
     addIntentListener(intent: string, handler: FDC3v2.IntentHandler): Promise<FDC3v1.Listener>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
-     * @returns { Promise<Channel> }
+     *
      * @tutorial fdc3.getOrCreateChannel
      */
     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 fdc3v2.createPrivateChannel
      */
     createPrivateChannel(): Promise<FDC3v2.PrivateChannel>;
     /**
      * Retrieves a list of the User Channels available for the app to join.
-     * @returns { Promise<Channel[]>}
+     *
      * @tutorial fdc3v2.getUserChannels
      */
     getUserChannels(): Promise<Array<FDC3v1.SystemChannel>>;
     /**
      * Retrieves a list of the User Channels available for the app to join.
-     * @returns { Promise<Channel[]>}
+     *
      * @deprecated Please use {@link fdc3.getUserChannels fdc3.getUserChannels} instead
      * @tutorial fdc3.getSystemChannels
      */
     getSystemChannels(): Promise<Array<FDC3v1.SystemChannel>>;
     /**
      * Join an app to a specified User channel.
-     * @param { string } channelId Channel name
-     * @returns { Promise<void> }
+     * @param channelId Channel name
+     *
      * @tutorial fdc3v2.joinUserChannel
      */
     joinUserChannel(channelId: string): Promise<void>;
     /**
      * Join an app to a specified User channel.
-     * @param { string } channelId Channel name
+     * @param channelId Channel name
      * @deprecated Please use {@link fdc3.joinUserChannel fdc3.joinUserChannel} instead
-     * @returns { Promise<void> }
+     *
      * @tutorial fdc3.joinChannel
      */
     joinChannel(channelId: string): Promise<void>;
     /**
      * Returns the Channel object for the current User channel membership
-     * @returns { Promise<FDC3.Channel | null> }
+     *
      * @tutorial fdc3.getCurrentChannel
      */
     getCurrentChannel(): Promise<FDC3v2.Channel | null>;
     /**
      * Removes the app from any User channel membership.
-     * @returns { Promise<void> }
+     *
      * @tutorial fdc3.leaveCurrentChannel
      */
     leaveCurrentChannel(): Promise<void>;
     /**
      * 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 fdc3v2.getInfo
      */
     getInfo(): Promise<FDC3v2.ImplementationMetadata>;