@openfin/core 33.76.27 → 33.76.36

package/src/api/application/Instance.js

@@ -6,12 +6,13 @@ const base_1 = require("../base");
 const window_1 = require("../window");
 const view_1 = require("../view");
 /**
- * @classdesc An object representing an application. Allows the developer to create,
- * execute, show/close an application as well as listen to <a href="tutorial-Application.EventEmitter.html">application events</a>.
- * @class
- * @hideconstructor
+ * An object representing an application. Allows the developer to create,
+ * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
  */
 class Application extends base_1.EmitterBase {
+    /**
+     * @internal
+     */
     constructor(wire, identity) {
         super(wire, 'application', identity.uuid);
         this.identity = identity;
@@ -32,10 +33,10 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * 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 Application
      * @instance
@@ -43,10 +44,10 @@ class Application extends base_1.EmitterBase {
      */
     /**
      * 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 Application
      * @instance
@@ -54,10 +55,10 @@ class Application extends base_1.EmitterBase {
      */
     /**
      * 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 Application
      * @instance
@@ -65,10 +66,10 @@ class Application extends base_1.EmitterBase {
      */
     /**
      * 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 Application
      * @instance
@@ -77,10 +78,10 @@ class Application extends base_1.EmitterBase {
     /**
      * 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 Application
      * @instance
@@ -89,10 +90,10 @@ class Application extends base_1.EmitterBase {
     /**
      * 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 Application
      * @instance
@@ -100,18 +101,13 @@ class Application extends base_1.EmitterBase {
      */
     /**
      * 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 Application
      * @instance
      * @tutorial Application.EventEmitter
      */
-    /**
-     * Determines if the application is currently running.
-     * @return {Promise.<boolean>}
-     * @tutorial Application.isRunning
-     */
     /**
      * JumpListCategory interface
      * @typedef { object } JumpListCategory
@@ -129,16 +125,40 @@ class Application extends base_1.EmitterBase {
      * @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
      * @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
      */
+    /**
+     * Determines if the application is currently running.
+     *
+     * @example
+     *
+     * ```js
+     * async function isAppRunning() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.isRunning();
+     * }
+     * isAppRunning().then(running => console.log(`Current app is running: ${running}`)).catch(err => console.log(err));
+     * ```
+     */
     isRunning() {
         return this.wire.sendAction('is-application-running', this.identity).then(({ payload }) => payload.data);
     }
     /**
      * Closes the application and any child windows created by the application.
      * Cleans the application from state so it is no longer found in getAllApplications.
-     * @param { boolean } [force = false] Close will be prevented from closing when force is false and
+     * @param force Close will be prevented from closing when force is false and
      *  ‘close-requested’ has been subscribed to for application’s main window.
-     * @return {Promise.<boolean>}
-     * @tutorial Application.quit
+     *
+     * @example
+     *
+     * ```js
+     * async function closeApp() {
+     *     const allApps1 = await fin.System.getAllApplications(); //[{uuid: 'app1', isRunning: true}, {uuid: 'app2', isRunning: true}]
+     *     const app = await fin.Application.wrap({uuid: 'app2'});
+     *     await app.quit();
+     *     const allApps2 = await fin.System.getAllApplications(); //[{uuid: 'app1', isRunning: true}]
+     *
+     * }
+     * closeApp().then(() => console.log('Application quit')).catch(err => console.log(err));
+     * ```
      */
     async quit(force = false) {
         try {
@@ -162,6 +182,23 @@ class Application extends base_1.EmitterBase {
             }
         }
     }
+    /**
+     * @deprecated use Application.quit instead
+     * Closes the application and any child windows created by the application.
+     * @param force - Close will be prevented from closing when force is false and ‘close-requested’ has been subscribed to for application’s main window.
+     * @param callback - called if the method succeeds.
+     * @param errorCallback - called if the method fails. The reason for failure is passed as an argument.
+     *
+     * @example
+     *
+     * ```js
+     * async function closeApp() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.close();
+     * }
+     * closeApp().then(() => console.log('Application closed')).catch(err => console.log(err));
+     * ```
+     */
     close(force = false) {
         console.warn('Deprecation Warning: Application.close is deprecated Please use Application.quit');
         this.wire.sendAction('application-close', this.identity).catch((e) => {
@@ -171,8 +208,17 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * Retrieves an array of wrapped fin.Windows for each of the application’s child windows.
-     * @return {Promise.Array.<_Window>}
-     * @tutorial Application.getChildWindows
+     *
+     * @example
+     *
+     * ```js
+     * async function getChildWindows() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.getChildWindows();
+     * }
+     *
+     * getChildWindows().then(children => console.log(children)).catch(err => console.log(err));
+     * ```
      */
     getChildWindows() {
         return this.wire.sendAction('get-child-windows', this.identity).then(({ payload }) => {
@@ -186,8 +232,17 @@ class Application extends base_1.EmitterBase {
     /**
      * Retrieves the JSON manifest that was used to create the application. Invokes the error callback
      * if the application was not created from a manifest.
-     * @return {Promise.<Manifest>}
-     * @tutorial Application.getManifest
+     *
+     * @example
+     *
+     * ```js
+     * async function getManifest() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.getManifest();
+     * }
+     *
+     * getManifest().then(manifest => console.log(manifest)).catch(err => console.log(err));
+     * ```
      */
     getManifest() {
         return this.wire.sendAction('get-application-manifest', this.identity).then(({ payload }) => payload.data);
@@ -195,16 +250,38 @@ class Application extends base_1.EmitterBase {
     /**
      * Retrieves UUID of the application that launches this application. Invokes the error callback
      * if the application was created from a manifest.
-     * @return {Promise.<string>}
-     * @tutorial Application.getParentUuid
+     *
+     * @example
+     *
+     * ```js
+     * async function getParentUuid() {
+     *     const app = await fin.Application.start({
+     *         uuid: 'app-1',
+     *         name: 'myApp',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.getParentUuid.html',
+     *         autoShow: true
+     *     });
+     *     return await app.getParentUuid();
+     * }
+     *
+     * getParentUuid().then(parentUuid => console.log(parentUuid)).catch(err => console.log(err));
+     * ```
      */
     getParentUuid() {
         return this.wire.sendAction('get-parent-application', this.identity).then(({ payload }) => payload.data);
     }
     /**
      * Retrieves current application's shortcut configuration.
-     * @return {Promise.<ShortCutConfig>}
-     * @tutorial Application.getShortcuts
+     *
+     * @example
+     *
+     * ```js
+     * async function getShortcuts() {
+     *     const app = await fin.Application.wrap({ uuid: 'testapp' });
+     *     return await app.getShortcuts();
+     * }
+     * getShortcuts().then(config => console.log(config)).catch(err => console.log(err));
+     * ```
      */
     getShortcuts() {
         return this.wire.sendAction('get-shortcuts', this.identity).then(({ payload }) => payload.data);
@@ -212,8 +289,16 @@ class Application extends base_1.EmitterBase {
     /**
      * Retrieves current application's views.
      * @experimental
-     * @return {Promise.Array.<View>}
-     * @tutorial Application.getViews
+     *
+     * @example
+     *
+     * ```js
+     * async function getViews() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.getViews();
+     * }
+     * getViews().then(views => console.log(views)).catch(err => console.log(err));
+     * ```
      */
     async getViews() {
         const { payload } = await this.wire.sendAction('application-get-views', this.identity);
@@ -221,16 +306,42 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * Returns the current zoom level of the application.
-     * @return {Promise.<number>}
-     * @tutorial Application.getZoomLevel
+     *
+     * @example
+     *
+     * ```js
+     * async function getZoomLevel() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.getZoomLevel();
+     * }
+     *
+     * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
+     * ```
      */
     getZoomLevel() {
         return this.wire.sendAction('get-application-zoom-level', this.identity).then(({ payload }) => payload.data);
     }
     /**
      * Returns an instance of the main Window of the application
-     * @return {Promise.<_Window>}
-     * @tutorial Application.getWindow
+     *
+     * @example
+     *
+     * ```js
+     * async function getWindow() {
+     *     const app = await fin.Application.start({
+     *         uuid: 'app-1',
+     *         name: 'myApp',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.getWindow.html',
+     *         autoShow: true
+     *     });
+     *     return await app.getWindow();
+     * }
+     *
+     * getWindow().then(win => {
+     *     win.showAt(0, 400);
+     *     win.flash();
+     * }).catch(err => console.log(err));
+     * ```
      */
     getWindow() {
         this.wire.sendAction('application-get-window', this.identity).catch((e) => {
@@ -240,26 +351,52 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * Manually registers a user with the licensing service. The only data sent by this call is userName and appName.
-     * @param { string } userName - username to be passed to the RVM.
-     * @param { string } appName - app name to be passed to the RVM.
-     * @return {Promise.<void>}
-     * @tutorial Application.registerUser
+     * @param userName - username to be passed to the RVM.
+     * @param appName - app name to be passed to the RVM.
+     *
+     * @example
+     *
+     * ```js
+     * async function registerUser() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.registerUser('user', 'myApp');
+     * }
+     *
+     * registerUser().then(() => console.log('Successfully registered the user')).catch(err => console.log(err));
+     * ```
      */
     registerUser(userName, appName) {
         return this.wire.sendAction('register-user', { userName, appName, ...this.identity }).then(() => undefined);
     }
     /**
      * Removes the application’s icon from the tray.
-     * @return {Promise.<void>}
-     * @tutorial Application.removeTrayIcon
+     *
+     * @example
+     *
+     * ```js
+     * async function removeTrayIcon() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.removeTrayIcon();
+     * }
+     *
+     * removeTrayIcon().then(() => console.log('Removed the tray icon.')).catch(err => console.log(err));
+     * ```
      */
     removeTrayIcon() {
         return this.wire.sendAction('remove-tray-icon', this.identity).then(() => undefined);
     }
     /**
      * Restarts the application.
-     * @return {Promise.<void>}
-     * @tutorial Application.restart
+     *
+     * @example
+     *
+     * ```js
+     * async function restartApp() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.restart();
+     * }
+     * restartApp().then(() => console.log('Application restarted')).catch(err => console.log(err));
+     * ```
      */
     restart() {
         return this.wire.sendAction('restart-application', this.identity).then(() => undefined);
@@ -267,8 +404,22 @@ class Application extends base_1.EmitterBase {
     /**
      * DEPRECATED method to run the application.
      * Needed when starting application via {@link Application.create}, but NOT needed when starting via {@link Application.start}.
-     * @return {Promise.<void>}
-     * @tutorial Application.run
+     *
+     * @example
+     *
+     * ```js
+     * async function run() {
+     *     const app = await fin.Application.create({
+     *         name: 'myApp',
+     *         uuid: 'app-1',
+     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.run.html',
+     *         autoShow: true
+     *     });
+     *     await app.run();
+     * }
+     * run().then(() => console.log('Application is running')).catch(err => console.log(err));
+     * ```
+     *
      * @ignore
      */
     run() {
@@ -289,8 +440,17 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * Instructs the RVM to schedule one restart of the application.
-     * @return {Promise.<void>}
-     * @tutorial Application.scheduleRestart
+     *
+     * @example
+     *
+     * ```js
+     * async function scheduleRestart() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.scheduleRestart();
+     * }
+     *
+     * scheduleRestart().then(() => console.log('Application is scheduled to restart')).catch(err => console.log(err));
+     * ```
      */
     scheduleRestart() {
         return this.wire.sendAction('relaunch-on-close', this.identity).then(() => undefined);
@@ -298,8 +458,17 @@ class Application extends base_1.EmitterBase {
     /**
      * Sends a message to the RVM to upload the application's logs. On success,
      * an object containing logId is returned.
-     * @return {Promise.<SendApplicationLogResponse>}
-     * @tutorial Application.sendApplicationLog
+     *
+     * @example
+     *
+     * ```js
+     * async function sendLog() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.sendApplicationLog();
+     * }
+     *
+     * sendLog().then(info => console.log(info.logId)).catch(err => console.log(err));
+     * ```
      */
     async sendApplicationLog() {
         const { payload } = await this.wire.sendAction('send-application-log', this.identity);
@@ -309,18 +478,120 @@ class Application extends base_1.EmitterBase {
      * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
      * If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
      * Note: If the "name" property is omitted it defaults to "tasks".
-     * @param { Array.<JumpListCategory> | null } jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
-     * @return { Promise.<void> }
-     * @tutorial Application.setJumpList
+     * @param jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
+     *
+     *
+     * @remarks If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
+     *
+     * The bottommost item in the jumplist will always be an item pointing to the current app. Its name is taken from the manifest's
+     * **` shortcut.name `** and uses **` shortcut.company `** as a fallback. Clicking that item will launch the app from its current manifest.
+     *
+     * Note: If the "name" property is omitted it defaults to "tasks".
+     *
+     * Note: Window OS caches jumplists icons, therefore an icon change might only be visible after the cache is removed or the
+     * uuid or shortcut.name is changed.
+     *
+     * @example
+     *
+     * ```js
+     *     const app = fin.Application.getCurrentSync();
+     *     const appName = 'My App';
+     *     const jumpListConfig = [ // array of JumpList categories
+     *         {
+     *             // has no name and no type so `type` is assumed to be "tasks"
+     *             items: [ // array of JumpList items
+     *             {
+     *                 type: 'task',
+     *                 title: `Launch ${appName}`,
+     *                 description: `Runs ${appName} with the default configuration`,
+     *                 deepLink: 'fins://path.to/app/manifest.json',
+     *                 iconPath: 'https://path.to/app/icon.ico',
+     *                 iconIndex: 0
+     *             },
+     *             { type: 'separator' },
+     *             {
+     *                 type: 'task',
+     *                 title: `Restore ${appName}`,
+     *                 description: 'Restore to last configuration',
+     *                 deepLink: 'fins://path.to/app/manifest.json?$$use-last-configuration=true',
+     *                 iconPath: 'https://path.to/app/icon.ico',
+     *                 iconIndex: 0
+     *             },
+     *             ]
+     *         },
+     *         {
+     *             name: 'Tools',
+     *             items: [ // array of JumpList items
+     *             {
+     *                 type: 'task',
+     *                 title: 'Tool A',
+     *                 description: 'Runs Tool A',
+     *                 deepLink: 'fins://path.to/tool-a/manifest.json',
+     *                 iconPath: 'https://path.to/tool-a/icon.ico',
+     *                 iconIndex: 0
+     *             },
+     *             {
+     *                 type: 'task',
+     *                 title: 'Tool B',
+     *                 description: 'Runs Tool B',
+     *                 deepLink: 'fins://path.to/tool-b/manifest.json',
+     *                 iconPath: 'https://path.to/tool-b/icon.ico',
+     *                 iconIndex: 0
+     *             }]
+     *         }
+     *     ];
+     *
+     *     app.setJumpList(jumpListConfig).then(() => console.log('JumpList applied')).catch(e => console.log(`JumpList failed to apply: ${e.toString()}`));
+     * ```
+     *
+     * To handle deeplink args:
+     * ```js
+     *     function handleUseLastConfiguration() {
+     *         // this handler is called when the app is being launched
+     *         app.on('run-requested', event => {
+     *             if(event.userAppConfigArgs['use-last-configuration']) {
+     *                 // your logic here
+     *             }
+     *         });
+     *         // this handler is called when the app was already running when the launch was requested
+     *         fin.desktop.main(function(args) {
+     *             if(args && args['use-last-configuration']) {
+     *                 // your logic here
+     *             }
+     *         });
+     *     }
+     * ```
      */
     async setJumpList(jumpListCategories) {
         await this.wire.sendAction('set-jump-list', { config: jumpListCategories, ...this.identity });
     }
     /**
      * Adds a customizable icon in the system tray.  To listen for a click on the icon use the `tray-icon-clicked` event.
-     * @param { string } icon Image URL or base64 encoded string to be used as the icon
-     * @return {Promise.<void>}
-     * @tutorial Application.setTrayIcon
+     * @param icon Image URL or base64 encoded string to be used as the icon
+     *
+     * @example
+     *
+     * ```js
+     * const imageUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
+     * const base64EncodedImage = "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX\
+     * ///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII";
+     * const dataURL = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DH\
+     * xgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==";
+     *
+     * async function setTrayIcon(icon) {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.setTrayIcon(icon);
+     * }
+     *
+     * // use image url to set tray icon
+     * setTrayIcon(imageUrl).then(() => console.log('Setting tray icon')).catch(err => console.log(err));
+     *
+     * // use base64 encoded string to set tray icon
+     * setTrayIcon(base64EncodedImage).then(() => console.log('Setting tray icon')).catch(err => console.log(err));
+     *
+     * // use a dataURL to set tray icon
+     * setTrayIcon(dataURL).then(() => console.log('Setting tray icon')).catch(err => console.log(err));
+     * ```
      */
     setTrayIcon(icon) {
         return this.wire
@@ -332,21 +603,44 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * Sets new application's shortcut configuration. Windows only.
-     * @param { ShortCutConfig } config New application's shortcut configuration.
-     * @param { boolean } [config.desktop] - Enable/disable desktop shortcut.
-     * @param { boolean } [config.startMenu] - Enable/disable start menu shortcut.
-     * @param { boolean } [config.systemStartup] - Enable/disable system startup shortcut.
-     * @return {Promise.<void>}
-     * @tutorial Application.setShortcuts
+     * @param config New application's shortcut configuration.
+     *
+     * @remarks Application has to be launched with a manifest and has to have shortcut configuration (icon url, name, etc.) in its manifest
+     * to be able to change shortcut states.
+     *
+     * @example
+     *
+     * ```js
+     * async function setShortcuts(config) {
+     *     const app = await fin.Application.getCurrent();
+     *     return app.setShortcuts(config);
+     * }
+     *
+     * setShortcuts({
+     *     desktop: true,
+     *     startMenu: false,
+     *     systemStartup: true
+     * }).then(() => console.log('Shortcuts are set.')).catch(err => console.log(err));
+     * ```
      */
     setShortcuts(config) {
         return this.wire.sendAction('set-shortcuts', { data: config, ...this.identity }).then(() => undefined);
     }
     /**
      * Sets the query string in all shortcuts for this app. Requires RVM 5.5+.
-     * @param { string } queryString The new query string for this app's shortcuts.
-     * @return {Promise.<void>}
-     * @tutorial Application.setShortcutQueryParams
+     * @param queryString The new query string for this app's shortcuts.
+     *
+     * @example
+     *
+     * ```js
+     * const newQueryArgs = 'arg=true&arg2=false';
+     * const app = await fin.Application.getCurrent();
+     * try {
+     *     await app.setShortcutQueryParams(newQueryArgs);
+     * } catch(err) {
+     *     console.error(err)
+     * }
+     * ```
      */
     async setShortcutQueryParams(queryString) {
         await this.wire.sendAction('set-shortcut-query-args', { data: queryString, ...this.identity });
@@ -354,43 +648,84 @@ class Application extends base_1.EmitterBase {
     /**
      * Sets the zoom level of the application. The original size is 0 and each increment above or below represents zooming 20%
      * larger or smaller to default limits of 300% and 50% of original size, respectively.
-     * @param { number } level The zoom level
-     * @return {Promise.<void>}
-     * @tutorial Application.setZoomLevel
+     * @param level The zoom level
+     *
+     * @example
+     *
+     * ```js
+     * async function setZoomLevel(number) {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.setZoomLevel(number);
+     * }
+     *
+     * setZoomLevel(5).then(() => console.log('Setting a  zoom level')).catch(err => console.log(err));
+     * ```
      */
     setZoomLevel(level) {
         return this.wire.sendAction('set-application-zoom-level', { level, ...this.identity }).then(() => undefined);
     }
     /**
      * Sets a username to correlate with App Log Management.
-     * @param { string } username Username to correlate with App's Log.
-     * @return {Promise.<void>}
-     * @tutorial Application.setAppLogUsername
+     * @param username Username to correlate with App's Log.
+     *
+     * @example
+     *
+     * ```js
+     * async function setAppLogUser() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.setAppLogUsername('username');
+     * }
+     *
+     * setAppLogUser().then(() => console.log('Success')).catch(err => console.log(err));
+     *
+     * ```
      */
     async setAppLogUsername(username) {
         await this.wire.sendAction('set-app-log-username', { data: username, ...this.identity });
     }
     /**
-     * @summary Retrieves information about the system tray. If the system tray is not set, it will throw an error message.
-     * @desc The only information currently returned is the position and dimensions.
-     * @return {Promise.<TrayInfo>}
-     * @tutorial Application.getTrayIconInfo
+     * Retrieves information about the system tray. If the system tray is not set, it will throw an error message.
+     * @remarks The only information currently returned is the position and dimensions.
+     *
+     * @example
+     *
+     * ```js
+     * async function getTrayIconInfo() {
+     *     const app = await fin.Application.wrap({ uuid: 'testapp' });
+     *     return await app.getTrayIconInfo();
+     * }
+     * getTrayIconInfo().then(info => console.log(info)).catch(err => console.log(err));
+     * ```
      */
     getTrayIconInfo() {
         return this.wire.sendAction('get-tray-icon-info', this.identity).then(({ payload }) => payload.data);
     }
     /**
-     * @summary Checks if the application has an associated tray icon.
-     * @return {Promise.<boolean>}
-     * @tutorial Application.hasTrayIcon
+     * Checks if the application has an associated tray icon.
+     *
+     * @example
+     *
+     * ```js
+     * const app = await fin.Application.wrap({ uuid: 'testapp' });
+     * const hasTrayIcon = await app.hasTrayIcon();
+     * console.log(hasTrayIcon);
+     * ```
      */
     hasTrayIcon() {
         return this.wire.sendAction('has-tray-icon', this.identity).then(({ payload }) => payload.data);
     }
     /**
      * Closes the application by terminating its process.
-     * @return {Promise.<void>}
-     * @tutorial Application.terminate
+     *
+     * @example
+     *
+     * ```js
+     * async function terminateApp() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.terminate();
+     * }
+     * terminateApp().then(() => console.log('Application terminated')).catch(err => console.log(err));
+     * ```
      */
     terminate() {
         return this.wire.sendAction('terminate-application', this.identity).then(() => undefined);
@@ -399,7 +734,7 @@ class Application extends base_1.EmitterBase {
      * Waits for a hanging application. This method can be called in response to an application
      * "not-responding" to allow the application to continue and to generate another "not-responding"
      * message after a certain period of time.
-     * @return {Promise.<void>}
+     *
      * @ignore
      */
     wait() {
@@ -407,16 +742,33 @@ class Application extends base_1.EmitterBase {
     }
     /**
      * Retrieves information about the application.
-     * @return {Promise.<ApplicationInfo>}
-     * @tutorial Application.getInfo
+     *
+     * @remarks If the application was not launched from a manifest, the call will return the closest parent application `manifest`
+     * and `manifestUrl`.  `initialOptions` shows the parameters used when launched programmatically, or the `startup_app` options
+     * if launched from manifest. The `parentUuid` will be the uuid of the immediate parent (if applicable).
+     *
+     * @example
+     *
+     * ```js
+     * async function getInfo() {
+     *     const app = await fin.Application.getCurrent();
+     *     return await app.getInfo();
+     * }
+     *
+     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
+     * ```
      */
     getInfo() {
         return this.wire.sendAction('get-info', this.identity).then(({ payload }) => payload.data);
     }
     /**
      * Retrieves all process information for entities (windows and views) associated with an application.
-     * @return {Promise.<AppProcessInfo>}
-     * @tutorial Application.getProcessInfo
+     *
+     * @example
+     * ```js
+     *     const app = await fin.Application.getCurrent();
+     *     const processInfo = await app.getProcessInfo();
+     * ```
      * @experimental
      */
     async getProcessInfo() {
@@ -427,10 +779,21 @@ class Application extends base_1.EmitterBase {
      * Sets file auto download location. It's only allowed in the same application.
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
-     * @param { string } downloadLocation file auto download location
-     * @return {Promise.<void>}
+     * @param downloadLocation file auto download location
+     *
      * @throws if setting file auto download location on different applications.
-     * @tutorial Application.setFileDownloadLocation
+     * @example
+     *
+     * ```js
+     * const downloadLocation = 'C:\\dev\\temp';
+     * const app = await fin.Application.getCurrent();
+     * try {
+     *     await app.setFileDownloadLocation(downloadLocation);
+     *     console.log('File download location is set');
+     * } catch(err) {
+     *     console.error(err)
+     * }
+     * ```
      */
     async setFileDownloadLocation(downloadLocation) {
         const { name } = this.wire.me;
@@ -441,9 +804,14 @@ class Application extends base_1.EmitterBase {
      * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
      * Note: This method is restricted by default and must be enabled via
      * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
-     * @return {Promise.<string>}
+     *
      * @throws if getting file auto download location on different applications.
-     * @tutorial Application.getFileDownloadLocation
+     * @example
+     *
+     * ```js
+     * const app = await fin.Application.getCurrent();
+     * const fileDownloadDir =  await app.getFileDownloadLocation();
+     * ```
      */
     async getFileDownloadLocation() {
         const { payload: { data } } = await this.wire.sendAction('get-file-download-location', this.identity);