@openfin/core 33.76.31 → 33.76.36

package/src/api/events/application.js

@@ -1,2 +1,14 @@
 "use strict";
+/**
+ * Namespace for events that can be transmitted on an OpenFin Application's EventEmitter.  Includes events
+ * re-propagate from the `Window` (and, transitively, `View`) level, prefixed with `window-` (and also, if applicable, `view-`).
+ * For example, a view's "shown" event will fire as 'window-view-shown' at the application level.
+ *
+ * Application events re-propagate to the system level, prefixed with `application-`.  For example,
+ * the `closed` event will fire as `application-closed` at the system level.  Propagated events from
+ * WebContents within an application will *not* transitively re-propagate to the system level, because they are already
+ * visible at the system level and contain the identity of the application.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/events/channel.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin Channel's EventEmitter.
+ *
+ * @packageDocumentation
+ */
 import { NamedEvent } from './base';
 /**
  * A base Channel event.

package/src/api/events/channel.js

@@ -1,2 +1,7 @@
 "use strict";
+/**
+ * Namespace for events that can be transmitted on an OpenFin Channel's EventEmitter.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/events/externalApplication.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin ExternalApplication's EventEmitter.
+ *
+ * @packageDocumentation
+ */
 import { BaseEvent } from './base';
 /**
  * Generated when an external application has authenticated and is connected.

package/src/api/events/externalApplication.js

@@ -1,2 +1,7 @@
 "use strict";
+/**
+ * Namespace for events that can be transmitted on an OpenFin ExternalApplication's EventEmitter.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/events/frame.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin Frame's EventEmitter.
+ *
+ * @packageDocumentation
+ */
 import { NamedEvent } from './base';
 /**
  * The base frame event.

package/src/api/events/globalHotkey.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin GlobalHotkey's EventEmitter.
+ *
+ * @packageDocumentation
+ */
 import { BaseEvent } from './base';
 /**
  * Generated when a hotkey has been registered with the operating system.

package/src/api/events/platform.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin Platform's EventEmitter.
+ *
+ * The Platform `EventEmitter` is a superset of the Application's `EventEmitter`,
+ * meaning it can listen to all Application events, along with some Platform-specific events.
+ *
+ * @packageDocumentation
+ */
 import { ApplicationEvent } from './application';
 import { BaseEvent } from './base';
 /**
@@ -8,7 +16,7 @@ export type PlatformApiReadyEvent = BaseEvent & {
     type: 'platform-api-ready';
 };
 /**
- * Generated when a <a href="tutorial-Platform.applySnapshot.html">platform.ApplySnapshot</a> call is resolved.
+ * Generated when a platform.ApplySnapshot call is resolved.
  * @remarks The call is resolved when the following conditions are met for all windows in the snapshot:
  * 1. The window has been created
  * 2. The window has a responsive API

package/src/api/events/platform.js

@@ -1,2 +1,10 @@
 "use strict";
+/**
+ * Namespace for events that can be transmitted on an OpenFin Platform's EventEmitter.
+ *
+ * The Platform `EventEmitter` is a superset of the Application's `EventEmitter`,
+ * meaning it can listen to all Application events, along with some Platform-specific events.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/events/system.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Namespace for runtime-wide OpenFin events that transmit on the OpenFin System event emitter.  Includes events
+ * re-propagated from individual applications, windows, and views (prefixed with `application-`, `window-`, and `view-`).  All
+ * event propagations are visible at the System level, regardless of source, so transitive re-propagations (e.g. from view to window)
+ * are visible in their entirety.  Propagated events from WebContents (windows, views, frames) to the Application level will *not*
+ * transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
+ * of the application.
+ *
+ * For example, an application's "closed" event will fire as 'application-closed' at the system level.  A view's 'shown' event
+ * will be visible as both 'view-shown' and 'window-view-shown' at the system level, but *not* as `application-window-view-shown`.
+ *
+ * @packageDocumentation
+ */
 import type * as OpenFin from '../../OpenFin';
 import { PropagatedApplicationEvent } from './application';
 import { BaseEvent, IdentityEvent } from './base';

package/src/api/events/system.js

@@ -1,2 +1,15 @@
 "use strict";
+/**
+ * Namespace for runtime-wide OpenFin events that transmit on the OpenFin System event emitter.  Includes events
+ * re-propagated from individual applications, windows, and views (prefixed with `application-`, `window-`, and `view-`).  All
+ * event propagations are visible at the System level, regardless of source, so transitive re-propagations (e.g. from view to window)
+ * are visible in their entirety.  Propagated events from WebContents (windows, views, frames) to the Application level will *not*
+ * transitively re-propagate to the System level, because they are already visible at the system level and contain the identity
+ * of the application.
+ *
+ * For example, an application's "closed" event will fire as 'application-closed' at the system level.  A view's 'shown' event
+ * will be visible as both 'view-shown' and 'window-view-shown' at the system level, but *not* as `application-window-view-shown`.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +1,20 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin View's EventEmitter.
+ *
+ * View events fall into two categories: propagated and non-propagated.  Propagated events will
+ * be re-emitted on the parent window of the target view, prefixed with "view-".  For example,
+ * the "shown" event will be re-emitted on the parent window as "view-shown".  Non-propagated events
+ * will not be re-emitted on the parent window.
+ *
+ * @packageDocumentation
+ */
 import type * as OpenFin from '../../OpenFin';
 import { NonPropagatedWebContentsEvent, WillPropagateWebContentsEvent } from './webcontents';
 import { NamedEvent, PropagatedEvent } from './base';
 /**
  * A base View event.
  */
-export type BaseViewEvent = {
+export type BaseViewEvent = NamedEvent & {
     target: OpenFin.Identity;
     viewIdentity: OpenFin.Identity;
 };
@@ -13,7 +23,7 @@ export type BaseViewEvent = {
  * @remarks This event will fire during creation of a View.
  * In that case, previousTarget identity will be the same as target identity.
  */
-export type TargetChangedEvent = NamedEvent & {
+export type TargetChangedEvent = BaseViewEvent & {
     type: 'target-changed';
     previousTarget: OpenFin.Identity;
 };
@@ -24,44 +34,44 @@ export type NonPropagatedViewEvent = BaseViewEvent & NonPropagatedWebContentsEve
 /**
  * Generated when a View is attached to a window.
  */
-export type AttachedEvent = NamedEvent & {
+export type AttachedEvent = BaseViewEvent & {
     type: 'attached';
 };
 /**
  * Generated when a View is created.
  */
-export type CreatedEvent = NamedEvent & {
+export type CreatedEvent = BaseViewEvent & {
     type: 'created';
 };
 /**
  * Generated when a View is destroyed.
  */
-export type DestroyedEvent = NamedEvent & {
+export type DestroyedEvent = BaseViewEvent & {
     type: 'destroyed';
 };
 /**
  * Generated when a View is hidden.
  */
-export type HiddenEvent = NamedEvent & {
+export type HiddenEvent = BaseViewEvent & {
     type: 'hidden';
 };
 /**
  * Generated when a keyboard shortcut defined in the `hotkeys` array in [View options](OpenFin.ViewOptions.html) is pressed inside the view.
  * @remarks For reference on keyboard event properties see [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent).
  */
-export type HotkeyEvent = NamedEvent & {
+export type HotkeyEvent = BaseViewEvent & {
     type: 'hotkey';
 };
 /**
  * Generated when a View is shown. This event will fire during creation of a View.
  */
-export type ShownEvent = NamedEvent & {
+export type ShownEvent = BaseViewEvent & {
     type: 'shown';
 };
 /**
  * A View event that does propagate to (republish on) parent topics.
  */
-export type WillPropagateViewEvent = BaseViewEvent & (WillPropagateWebContentsEvent | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent);
+export type WillPropagateViewEvent = WillPropagateWebContentsEvent | AttachedEvent | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent;
 /**
  * A View event.
  */

package/src/api/events/view.js

@@ -1,2 +1,12 @@
 "use strict";
+/**
+ * Namespace for events that can be transmitted on an OpenFin View's EventEmitter.
+ *
+ * View events fall into two categories: propagated and non-propagated.  Propagated events will
+ * be re-emitted on the parent window of the target view, prefixed with "view-".  For example,
+ * the "shown" event will be re-emitted on the parent window as "view-shown".  Non-propagated events
+ * will not be re-emitted on the parent window.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/events/webcontents.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Namespace for events shared by all OpenFin WebContents elements (i.e. windows, views, and frames).
+ *
+ * WebContents events are divided into two groups: propagating and non-propagating.  Propagating events
+ * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
+ * parent window, and propagating events in a window will also be emitted on the window's parent application.
+ *
+ * Non-propagating events will not re-emit on parent entities.
+ *
+ * @packageDocumentation
+ */
 import type * as OpenFin from '../../OpenFin';
 import { NamedEvent } from './base';
 import { CrashedEvent } from './application';
@@ -127,20 +138,20 @@ export type ContentCreationRulesEvent = NamedEvent & {
      */
     url: string;
     /**
-    * The features string passed to `window.open()`
-    */
+     * The features string passed to `window.open()`
+     */
     features: string;
     /**
-    * The frame name passed to `window.open()`
-    */
+     * The frame name passed to `window.open()`
+     */
     frameName: string;
     /**
      * The rule which triggered this event. May be undefined on `child-window-created` where no rule corresponds to the child Window creation
      */
     rule: OpenFin.ContentCreationRule;
     /**
-    * The features string passed to `window.open()` converted to OpenFin window options
-    */
+     * The features string passed to `window.open()` converted to OpenFin window options
+     */
     parsedFeatures: Partial<OpenFin.WindowOptions>;
     disposition: string;
 };
@@ -162,8 +173,8 @@ export type ChildContentOpenedInBrowserEvent = ContentCreationRulesEvent & {
 export type ChildViewCreatedEvent = ContentCreationRulesEvent & {
     type: 'child-view-created';
     /**
-    * The options the child View was created with.
-    */
+     * The options the child View was created with.
+     */
     childOptions: OpenFin.ViewOptions;
 };
 /**
@@ -172,8 +183,8 @@ export type ChildViewCreatedEvent = ContentCreationRulesEvent & {
 export type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
     type: 'child-window-created';
     /**
-    * The options the child Window was created with.
-    */
+     * The options the child Window was created with.
+     */
     childOptions: OpenFin.WindowOptions;
     /**
      * On `child-window-created` rule may be undefined.

package/src/api/events/webcontents.js

@@ -1,2 +1,13 @@
 "use strict";
+/**
+ * Namespace for events shared by all OpenFin WebContents elements (i.e. windows, views, and frames).
+ *
+ * WebContents events are divided into two groups: propagating and non-propagating.  Propagating events
+ * will re-emit on parent entities - e.g., a propagating event in a view will also be emitted on the view's
+ * parent window, and propagating events in a window will also be emitted on the window's parent application.
+ *
+ * Non-propagating events will not re-emit on parent entities.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,3 +1,13 @@
+/**
+ * Namespace for events that can be transmitted on an OpenFin Window's EventEmitter.
+ *
+ * Window events fall into two categories: propagated and non-propagated.  Propagated events will
+ * be re-emitted on the parent application of the target window, prefixed with "window-".  For example,
+ * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded".  Non-propagated
+ * events will not be re-emitted on the parent application.
+ *
+ * @packageDocumentation
+ */
 import type * as OpenFin from '../../OpenFin';
 import { NamedEvent, PropagatedEvent } from './base';
 import { BaseViewEvent, PropagatedViewEvent, AttachedEvent as ViewAttachedEvent } from './view';
@@ -12,7 +22,66 @@ export type AlertRequestedEvent = NamedEvent & {
 };
 /**
  * Generated when a window within this application requires credentials from the user.
- * @remarks If there is a proxy, please see {@tutorial Proxy.behaviorChange} for more details.
+ * @remarks When a proxy exists, our default behavior shows an auth dialog, and asks users to enter their username and password.
+ * If you would like to change the default behavior, you can use the 'window-auth-requested' event to override it.
+ *
+ * Show customized auth dialog instead of default auth dialog:
+ * ```js
+ *
+ * // Sample code to create a login window. Users can create their own login pages
+ * async function createAuthUI(identity, loginPageUrl, authInfo) {
+ *     const winName = 'my-auth-win-' + Date.now();
+ *     const uriUuid = encodeURIComponent(identity.uuid);
+ *     const uriName = encodeURIComponent(identity.name);
+ *
+ *     const url = `http://${authInfo.host}:${authInfo.port}`;
+ *     // login page should handle these query params
+ * 	loginPageUrl = `${loginPageUrl}?uuid=${uriUuid}&name=${uriName}&url=${url}`;
+ * 	await fin.Window.create({
+ *         url: loginPageUrl,
+ *         uuid: identity.uuid,
+ *         name: winName,
+ *         alwaysOnTop: true,
+ *         autoShow: true,
+ *         defaultCentered: true,
+ *         defaultHeight: 271,
+ *         defaultTop: true,
+ *         defaultWidth: 362,
+ *         frame: false,
+ *         resizable: false
+ * 	});
+ * }
+ *
+ * const app = fin.Application.getCurrentSync();
+ * app.on('window-auth-requested', (event) => {
+ *     if (event.authInfo.isProxy) {
+ *         const identity = { uuid: event.uuid, name: event.name};
+ *         createAuthUI(identity, 'userLoginPageUrl', event.authInfo);
+ *     }
+ *
+ * });
+ * ```
+ *
+ * Don't show any auth dialog:
+ * ```js
+ * const app = fin.Application.getCurrentSync();
+ * app.on('window-auth-requested', event => {
+ *     if (event.authInfo.isProxy) {
+ *         console.log('no auth dialog');
+ *     }
+ * });
+ * ```
+ *
+ * User defined function. For example, showing a single dialog, alerting a support team and so on:
+ * ```js
+ * const app = fin.Application.getCurrentSync();
+ * app.on('window-auth-requested', event => {
+ *     if (event.authInfo.isProxy) {
+ *         // user defined function
+ *         alert('Do whatever you like');
+ *     }
+ * });
+ * ```
  */
 export type AuthRequestedEvent = NamedEvent & {
     type: 'auth-requested';

package/src/api/events/window.js

@@ -1,2 +1,12 @@
 "use strict";
+/**
+ * Namespace for events that can be transmitted on an OpenFin Window's EventEmitter.
+ *
+ * Window events fall into two categories: propagated and non-propagated.  Propagated events will
+ * be re-emitted on the parent application of the target window, prefixed with "window-".  For example,
+ * a window's "reloaded" event will be re-emitted on the parent application as "window-reloaded".  Non-propagated
+ * events will not be re-emitted on the parent application.
+ *
+ * @packageDocumentation
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/src/api/external-application/Factory.d.ts

@@ -1,16 +1,18 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-/**
- * @lends ExternalApplication
- */
 export default class ExternalApplicationModule extends Base {
     /**
      * Asynchronously returns an External Application object that represents an external application.
      * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
      * provided its uuid is already known.
-     * @param {string} uuid The UUID of the external application to be wrapped
-     * @return {Promise.<ExternalApplication>}
-     * @tutorial ExternalApplication.wrap
+     * @param uuid The UUID of the external application to be wrapped
+     *
+     * @example
+     * ```js
+     * fin.ExternalApplication.wrap('javaApp-uuid');
+     * .then(extApp => console.log('wrapped external application'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     wrap(uuid: string): Promise<OpenFin.ExternalApplication>;
@@ -18,9 +20,14 @@ export default class ExternalApplicationModule extends Base {
      * Synchronously returns an External Application object that represents an external application.
      * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
      * provided its uuid is already known.
-     * @param {string} uuid The UUID of the external application to be wrapped
-     * @return {ExternalApplication}
-     * @tutorial ExternalApplication.wrapSync
+     * @param uuid The UUID of the external application to be wrapped
+     *
+     * @example
+     * ```js
+     * const extApp = fin.ExternalApplication.wrapSync('javaApp-uuid');
+     * const info = await extApp.getInfo();
+     * console.log(info);
+     * ```
      * @static
      */
     wrapSync(uuid: string): OpenFin.ExternalApplication;

package/src/api/external-application/Factory.js

@@ -2,17 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const Instance_1 = require("./Instance");
-/**
- * @lends ExternalApplication
- */
 class ExternalApplicationModule extends base_1.Base {
     /**
      * Asynchronously returns an External Application object that represents an external application.
      * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
      * provided its uuid is already known.
-     * @param {string} uuid The UUID of the external application to be wrapped
-     * @return {Promise.<ExternalApplication>}
-     * @tutorial ExternalApplication.wrap
+     * @param uuid The UUID of the external application to be wrapped
+     *
+     * @example
+     * ```js
+     * fin.ExternalApplication.wrap('javaApp-uuid');
+     * .then(extApp => console.log('wrapped external application'))
+     * .catch(err => console.log(err));
+     * ```
      * @static
      */
     wrap(uuid) {
@@ -25,9 +27,14 @@ class ExternalApplicationModule extends base_1.Base {
      * Synchronously returns an External Application object that represents an external application.
      * <br>It is possible to wrap a process that does not yet exist, (for example, to listen for startup-related events)
      * provided its uuid is already known.
-     * @param {string} uuid The UUID of the external application to be wrapped
-     * @return {ExternalApplication}
-     * @tutorial ExternalApplication.wrapSync
+     * @param uuid The UUID of the external application to be wrapped
+     *
+     * @example
+     * ```js
+     * const extApp = fin.ExternalApplication.wrapSync('javaApp-uuid');
+     * const info = await extApp.getInfo();
+     * console.log(info);
+     * ```
      * @static
      */
     wrapSync(uuid) {

package/src/api/external-application/Instance.d.ts

@@ -2,26 +2,27 @@ import type * as OpenFin from '../../OpenFin';
 import { EmitterBase } from '../base';
 import { Transport } from '../../transport/transport';
 /**
- * @classdesc An ExternalApplication object representing native language adapter connections to the runtime. Allows
- * the developer to listen to <a href="tutorial-ExternalApplication.EventEmitter.html">application events.</a>
+ * An ExternalApplication object representing native language adapter connections to the runtime. Allows
+ * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
  * Discovery of connections is provided by <a href="tutorial-System.getAllExternalApplications.html">getAllExternalApplications.</a>
  *
  * Processes that can be wrapped as `ExternalApplication`s include the following:
  * - Processes which have connected to an OpenFin runtime via an adapter
  * - Processes started via `System.launchExternalApplication`
  * - Processes monitored via `System.monitorExternalProcess`
- * @class
- * @hideconstructor
  */
 export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
     identity: OpenFin.ApplicationIdentity;
+    /**
+     * @internal
+     */
     constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function addListener
      * @memberof ExternalApplication
      * @instance
@@ -29,10 +30,10 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
      */
     /**
      * Adds a listener to the end of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - Called whenever an event of the specified type occurs.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - Called whenever an event of the specified type occurs.
+     * @param options - Option to support event timestamps.
+     *
      * @function on
      * @memberof ExternalApplication
      * @instance
@@ -40,10 +41,10 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
      */
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function once
      * @memberof ExternalApplication
      * @instance
@@ -51,10 +52,10 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
      */
     /**
      * Adds a listener to the beginning of the listeners array for the specified event.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependListener
      * @memberof ExternalApplication
      * @instance
@@ -63,10 +64,10 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
     /**
      * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
      * The listener is added to the beginning of the listeners array.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function prependOnceListener
      * @memberof ExternalApplication
      * @instance
@@ -75,10 +76,10 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
     /**
      * Remove a listener from the listener array for the specified event.
      * Caution: Calling this method changes the array indices in the listener array behind the listener.
-     * @param { string | symbol } eventType  - The type of the event.
-     * @param { Function } listener - The callback function.
-     * @param { SubOptions } [options] - Option to support event timestamps.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     * @param listener - The callback function.
+     * @param options - Option to support event timestamps.
+     *
      * @function removeListener
      * @memberof ExternalApplication
      * @instance
@@ -86,8 +87,8 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
      */
     /**
      * Removes all listeners, or those of the specified event.
-     * @param { string | symbol } [eventType]  - The type of the event.
-     * @return {Promise.<this>}
+     * @param eventType  - The type of the event.
+     *
      * @function removeAllListeners
      * @memberof ExternalApplication
      * @instance
@@ -95,8 +96,15 @@ export declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApp
      */
     /**
      * Retrieves information about the external application.
-     * @return {Promise.<ExternalApplicationInfo>}
-     * @tutorial ExternalApplication.getInfo
+     *
+     * @example
+     * ```js
+     * async function getInfo() {
+     *     const extApp = await fin.ExternalApplication.wrap('javaApp-uuid');
+     *     return await extApp.getInfo();
+     * }
+     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
+     * ```
      */
     getInfo(): Promise<OpenFin.ExternalApplicationInfo>;
 }