@openfin/fdc3-api 46.100.87 → 46.100.88

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

@@ -7408,16 +7408,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -20538,6 +20543,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

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

@@ -7408,16 +7408,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -20538,6 +20543,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

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

@@ -7408,16 +7408,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -20538,6 +20543,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

package/out/fdc3-api.d.ts

@@ -7559,16 +7559,21 @@ declare class InterApplicationBus extends Base {
      * Subscribes to messages from the specified application on the specified topic.
      * @param source This object is described in the Identity in the typedef
      * @param topic The topic on which the message is sent
-     * @param listener A function that is called when a message has
-     * been received. It is passed the message, uuid and name of the sending application.
+     * @param listener A function that is called when a message has been received. It is passed
+     * two arguments: the message, and the identity (`{ uuid, name }`) of the sender.
      * The message can be either a primitive data type (string, number, or boolean) or
      * composite data type (object, array) that is composed of other primitive or composite
      * data types
      *
+     * @remarks This differs from the legacy `fin.desktop.InterApplicationBus.subscribe` API,
+     * which passes `(message, uuid, name)` as separate arguments.
+     *
      * @example
      * ```js
      * // subscribe to a specified application
-     * fin.InterApplicationBus.subscribe(fin.me, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
+     * fin.InterApplicationBus.subscribe(fin.me, 'topic', (message, sender) => {
+     *     console.log(`Received from ${sender.uuid}/${sender.name}:`, message);
+     * }).then(() => console.log('Subscribed to the specified application')).catch(err => console.log(err));
      *
      * // subscribe to wildcard
      * fin.InterApplicationBus.subscribe({ uuid: '*' }, 'topic', sub_msg => console.log(sub_msg)).then(() => console.log('Subscribed to *')).catch(err => console.log(err));
@@ -21077,6 +21082,9 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
     /**
      * Removes focus from the window.
      *
+     * @remarks On macOS, a modal window (created with `modalParentIdentity`) is hidden instead, because
+     * moving a modal sheet behind its parent would leave the parent unable to show other dialogs.
+     *
      * @example
      * ```js
      * async function blurWindow() {

package/package.json

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