@openfin/core 33.76.31 → 33.76.36

package/src/api/system/index.js

@@ -7,10 +7,13 @@ const events_1 = require("events");
 /**
  * An object representing the core of OpenFin Runtime. Allows the developer
  * to perform system-level actions, such as accessing logs, viewing processes,
- * clearing the cache and exiting the runtime as well as listen to <a href="tutorial-System.EventEmitter.html">system events</a>.
- * @namespace
+ * clearing the cache and exiting the runtime as well as listen to {@link OpenFin.SystemEvents system events}.
+ *
  */
 class System extends base_1.EmitterBase {
+    /**
+     * @internal
+     */
     constructor(wire) {
         super(wire, 'system');
     }
@@ -61,10 +64,10 @@ class System 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 System
      * @instance
@@ -72,10 +75,10 @@ class System 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 System
      * @instance
@@ -83,10 +86,10 @@ class System 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 System
      * @instance
@@ -94,10 +97,10 @@ class System 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 System
      * @instance
@@ -106,10 +109,10 @@ class System 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 System
      * @instance
@@ -118,10 +121,10 @@ class System 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 System
      * @instance
@@ -129,8 +132,8 @@ class System 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 System
      * @instance
@@ -139,8 +142,11 @@ class System extends base_1.EmitterBase {
     /**
      * Returns the version of the runtime. The version contains the major, minor,
      * build and revision numbers.
-     * @return {Promise.<string>}
-     * @tutorial System.getVersion
+     *
+     * @example
+     * ```js
+     * fin.System.getVersion().then(v => console.log(v)).catch(err => console.log(err));
+     * ```
      */
     getVersion() {
         return this.wire.sendAction('get-version').then(({ payload }) => payload.data);
@@ -149,34 +155,59 @@ class System extends base_1.EmitterBase {
      * Clears cached data containing application resource
      * files (images, HTML, JavaScript files), cookies, and items stored in the
      * Local Storage.
-     * @param { ClearCacheOption } options - See tutorial for more details.
-     * @return {Promise.<void>}
-     * @tutorial System.clearCache
+     * @param options - See below for details.
+     *
+     * @remarks For more information on the accepted options, see the following pages:
+     * * cache: browsing data cache for html files and images ([caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching))
+     * * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
+     * * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
+     * * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
+     * @example
+     * ```js
+     * const clearCacheOptions = {
+     *     appcache: true,
+     *     cache: true,
+     *     cookies: true,
+     *     localStorage: true
+     * };
+     * fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
+     * ```
+     *
      */
     clearCache(options) {
         return this.wire.sendAction('clear-cache', options).then(() => undefined);
     }
     /**
      * Clears all cached data when OpenFin Runtime exits.
-     * @return {Promise.<void>}
-     * @tutorial System.deleteCacheOnExit
+     *
+     * @example
+     * ```js
+     * fin.System.deleteCacheOnExit().then(() => console.log('Deleted Cache')).catch(err => console.log(err));
+     * ```
      */
     deleteCacheOnExit() {
         return this.wire.sendAction('delete-cache-request').then(() => undefined);
     }
     /**
      * Exits the Runtime.
-     * @return {Promise.<void>}
-     * @tutorial System.exit
+     *
+     * @example
+     * ```js
+     * fin.System.exit().then(() => console.log('exit')).catch(err => console.log(err));
+     * ```
      */
     exit() {
         return this.wire.sendAction('exit-desktop').then(() => undefined);
     }
     /**
      * Fetches a JSON manifest using the browser process and returns a Javascript object.
-     * @param { string } manifestUrl The URL of the manifest to fetch.
-     * @return {Promise.<any>}
-     * @tutorial System.fetchManifest
+     * @param manifestUrl The URL of the manifest to fetch.
+     *
+     * @example
+     * ```js
+     * const manifest = await fin.System.fetchManifest('https://www.path-to-manifest.com');
+     * console.log(manifest);
+     * ```
      */
     async fetchManifest(manifestUrl) {
         const { payload: { data } } = await this.wire.sendAction('fetch-manifest', { manifestUrl });
@@ -184,40 +215,57 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Writes any unwritten cookies data to disk.
-     * @return {Promise.<void>}
-     * @tutorial System.flushCookieStore
+     *
+     * @example
+     * ```js
+     * fin.System.flushCookieStore()
+     *     .then(() => console.log('success'))
+     *     .catch(err => console.error(err));
+     * ```
      */
     flushCookieStore() {
         return this.wire.sendAction('flush-cookie-store').then(() => undefined);
     }
     /**
      * Retrieves an array of data (name, ids, bounds) for all application windows.
-     * @return {Promise.Array.<ApplicationWindowInfo>}
-     * @tutorial System.getAllWindows
+     *
+     * @example
+     * ```js
+     * fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
+     * ```
      */
     getAllWindows() {
         return this.wire.sendAction('get-all-windows').then(({ payload }) => payload.data);
     }
     /**
      * Retrieves an array of data for all applications.
-     * @return {Promise.Array.<ApplicationState>}
-     * @tutorial System.getAllApplications
+     *
+     * @example
+     * ```js
+     * fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
+     * ```
      */
     getAllApplications() {
         return this.wire.sendAction('get-all-applications').then(({ payload }) => payload.data);
     }
     /**
      * Retrieves the command line argument string that started OpenFin Runtime.
-     * @return {Promise.<string>}
-     * @tutorial System.getCommandLineArguments
+     *
+     * @example
+     * ```js
+     * fin.System.getCommandLineArguments().then(args => console.log(args)).catch(err => console.log(err));
+     * ```
      */
     getCommandLineArguments() {
         return this.wire.sendAction('get-command-line-arguments').then(({ payload }) => payload.data);
     }
     /**
      * Get the current state of the crash reporter.
-     * @return {Promise.<CrashReporterState>}
-     * @tutorial System.getCrashReporterState
+     *
+     * @example
+     * ```js
+     * fin.System.getCrashReporterState().then(state => console.log(state)).catch(err => console.log(err));
+     * ```
      */
     async getCrashReporterState() {
         const { payload: { data: { diagnosticMode, isRunning } } } = await this.wire.sendAction('get-crash-reporter-state');
@@ -231,9 +279,17 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Start the crash reporter if not already running.
-     * @param { CrashReporterOptions } options - configure crash reporter
-     * @return {Promise.<CrashReporterState>}
-     * @tutorial System.startCrashReporter
+     * @param options - configure crash reporter
+     *
+     * @remarks You can optionally specify `diagnosticsMode` to have the logs sent to
+     * OpenFin on runtime close. (NOTE: `diagnosticsMode` will turn on verbose logging and disable the sandbox
+     * for newly launched renderer processes. See https://developers.openfin.co/of-docs/docs/debugging#diagnostics-mode for
+     * more details.)
+     *
+     * @example
+     * ```js
+     * fin.System.startCrashReporter({diagnosticsMode: true}).then(reporter => console.log(reporter)).catch(err => console.log(err));
+     * ```
      */
     async startCrashReporter(options) {
         const opts = options;
@@ -249,8 +305,16 @@ class System extends base_1.EmitterBase {
     /**
      * Returns a hex encoded hash of the machine id and the currently logged in user name.
      * This is the recommended way to uniquely identify a user / machine combination.
-     * @return {Promise.<string>}
-     * @tutorial System.getUniqueUserId
+     *
+     * @remarks For Windows systems this is a sha256 hash of the machine ID set in the registry key:
+     * `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography\MachineGuid` and `USERNAME`.
+     *
+     * For OSX systems, a native-level call is used to get the machine ID.
+     *
+     * @example
+     * ```js
+     * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
+     * ```
      * @static
      */
     getUniqueUserId() {
@@ -258,18 +322,38 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Retrieves a frame info object for the uuid and name passed in
-     * @param { string } uuid - The UUID of the target.
-     * @param { string } name - The name of the target.
-     * @return {Promise.<EntityInfo>}
-     * @tutorial System.getEntityInfo
+     * @param uuid - The UUID of the target.
+     * @param name - The name of the target.
+     *
+     * @remarks The possible types are 'window', 'iframe', 'external connection' or 'unknown'.
+     * @example
+     * ```js
+     * const entityUuid = 'OpenfinPOC';
+     * const entityName = '40c74b5d-ed98-40f7-853f-e3d3c2699175';
+     * fin.System.getEntityInfo(entityUuid, entityName).then(info => console.log(info)).catch(err => console.log(err));
+     *
+     * // example info shape
+     * {
+     *     "uuid": "OpenfinPOC",
+     *     "name": "40c74b5d-ed98-40f7-853f-e3d3c2699175",
+     *     "parent": {
+     *         "uuid": "OpenfinPOC",
+     *         "name": "OpenfinPOC"
+     *     },
+     *     "entityType": "iframe"
+     * }
+     * ```
      */
     getEntityInfo(uuid, name) {
         return this.wire.sendAction('get-entity-info', { uuid, name }).then(({ payload }) => payload.data);
     }
     /**
      * Gets the value of a given environment variable on the computer on which the runtime is installed
-     * @return {Promise.<string>}
-     * @tutorial System.getEnvironmentVariable
+     *
+     * @example
+     * ```js
+     * fin.System.getEnvironmentVariable('HOME').then(env => console.log(env)).catch(err => console.log(err));
+     * ```
      */
     getEnvironmentVariable(envName) {
         return this.wire
@@ -280,16 +364,27 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Get current focused window.
-     * @return {Promise.<Identity | null>}
-     * @tutorial System.getFocusedWindow
+     *
+     * @example
+     * ```js
+     * fin.System.getFocusedWindow().then(winInfo => console.log(winInfo)).catch(err => console.log(err));
+     * ```
      */
     getFocusedWindow() {
         return this.wire.sendAction('get-focused-window').then(({ payload }) => payload.data);
     }
     /**
      * Returns information about the given app's certification status
-     * @return {Promise.<CertifiedAppInfo>}
-     * @tutorial System.isAppCertified
+     *
+     * @example
+     * ```js
+     * const manifestUrl = "http://localhost:1234/app.json"
+     * try {
+     *     const certificationInfo = await fin.System.isAppCertified(manifestUrl);
+     * } catch(err) {
+     *     console.error(err)
+     * }
+     * ```
      */
     async isAppCertified(manifestUrl) {
         const { payload: { data: { certifiedInfo } } } = await this.wire.sendAction('is-app-certified', { manifestUrl });
@@ -297,8 +392,11 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Returns an array of all the installed runtime versions in an object.
-     * @return {Promise.<string[]>}
-     * @tutorial System.getInstalledRuntimes
+     *
+     * @example
+     * ```js
+     * fin.System.getInstalledRuntimes().then(runtimes => console.log(runtimes)).catch(err => console.log(err));
+     * ```
      */
     // incompatible with standalone node process.
     getInstalledRuntimes() {
@@ -311,33 +409,50 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Retrieves the contents of the log with the specified filename.
-     * @param { GetLogRequestType } options A object that id defined by the GetLogRequestType interface
-     * @return {Promise.<string>}
-     * @tutorial System.getLog
+     * @param options A object that id defined by the GetLogRequestType interface
+     *
+     * @example
+     * ```js
+     * async function getLog() {
+     *     const logs = await fin.System.getLogList();
+     *     return await fin.System.getLog(logs[0]);
+     * }
+     *
+     * getLog().then(log => console.log(log)).catch(err => console.log(err));
+     * ```
      */
     getLog(options) {
         return this.wire.sendAction('view-log', options).then(({ payload }) => payload.data);
     }
     /**
      * Returns a unique identifier (UUID) provided by the machine.
-     * @return {Promise.<string>}
-     * @tutorial System.getMachineId
+     *
+     * @example
+     * ```js
+     * fin.System.getMachineId().then(id => console.log(id)).catch(err => console.log(err));
+     * ```
      */
     getMachineId() {
         return this.wire.sendAction('get-machine-id').then(({ payload }) => payload.data);
     }
     /**
      * Returns the minimum (inclusive) logging level that is currently being written to the log.
-     * @return {Promise.<LogLevel>}
-     * @tutorial System.getMinLogLevel
+     *
+     * @example
+     * ```js
+     * fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
+     * ```
      */
     getMinLogLevel() {
         return this.wire.sendAction('get-min-log-level').then(({ payload }) => payload.data);
     }
     /**
      * Retrieves an array containing information for each log file.
-     * @return {Promise.Array<LogInfo>}
-     * @tutorial System.getLogList
+     *
+     * @example
+     * ```js
+     * fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
+     * ```
      */
     getLogList() {
         return this.wire.sendAction('list-logs').then(({ payload }) => payload.data);
@@ -345,16 +460,22 @@ class System extends base_1.EmitterBase {
     /**
      * Retrieves an object that contains data about the monitor setup of the
      * computer that the runtime is running on.
-     * @return {Promise.<MonitorInfo>}
-     * @tutorial System.getMonitorInfo
+     *
+     * @example
+     * ```js
+     * fin.System.getMonitorInfo().then(monitorInfo => console.log(monitorInfo)).catch(err => console.log(err));
+     * ```
      */
     getMonitorInfo() {
         return this.wire.sendAction('get-monitor-info').then(({ payload }) => payload.data);
     }
     /**
      * Returns the mouse in virtual screen coordinates (left, top).
-     * @return {Promise.<PointTopLeft>}
-     * @tutorial System.getMousePosition
+     *
+     * @example
+     * ```js
+     * fin.System.getMousePosition().then(mousePosition => console.log(mousePosition)).catch(err => console.log(err));
+     * ```
      */
     getMousePosition() {
         return this.wire.sendAction('get-mouse-position').then(({ payload }) => payload.data);
@@ -364,12 +485,15 @@ class System extends base_1.EmitterBase {
      * running. Each element in the array is an object containing the uuid
      * and the name of the application to which the process belongs.
      * @deprecated Please use our new set of process APIs:
-     * [Window.getProcessInfo]{@link Window#getProcessInfo}
-     * [View.getProcessInfo]{@link View#getProcessInfo}
-     * [Application.getProcessInfo]{@link Application#getProcessInfo}
-     * [System.getAllProcessInfo]{@link System#getAllProcessInfo}
-     * @return {Promise.Array.<ProcessInfo>}
-     * @tutorial System.getProcessList
+     * {@link Window._Window#getProcessInfo Window.getProcessInfo}
+     * {@link View.View#getProcessInfo View.getProcessInfo}
+     * {@link Application.Application#getProcessInfo Application.getProcessInfo}
+     * {@link System#getAllProcessInfo System.getAllProcessInfo}
+     *
+     * @example
+     * ```js
+     * fin.System.getProcessList().then(ProcessList => console.log(ProcessList)).catch(err => console.log(err));
+     * ```
      */
     getProcessList() {
         // eslint-disable-next-line no-console
@@ -377,9 +501,14 @@ class System extends base_1.EmitterBase {
         return this.wire.sendAction('process-snapshot').then(({ payload }) => payload.data);
     }
     /**
-     * Retrieves all process information. This includes the browser process and every process associated to all entities (windows and views).
-     * @return {Promise.<SystemProcessInfo>}
-     * @tutorial System.getAllProcessInfo
+     * Retrieves all process information.
+     *
+     * @remarks This includes the browser process and every process associated to all entities (windows and views).
+     *
+     * @example
+     * ```js
+     * const allProcessInfo = await fin.System.getAllProcessInfo();
+     * ```
      * @experimental
      */
     async getAllProcessInfo() {
@@ -388,24 +517,48 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Retrieves the Proxy settings.
-     * @return {Promise.<ProxyInfo>}
-     * @tutorial System.getProxySettings
+     *
+     * @example
+     * ```js
+     * fin.System.getProxySettings().then(ProxySetting => console.log(ProxySetting)).catch(err => console.log(err));
+     *
+     * //This response has the following shape:
+     * {
+     *     config: {
+     *         proxyAddress: "proxyAddress", //the configured Proxy Address
+     *         proxyPort: 0, //the configured Proxy port
+     *         type: "system" //Proxy Type
+     *     },
+     *     system: {
+     *         autoConfigUrl: "",
+     *         bypass: "",
+     *         enabled: false,
+     *         proxy: ""
+     *     }
+     * }
+     * ```
      */
     getProxySettings() {
         return this.wire.sendAction('get-proxy-settings').then(({ payload }) => payload.data);
     }
     /**
      * Returns information about the running Runtime in an object.
-     * @return {Promise.<RuntimeInfo>}
-     * @tutorial System.getRuntimeInfo
+     *
+     * @example
+     * ```js
+     * fin.System.getRuntimeInfo().then(RuntimeInfo => console.log(RuntimeInfo)).catch(err => console.log(err));
+     * ```
      */
     getRuntimeInfo() {
         return this.wire.sendAction('get-runtime-info').then(({ payload }) => payload.data);
     }
     /**
      * Returns information about the running RVM in an object.
-     * @return {Promise.<RVMInfo>}
-     * @tutorial System.getRvmInfo
+     *
+     * @example
+     * ```js
+     * fin.System.getRvmInfo().then(RvmInfo => console.log(RvmInfo)).catch(err => console.log(err));
+     * ```
      */
     // incompatible with standalone node process.
     getRvmInfo() {
@@ -413,8 +566,11 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Retrieves system information.
-     * @return {Promise.<HostSpecs>}
-     * @tutorial System.getHostSpecs
+     *
+     * @example
+     * ```js
+     * fin.System.getHostSpecs().then(specs => console.log(specs)).catch(err => console.log(err));
+     * ```
      */
     getHostSpecs() {
         return this.wire.sendAction('get-host-specs').then(({ payload }) => payload.data);
@@ -424,9 +580,329 @@ class System extends base_1.EmitterBase {
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
      * <br> 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>. Also, this api has an enhanced permission set to make it less dangerous. So application owners can only allow to launch the assets owned by the application, the enabled downloaded files or the restricted executables.
-     * @param { ExternalProcessRequestType } options A object that is defined in the ExternalProcessRequestType interface
-     * @return {Promise.<Identity>}
-     * @tutorial System.launchExternalProcess
+     * @param options A object that is defined in the ExternalProcessRequestType interface
+     *
+     * @remarks If an unused UUID is provided in options, it will be used. If no UUID is provided, OpenFin will assign one.
+     * This api has an enhanced permission set to make it less dangerous. So application owners can only allow to launch the
+     * assets owned by the application, the enabled downloaded files or the restricted executables.
+     *
+     * **Note:** Since _appAssets_ relies on the RVM, which is missing on MAC_OS, 'alias' is not available. Instead provide
+     * the full path e.g. _/Applications/Calculator.app/Contents/MacOS/Calculator_.
+     *
+     * @example
+     * Basic Example:
+     * ```js
+     * fin.System.launchExternalProcess({
+     *     path: 'notepad',
+     *     arguments: '',
+     *     listener: function (result) {
+     *         console.log('the exit code', result.exitCode);
+     *     }
+     * }).then(processIdentity => {
+     *     console.log(processIdentity);
+     * }).catch(error => {
+     *     console.log(error);
+     * });
+     * ```
+     *
+     * Promise resolution:
+     *
+     * ```js
+     * //This response has the following shape:
+     * {
+     *     uuid: "FB3E6E36-0976-4C2B-9A09-FB2E54D2F1BB" // The mapped UUID which identifies the launched process
+     * }
+     * ```
+     *
+     * Listener callback:
+     * ```js
+     * //This response has the following shape:
+     * {
+     *     topic: "exited", // Or "released" on a call to releaseExternalProcess
+     *     uuid: "FB3E6E36-0976-4C2B-9A09-FB2E54D2F1BB", // The mapped UUID which identifies the launched process
+     *     exitCode: 0 // Process exit code
+     * }
+     * ```
+     *
+     * By specifying a lifetime, an external process can live as long the window/application that launched it or
+     * persist after the application exits. The default value is null, which is equivalent to 'persist', meaning
+     * the process lives on after the application exits:
+     *
+     * ```js
+     * fin.System.launchExternalProcess({
+     *     path: 'notepad',
+     *     arguments: '',
+     *     listener: (result) => {
+     *         console.log('the exit code', result.exitCode);
+     *     },
+     *     lifetime: 'window'
+     * }).then(processIdentity => {
+     *     console.log(processIdentity);
+     * }).catch(error => {
+     *     console.log(error);
+     * });
+     * ```
+     *
+     * Note: A process that exits when the window/application exits cannot be released via fin.desktop.System.releaseExternalProcess.
+     *
+     * By specifying a cwd, it will set current working directory when launching an external process:
+     *
+     * ```js
+     * fin.System.launchExternalProcess({
+     *     path: 'cmd.exe',
+     *     cwd: 'c:\\temp',
+     *     arguments: '',
+     *     listener: (result) => {
+     *         console.log('the exit code', result.exitCode);
+     *     }
+     * }).then(processIdentity => {
+     *     console.log(processIdentity);
+     * }).catch(error => {
+     *     console.log(error);
+     * });
+     * ```
+     *
+     * Example using an alias from app.json appAssets property:
+     *
+     * ```json
+     * "appAssets": [
+     *     {
+     *         "src": "exe.zip",
+     *         "alias": "myApp",
+     *         "version": "4.12.8",
+     *         "target": "myApp.exe",
+     *         "args": "a b c d"
+     *     },
+     * ]
+     * ```
+     *
+     * ```js
+     * //  When called, if no arguments are passed then the arguments (if any)
+     * //  are taken from the 'app.json' file, from the  'args' parameter
+     * //  of the 'appAssets' Object with the relevant 'alias'.
+     * fin.System.launchExternalProcess({
+     *     //Additionally note that the executable found in the zip file specified in appAssets
+     *     //will default to the one mentioned by appAssets.target
+     *     //If the the path below refers to a specific path it will override this default
+     *     alias: 'myApp',
+     *     listener: (result) => {
+     *         console.log('the exit code', result.exitCode);
+     *     }
+     * }).then(processIdentity => {
+     *     console.log(processIdentity);
+     * }).catch(error => {
+     *     console.log(error);
+     * });
+     * ```
+     *
+     * Example using an alias but overriding the arguments:
+     *
+     * ```json
+     * "appAssets": [
+     *     {
+     *         "src": "exe.zip",
+     *         "alias": "myApp",
+     *         "version": "4.12.8",
+     *         "target": "myApp.exe",
+     *         "args": "a b c d"
+     *     },
+     * ]
+     * ```
+     *
+     * ```js
+     * //  If 'arguments' is passed as a parameter it takes precedence
+     * //  over any 'args' set in the 'app.json'.
+     * fin.System.launchExternalProcess({
+     *     alias: 'myApp',
+     *     arguments: 'e f g',
+     *     listener: (result) => {
+     *         console.log('the exit code', result.exitCode);
+     *     }
+     * }).then(processIdentity => {
+     *     console.log(processIdentity);
+     * }).catch(error => {
+     *     console.log(error);
+     * });
+     * ```
+     *
+     * It is now possible to optionally perform any combination of the following certificate checks
+     * against an absolute target via `fin.desktop.System.launchExternalProcess()`:
+     *
+     * ```js
+     * "certificate": {
+     *     "serial": "3c a5 ...",                        // A hex string with or without spaces
+     *     "subject": "O=OpenFin INC., L=New York, ...", // An internally tokenized and comma delimited string allowing partial or full checks of the subject fields
+     *     "publickey": "3c a5 ...",                     // A hex string with or without spaces
+     *     "thumbprint": "3c a5 ...",                    // A hex string with or without spaces
+     *     "trusted": true                               // A boolean indicating that the certificate is trusted and not revoked
+     * }
+     * ```
+     *
+     * Providing this information as part of the default configurations for assets in an application's manifest
+     * will be added in a future RVM update:
+     *
+     * ```js
+     * fin.System.launchExternalProcess({
+     *     path: 'C:\\Users\\ExampleUser\\AppData\\Local\\OpenFin\\OpenFinRVM.exe',
+     *     arguments: '--version',
+     *     certificate: {
+     *         trusted: true,
+     *         subject: 'O=OpenFin INC., L=New York, S=NY, C=US',
+     *         thumbprint: '‎3c a5 28 19 83 05 fe 69 88 e6 8f 4b 3a af c5 c5 1b 07 80 5b'
+     *     },
+     *     listener: (result) => {
+     *         console.log('the exit code', result.exitCode);
+     *     }
+     * }).then(processIdentity => {
+     *     console.log(processIdentity);
+     * }).catch(error => {
+     *     console.log(error);
+     * });
+     * ```
+     *
+     * It is possible to launch files that have been downloaded by the user by listening to the window
+     * `file-download-completed` event and using the `fileUuid` provided by the event:
+     *
+     * ```js
+     * const win = fin.Window.getCurrentSync();
+     * win.addListener('file-download-completed', (evt) => {
+     *     if (evt.state === 'completed') {
+     *         fin.System.launchExternalProcess({
+     *             fileUuid: evt.fileUuid,
+     *             arguments: '',
+     *             listener: (result) => {
+     *                 console.log('the exit code', result.exitCode);
+     *             }
+     *         }).then(processIdentity => {
+     *             console.log(processIdentity);
+     *         }).catch(error => {
+     *             console.log(error);
+     *         });
+     *     }
+     * });
+     * ```
+     *
+     * Launching assets specified in the app manifest:
+     *
+     * Sample appAssets section in app.json
+     * ```js
+     *     "appAssets": [
+     *         {
+     *             "src": "http://filesamples.com/exe.zip",
+     *             "alias": "myApp",
+     *             "version": "4.12.8",
+     *             "target": "myApp.exe",
+     *             "args": "a b c d"
+     *         },
+     *         {
+     *             "src": "http://examples.com/exe.zip",
+     *             "alias": "myApp2",
+     *             "version": "5.12.8",
+     *             "target": "myApp2.exe",
+     *             "args": "a b c"
+     *         }
+     *     ]
+     * ```
+     *
+     * This permission allows for launching of all assets specified in the above appAssets section. ("myApp" and "myApp2"):
+     *
+     * ```js
+     *     "permissions": {
+     *        "System": {
+     *            "launchExternalProcess": {
+     *                 "enabled": true,
+     *                 "assets": {
+     *                     "enabled": true
+     *                 }
+     *             }
+     *        }
+     *     }
+     * ```
+     *
+     * This permission allows for launching of _only_ the "myApp" asset in the above appAssets section, as defined in `srcRules`:
+     * ```js
+     *     "permissions": {
+     *        "System": {
+     *            "launchExternalProcess": {
+     *                 "enabled": true,
+     *                 "assets": {
+     *                     "enabled": true
+     *                     "srcRules": [
+     *                         {
+     *                             "match": [
+     *                                 "*://filesamples.com/*"
+     *                             ],
+     *                             "behavior": "allow"
+     *                         },
+     *                         {
+     *                             "match": [
+     *                                 "<all_urls>"
+     *                             ],
+     *                             "behavior": "block"
+     *                         }
+     *                     ]
+     *                 }
+     *             }
+     *        }
+     *     }
+     * ```
+     *
+     * Launching downloaded files:
+     * ```js
+     *     "permissions": {
+     *        "System": {
+     *            "launchExternalProcess": {
+     *                 "enabled": true,
+     *                 "downloads": {
+     *                     "enabled": true
+     *                 }
+     *             }
+     *        }
+     *     }
+     * ```
+     *
+     * This permission allows to launch all the executables:
+     * ```js
+     *     "permissions": {
+     *        "System": {
+     *            "launchExternalProcess": {
+     *                 "enabled": true,
+     *                 "executables": {
+     *                     "enabled": true
+     *                 }
+     *             }
+     *        }
+     *     }
+     * ```
+     *
+     *
+     * This permission only allows launching of executables whose file paths match the corresponding `pathRules`:
+     * ```js
+     *     "permissions": {
+     *        "System": {
+     *            "launchExternalProcess": {
+     *                 "enabled": true,
+     *                 "executables": {
+     *                     "enabled": true
+     *                     "pathRules": [
+     *                         {
+     *                             "match": [
+     *                                 "/Windows/System32/*.exe"
+     *                             ],
+     *                             "behavior": "allow"
+     *                         },
+     *                         {
+     *                             "match": [
+     *                                 "*.exe"
+     *                             ],
+     *                             "behavior": "block"
+     *                         }
+     *                     ]
+     *                 }
+     *             }
+     *        }
+     *     }
+     * ```
      */
     launchExternalProcess(options) {
         return this.sendExternalProcessRequest('launch-external-process', options);
@@ -434,31 +910,67 @@ class System extends base_1.EmitterBase {
     /**
      * Monitors a running process. A pid for the process must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
-     * @param { ExternalProcessInfo } options See tutorial for more details
-     * @return {Promise.<Identity>}
-     * @tutorial System.monitorExternalProcess
+     * @param options See tutorial for more details
+     *
+     * @remarks If an unused uuid is provided in options, it will be used. If no uuid is provided, OpefinFin will assign a uuid.
+     * @example
+     * ```js
+     * fin.System.monitorExternalProcess({
+     *     pid: 10208,
+     *     uuid: 'my-external-process', // optional
+     *     listener: function (result) {
+     *         console.log('the exit code', result.exitCode);
+     *     }
+     * }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
+     * ```
      */
     monitorExternalProcess(options) {
         return this.sendExternalProcessRequest('monitor-external-process', options);
     }
     /**
      * Writes the passed message into both the log file and the console.
-     * @param { string } level The log level for the entry. Can be either "info", "warning" or "error"
-     * @param { string } message The log message text
-     * @return {Promise.<void>}
-     * @tutorial System.log
+     * @param level The log level for the entry. Can be either "info", "warning" or "error"
+     * @param message The log message text
+     *
+     * @example
+     * ```js
+     * fin.System.log("info", "An example log message").then(() => console.log('Log info message')).catch(err => console.log(err));
+     * ```
      */
     log(level, message) {
         return this.wire.sendAction('write-to-log', { level, message }).then(() => undefined);
     }
     /**
-     * Opens the passed URL in the default web browser. It only supports http(s) and fin(s) protocols by default.
+     * Opens the passed URL in the default web browser.
+     *
+     * @remarks It only supports http(s) and fin(s) protocols by default.
      * In order to use other custom protocols, they have to be enabled via
-     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * [API security settings](https://developers.openfin.co/docs/api-security).
      * File protocol and file path are not supported.
-     * @param { string } url The URL to open
-     * @return {Promise.<void>}
-     * @tutorial System.openUrlWithBrowser
+     * @param url The URL to open
+     *
+     * @example
+     * ```js
+     * fin.System.openUrlWithBrowser('https://cdn.openfin.co/docs/javascript/stable/tutorial-System.openUrlWithBrowser.html')
+     * .then(() => console.log('Opened URL'))
+     * .catch(err => console.log(err));
+     * ```
+     *
+     * Example of permission definition to enable non-default protocols:
+     *
+     * Note: permission definition should be specified in an app manifest file if there is no DOS settings.
+     * Otherwise it has to be specified in both DOS and app manifest files.
+     *
+     * ```js
+     *     "permissions": {
+     *        "System": {
+     *            "openUrlWithBrowser": {
+     *                 "enabled": true,
+     *                 "protocols": [ "msteams", "slack"]
+     *             }
+     *        }
+     *     }
+     * ```
      */
     openUrlWithBrowser(url) {
         return this.wire.sendAction('open-url-with-browser', { url }).then(() => undefined);
@@ -466,17 +978,28 @@ class System extends base_1.EmitterBase {
     /**
      * Removes the process entry for the passed UUID obtained from a prior call
      * of fin.System.launchExternalProcess().
-     * @param { string } uuid The UUID for a process obtained from a prior call to fin.desktop.System.launchExternalProcess()
-     * @return {Promise.<void>}
-     * @tutorial System.releaseExternalProcess
+     * @param uuid The UUID for a process obtained from a prior call to fin.desktop.System.launchExternalProcess()
+     *
+     * @example
+     * ```js
+     * fin.System.launchExternalProcess({
+     *     path: "notepad",
+     *     listener: function (result) {
+     *         console.log("The exit code", result.exitCode);
+     *     }
+     * })
+     * .then(identity => fin.System.releaseExternalProcess(identity.uuid))
+     * .then(() => console.log('Process has been unmapped!'))
+     * .catch(err => console.log(err));
+     * ```
      */
     releaseExternalProcess(uuid) {
         return this.wire.sendAction('release-external-process', { uuid }).then(() => undefined);
     }
     /**
      * Shows the Chromium Developer Tools for the specified window
-     * @param { Identity } identity This is a object that is defined by the Identity interface
-     * @return {Promise.<void>}
+     * @param identity This is a object that is defined by the Identity interface
+     *
      * @tutorial System.showDeveloperTools
      */
     showDeveloperTools(identity) {
@@ -487,18 +1010,34 @@ class System extends base_1.EmitterBase {
      * has not closed after the elapsed timeout in milliseconds.<br>
      * 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 { TerminateExternalRequestType } options A object defined in the TerminateExternalRequestType interface
-     * @return {Promise.<void>}
-     * @tutorial System.terminateExternalProcess
+     * @param options A object defined in the TerminateExternalRequestType interface
+     *
+     * @example
+     * ```js
+     * fin.System.launchExternalProcess({
+     *     path: "notepad",
+     *     listener: function (result) {
+     *         console.log("The exit code", result.exitCode);
+     *     }
+     * })
+     * .then(identity => fin.System.terminateExternalProcess({uuid: identity.uuid, timeout:2000, killTree: false}))
+     * .then(() => console.log('Terminate the process'))
+     * .catch(err => console.log(err));
+     * ```
      */
     terminateExternalProcess(options) {
         return this.wire.sendAction('terminate-external-process', options).then(() => undefined);
     }
     /**
      * Update the OpenFin Runtime Proxy settings.
-     * @param { ProxyConfig } options A config object defined in the ProxyConfig interface
-     * @return {Promise.<void>}
-     * @tutorial System.updateProxySettings
+     * @param options A config object defined in the ProxyConfig interface
+     *
+     * @example
+     * ```js
+     * fin.System.updateProxySettings({proxyAddress:'127.0.0.1', proxyPort:8080, type:'http'})
+     * .then(() => console.log('Update proxy successfully'))
+     * .catch(err => console.error(err));
+     * ```
      */
     updateProxySettings(options) {
         return this.wire.sendAction('update-proxy', options).then(() => undefined);
@@ -507,9 +1046,30 @@ class System extends base_1.EmitterBase {
      * Downloads the given application asset<br>
      * 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 { AppAssetInfo } appAsset App asset object
-     * @return {Promise.<void>}
-     * @tutorial System.downloadAsset
+     * @param appAsset App asset object
+     *
+     * @example
+     * ```js
+     * async function downloadAsset() {
+     *     const appAsset = {
+     *         src: `${ location.origin }/assets.zip`,
+     *         alias: 'dirApp',
+     *         version: '1.23.24',
+     *         target: 'assets/run.bat'
+     *     };
+     *
+     *     return fin.System.downloadAsset(appAsset, (progress => {
+     *     //Print progress as we download the asset.
+     *         const downloadedPercent = Math.floor((progress.downloadedBytes / progress.totalBytes) * 100);
+     *         console.log(`Downloaded ${downloadedPercent}%`);
+     *     }));
+     * }
+     *
+     * downloadAsset()
+     * .then(() => console.log('Success'))
+     * .catch(err => console.error(err));
+     *
+     * ```
      */
     // incompatible with standalone node process.
     async downloadAsset(appAsset, progressListener) {
@@ -571,10 +1131,29 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Downloads a version of the runtime.
-     * @param { RuntimeDownloadOptions } options - Download options.
-     * @param {Function} [progressListener] - called as the runtime is downloaded with progress information.
-     * @return {Promise.<void>}
-     * @tutorial System.downloadRuntime
+     * @param options - Download options.
+     * @param progressListener - called as the runtime is downloaded with progress information.
+     *
+     * @remarks Only supported in an OpenFin Render process.
+     *
+     * @example
+     * ```js
+     * var downloadOptions = {
+     *     //Specific version number required, if given a release channel the call will produce an error.
+     *     version: '9.61.30.1'
+     * };
+     *
+     * function onProgress(progress) {
+     *     console.log(`${Math.floor((progress.downloadedBytes / progress.totalBytes) * 100)}%`);
+     * }
+     *
+     * fin.System.downloadRuntime(downloadOptions, onProgress).then(() => {
+     *     console.log('Download complete');
+     * }).catch(err =>    {
+     *     console.log(`Download Failed, we could retry: ${err.message}`);
+     *     console.log(err);
+     * });
+     * ```
      */
     downloadRuntime(options, progressListener) {
         const callsites = transport_errors_1.RuntimeError.getCallSite();
@@ -627,35 +1206,62 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Download preload scripts from given URLs
-     * @param {DownloadPreloadOption[]} scripts - URLs of preload scripts. See tutorial for more details.
-     * @return {Promise.Array<DownloadPreloadInfo>}
-     * @tutorial System.downloadPreloadScripts
+     * @param scripts - URLs of preload scripts. See tutorial for more details.
+     *
+     * @example
+     * ```js
+     * const scripts = [
+     *     { url: 'http://.../preload.js' },
+     *     { url: 'http://.../preload2.js' }
+     * ];
+     *
+     * fin.System.downloadPreloadScripts(scripts).then(results => {
+     *     results.forEach(({url, success, error}) => {
+     *         console.log(`URL: ${url}`);
+     *         console.log(`Success: ${success}`);
+     *         if (error) {
+     *             console.log(`Error: ${error}`);
+     *         }
+     *     });
+     * });
+     * ```
      */
     downloadPreloadScripts(scripts) {
         return this.wire.sendAction('download-preload-scripts', { scripts }).then(({ payload }) => payload.data);
     }
     /**
      * Retrieves an array of data (name, ids, bounds) for all application windows.
-     * @return {Promise.Array.<Identity>}
-     * @tutorial System.getAllExternalApplications
+     *
+     * @example
+     * ```js
+     * fin.System.getAllExternalApplications()
+     * .then(externalApps => console.log('Total external apps: ' + externalApps.length))
+     * .catch(err => console.log(err));
+     * ```
      */
     getAllExternalApplications() {
         return this.wire.sendAction('get-all-external-applications').then(({ payload }) => payload.data);
     }
     /**
      * Retrieves app asset information.
-     * @param { AppAssetRequest } options
-     * @return {Promise.<AppAssetInfo>}
-     * @tutorial System.getAppAssetInfo
+     * @param options
+     *
+     * @example
+     * ```js
+     * fin.System.getAppAssetInfo({alias:'procexp'}).then(assetInfo => console.log(assetInfo)).catch(err => console.log(err));
+     * ```
      */
     getAppAssetInfo(options) {
         return this.wire.sendAction('get-app-asset-info', options).then(({ payload }) => payload.data);
     }
     /**
      * Get additional info of cookies.
-     * @param { CookieOption } options - See tutorial for more details.
-     * @return {Promise.Array.<CookieInfo>}
-     * @tutorial System.getCookies
+     * @param options - See tutorial for more details.
+     *
+     * @example
+     * ```js
+     * fin.System.getCookies({name: 'myCookie'}).then(cookies => console.log(cookies)).catch(err => console.log(err));
+     * ```
      */
     getCookies(options) {
         const url = this.wire.environment.getUrl();
@@ -664,18 +1270,24 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Set the minimum log level above which logs will be written to the OpenFin log
-     * @param { LogLevel } The minimum level (inclusive) above which all calls to log will be written
-     * @return {Promise.<void>}
-     * @tutorial System.setMinLogLevel
+     * @param The minimum level (inclusive) above which all calls to log will be written
+     *
+     * @example
+     * ```js
+     * fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
+     * ```
      */
     setMinLogLevel(level) {
         return this.wire.sendAction('set-min-log-level', { level }).then(() => undefined);
     }
     /**
      * Retrieves the UUID of the computer on which the runtime is installed
-     * @param { string } uuid The uuid of the running application
-     * @return {Promise.<ApplicationType>}
-     * @tutorial System.resolveUuid
+     * @param uuid The uuid of the running application
+     *
+     * @example
+     * ```js
+     * fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
+     * ```
      */
     resolveUuid(uuid) {
         return this.wire
@@ -686,9 +1298,9 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Retrieves an array of data for all external applications
-     * @param { Identity } requestingIdentity This object is described in the Identity typedef
-     * @param { any } data Any data type to pass to the method
-     * @return {Promise.<any>}
+     * @param requestingIdentity This object is described in the Identity typedef
+     * @param data Any data type to pass to the method
+     *
      * @ignore
      */
     executeOnRemote(requestingIdentity, data) {
@@ -696,14 +1308,96 @@ class System extends base_1.EmitterBase {
         return this.wire.ferryAction(data);
     }
     /**
-     * Reads the specifed value from the registry.<br>
-     * 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 } rootKey - The registry root key.
-     * @param { string } subkey - The registry key.
-     * @param { string } value - The registry value name.
-     * @return {Promise.<RegistryInfo>}
-     * @tutorial System.readRegistryValue
+     * Reads the specifed value from the registry.
+     * @remarks This method is restricted by default and must be enabled via
+     * [API security settings](https://developers.openfin.co/docs/api-security).
+     * @param rootKey - The registry root key.
+     * @param subkey - The registry key.
+     * @param value - The registry value name.
+     *
+     * @example
+     * ```js
+     * fin.System.readRegistryValue("HKEY_LOCAL_MACHINE", "HARDWARE\\DESCRIPTION\\System", "BootArchitecture").then(val => console.log(val)).catch(err => console.log(err));
+     * ```
+     *
+     * See {@link https://msdn.microsoft.com/en-us/library/windows/desktop/ms681382(v=vs.85).aspx here} for Window's error code definitions.
+     *
+     * Example payloads of different registry types:
+     *
+     * See list of types {@link https://msdn.microsoft.com/en-us/library/windows/desktop/ms724884(v=vs.85).aspx here}.
+     *
+     * ```js
+     * // REG_DWORD
+     * {
+     *     data: 1,
+     *     rootKey: "HKEY_LOCAL_MACHINE",
+     *     subkey: "Foo\Bar",
+     *     type: "REG_DWORD",
+     *     value: "Baz"
+     * }
+     *
+     * // REG_QWORD
+     * {
+     *     data: 13108146671334112,
+     *     rootKey: "HKEY_LOCAL_MACHINE",
+     *     subkey: "Foo\Bar",
+     *     type: "REG_QWORD",
+     *     value: "Baz"
+     * }
+     *
+     * // REG_SZ
+     * {
+     *     data: "FooBarBaz",
+     *     rootKey: "HKEY_LOCAL_MACHINE",
+     *     subkey: "Foo\Bar",
+     *     type: "REG_SZ",
+     *     value: "Baz"
+     * }
+     *
+     * // REG_EXPAND_SZ
+     * {
+     *     data: "C:\User\JohnDoe\AppData\Local",
+     *     rootKey: "HKEY_CURRENT_USER",
+     *     subkey: "Foo\Bar",
+     *     type: "REG_EXPAND_SZ",
+     *     value: "Baz"
+     * }
+     *
+     * // REG_MULTI_SZ
+     * {
+     *     data: [
+     *         "Foo",
+     *         "Bar",
+     *         "Baz"
+     *     ],
+     *     rootKey: "HKEY_CURRENT_USER",
+     *     subkey: "Foo\Bar",
+     *     type: "REG_MULTI_SZ",
+     *     value: "Baz"
+     * }
+     *
+     * // REG_BINARY
+     * {
+     *     data: {
+     *         data: [
+     *             255,
+     *             255,
+     *             0,
+     *             43,
+     *             55,
+     *             0,
+     *             0,
+     *             255,
+     *             255
+     *         ],
+     *         type: "Buffer"
+     *     },
+     *     rootKey: "HKEY_CURRENT_USER",
+     *     subkey: "Foo\Bar",
+     *     type: "REG_BINARY",
+     *     value: "Baz"
+     * }
+     * ```
      */
     readRegistryValue(rootKey, subkey, value) {
         return this.wire
@@ -717,9 +1411,18 @@ class System extends base_1.EmitterBase {
     /**
      * This function call will register a unique id and produce a token.
      * The token can be used to broker an external connection.
-     * @param { string } uuid - A UUID for the remote connection.
-     * @return {Promise.<ExternalConnection>}
-     * @tutorial System.registerExternalConnection
+     * @param uuid - A UUID for the remote connection.
+     *
+     * @example
+     * ```js
+     * fin.System.registerExternalConnection("remote-connection-uuid").then(conn => console.log(conn)).catch(err => console.log(err));
+     *
+     *
+     * // object comes back with
+     * //     token: "0489EAC5-6404-4F0D-993B-92BB8EAB445D", // this will be unique each time
+     * //     uuid: "remote-connection-uuid"
+     *
+     * ```
      */
     registerExternalConnection(uuid) {
         return this.wire.sendAction('register-external-connection', { uuid }).then(({ payload }) => payload.data);
@@ -727,10 +1430,16 @@ class System extends base_1.EmitterBase {
     /**
      * Returns the json blob found in the [desktop owner settings](https://openfin.co/documentation/desktop-owner-settings/)
      * for the specified service.
-     * More information about desktop services can be found [here](https://developers.openfin.co/docs/desktop-services).
-     * @param { ServiceIdentifier } serviceIdentifier An object containing a name key that identifies the service.
-     * @return {Promise.<ServiceConfiguration>}
-     * @tutorial System.getServiceConfiguration
+     * @param serviceIdentifier An object containing a name key that identifies the service.
+     *
+     * @remarks More information about desktop services can be found [here](https://developers.openfin.co/docs/desktop-services).
+     * This call will reject if the desktop owner settings file is not present, not correctly formatted, or if the service requested is not configured or configured incorrectly.
+     *
+     * @example
+     * ```js
+     * // Here we are using the [layouts](https://github.com/HadoukenIO/layouts-service) service.
+     * fin.System.getServiceConfiguration({name:'layouts'}).then(console.log).catch(console.error);
+     * ```
      */
     async getServiceConfiguration(serviceIdentifier) {
         if (typeof serviceIdentifier.name !== 'string') {
@@ -747,10 +1456,20 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Registers a system shutdown handler so user can do some cleanup before system is shutting down.
-     * Note: Once system shutdown starts, you are unable to cancel it.
-     * @param { SystemShutdownHandler } handler system shutdown handler
-     * @return {Promise.<void>}
-     * @tutorial System.registerShutdownHandler
+     * @remarks Once system shutdown starts, you are unable to cancel it.
+     * @param handler system shutdown handler
+     *
+     * @example
+     * ```js
+     * fin.System.registerShutdownHandler((shutdownEvent) => {
+     *         // save state or cleanup
+     *         console.log('do some cleanup before shutdown');
+     *         // Notify app is ready for termination.
+     *         shutdownEvent.proceed();
+     * })
+     * .then(() => console.log('Shutdown handler registered!'))
+     * .catch(err => console.log(err));
+     * ```
      * @experimental
      */
     async registerShutdownHandler(handler) {
@@ -775,19 +1494,100 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Signals the RVM to perform a health check and returns the results as json.
-     * @return {Promise.<string[]>}
-     * @tutorial System.runRvmHealthCheck
+     *
+     * @remarks Requires RVM 5.5+
+     *
+     * @example
+     * ```js
+     * try {
+     *     const results = await fin.System.runRvmHealthCheck();
+     *     console.log(results);
+     * } catch(e) {
+     *      console.error(e);
+     * }
+     * ```
      */
     runRvmHealthCheck() {
         return this.wire.sendAction('run-rvm-health-check').then(({ payload }) => payload.data);
     }
     /**
      * Launch application using a manifest URL/path. It differs from Application.startFromManifest in that this API can accept a manifest using the fin protocol.
-     * @param {string} manifestUrl - The manifest's URL or path.
-     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
-     * @return {Promise.<Manifest>}
+     * @param manifestUrl - The manifest's URL or path.
+     * @param opts - Parameters that the RVM will use.
+     *
      * @experimental
-     * @tutorial System.launchManifest
+     * @remarks Supports protocols http/s and fin/s, and also a local path.
+     *
+     * Note: This API is Windows only.
+     *
+     * @example
+     *
+     * This API can handle most manifest types. Some examples below.
+     *
+     * Traditional:
+     * ```js
+     * const manifest = await fin.System.launchManifest(
+     *   'https://demoappdirectory.openf.in/desktop/config/apps/OpenFin/HelloOpenFin/app.json');
+     * console.log(manifest);
+     * ```
+     *
+     * Platform:
+     * ```js
+     * const manifest = await fin.System.launchManifest('https://openfin.github.io/platform-api-project-seed/public.json');
+     * console.log(manifest);
+     * ```
+     *
+     * Launching traditional manifest into a platform:
+     * ```js
+     * const manifest = await fin.System.launchManifest(
+     *   'https://openfin.github.io/platform-api-project-seed/public.json?\
+     *   $$appManifestUrl=https://demoappdirectory.openf.in/desktop/config/\
+     *   apps/OpenFin/HelloOpenFin/app.json');
+     * console.log(manifest);
+     * ```
+     *
+     * Launching with RVM options:
+     * ```js
+     * const manifest = await fin.System.launchManifest('https://openfin.github.io/platform-api-project-seed/public.json',
+     *     { noUi: true, userAppConfigArgs: { abc: '123', xyz: '789' } });
+     * console.log(manifest);
+     * ```
+     *
+     * Local Path:
+     * ```js
+     * const manifest =  await fin.System.launchManifest('file://c:\\path\\to\\manifest\\file.json');
+     * console.log(manifest);
+     * ```
+     *
+     * Launching with RVM 'subscribe' option:
+     *
+     * This option allows users to subscribe to app version resolver events when
+     * calling launchManifest with fallbackManifests specified.
+     *
+     * ```js
+     * fin.System.launchManifest('fins://system-apps/notifications/app.json', { subscribe: (launch) => {
+     * 		launch.on('app-version-progress', (progress) => {
+     * 			console.log("Trying manifest " + progress.manifest)
+     * 		});
+     *
+     * 		launch.on('runtime-status', (status) => {
+     * 			console.log("Runtime status: " + JSON.stringify(status));
+     * 		});
+     *
+     * 		// RVM has successfully found the target runtime version
+     * 		launch.on('app-version-complete', (complete) => {
+     * 			console.log("Parent app " + complete.srcManifest + " resolved to " + complete.manifest);
+     * 			launch.removeAllListeners();
+     * 		});
+     *
+     * 		// RVM failed to find an available runtime version
+     * 		launch.on('app-version-error', (error) => {
+     * 			console.log("Failed to resolve " + error.srcManifest + " from the fallbackManifests");
+     * 			launch.removeAllListeners();
+     * 		});
+     * 	}
+     * });
+     * ```
      * @static
      */
     async launchManifest(manifestUrl, opts = {}) {
@@ -847,9 +1647,19 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Query permission of a secured api in current context.
-     * @param {string} apiName - The full name of a secured API.
-     * @return {Promise.<QueryPermissionResult>}
-     * @tutorial System.queryPermissionForCurrentContext
+     * @param apiName - The full name of a secured API.
+     *
+     * @example
+     * ```js
+     * fin.System.queryPermissionForCurrentContext('System.launchExternalProcess').then(result => console.log(result)).catch(err => console.log(err));
+     *
+     * //This response has the following shape:
+     * {
+     *    permission: 'System.launchExternalProcess', // api full name
+     *    state: 'granted', // state of permission
+     *    granted: true
+     * }
+     * ```
      */
     async queryPermissionForCurrentContext(apiName) {
         const identity = { uuid: this.wire.me.uuid, name: this.wire.me.name };
@@ -866,17 +1676,48 @@ class System extends base_1.EmitterBase {
     }
     /**
      * (Internal) Register the usage of a component with a platform
-     * @param {OpenFin.RegisterUsageData} options - Object with data and type
-     * @return {Promise.<void>}
-     * @tutorial System.registerUsage
+     * @param options - Object with data and type
+     *
+     * @example
+     * ```js
+     * async function registerUsage() {
+     *     const app = await fin.System.getCurrent();
+     *     return await fin.System.registerUsage({
+     *         type: 'workspace-licensing',
+     *         // example values for the following data object
+     *         data: {
+     *             apiVersion: '1.0',
+     *             componentName: 'home',
+     *             componentVersion: '1.0',
+     *             allowed: true,
+     *             rejectionCode: ''
+     *         }
+     *     });
+     * }
+     *
+     * registerUsage().then(() => console.log('Successfully registered component application')).catch(err => console.log(err));
+     * ```
      */
     async registerUsage({ data, type }) {
         await this.wire.sendAction('register-usage', { data, type });
     }
     /**
      * Returns an array with all printers of the caller and not all the printers on the desktop.
-     * @return { Promise.Array.<PrinterInfo> }
-     * @tutorial System.getPrinters
+     *
+     * @example
+     * ```js
+     * fin.System.getPrinters()
+     *     .then((printers) => {
+     *         printers.forEach((printer) => {
+     *             if (printer.isDefault) {
+     *                 console.log(printer);
+     *             }
+     *         });
+     *     })
+     *     .catch((err) => {
+     *         console.log(err);
+     *     });
+     * ```
      */
     async getPrinters() {
         const { payload } = await this.wire.sendAction('system-get-printers');
@@ -884,12 +1725,127 @@ class System extends base_1.EmitterBase {
     }
     /**
      * Updates Process Logging values: periodic interval and outlier detection entries and interval.
-     * @param {ProcessLoggingOptions} options Process Logging updatable options.
-     * @return { Promise<void> }
-     * @tutorial System.updateProcessLoggingOptions
+     * @param options Process Logging updatable options.
+     *
+     * @remarks When enabling verbose mode, additional process information is logged to the debug.log:
+     *
+     * 1. Periodically process usage (memory, cpu, etc) will be logged for each PID along with the windows, views and
+     * iframes that belong to them. The default is every 30 seconds. Updatable by passing the interval option.
+     * 2. When Windows and Views are created or navigated the PID they belong to and their options will be logged.
+     * 3. When Windows and Views are destroyed their last known process usage will be logged.
+     * 4. Whenever an outlier memory usage is detected it will be logged. By default, on an interval of 5 seconds we will
+     * collect process usage for all PIDs and when 144 such entries are collected, we will start analyzing the data for any
+     * possible outliers in the following entries. The interval and maximum number of entries stored in the running buffer
+     * can be updatable by passing the outlierDetection.interval and outlierDetection.entries options.
+     *
+     * @example
+     *
+     * ```js
+     * await fin.System.updateProcessLoggingOptions({
+     *     interval: 10,
+     *     outlierDetection: {
+     *         interval: 15,
+     *         entries: 200
+     *     }
+     * });
+     * ```
      */
     async updateProcessLoggingOptions(options) {
         await this.wire.sendAction('system-update-process-logging-options', { options });
     }
+    /**
+     * Returns domain settings for the current application.
+     * Initial settings are configured with the defaultDomainSettings application option via manifest.
+     * Domain settings can be overwritten during runtime with System.setDomainSettings.
+     * @example
+     * ```js
+     * const domainSettings = await fin.System.getDomainSettings();
+     * // {
+     * //     "rules": [
+     * //         {
+     * //             "match": [
+     * //                 "https://openfin.co"
+     * //             ],
+     * //             "options": {
+     * //                 "downloadSettings": {
+     * //                     "rules": [
+     * //                         {
+     * //                             "match": [
+     * //                                 "<all_urls>"
+     * //                             ],
+     * //                             "behavior": "prompt"
+     * //                         }
+     * //                     ]
+     * //                 }
+     * //             }
+     * //         }
+     * //     ]
+     * // }
+     * ```
+     */
+    async getDomainSettings() {
+        const { payload: { data } } = await this.wire.sendAction('get-domain-settings', this.identity);
+        return data;
+    }
+    /**
+     * Sets the domain settings for the current application.
+     * @param domainSettings - domain settings object
+     * @example
+     * ```js
+     * const domainSettings = await fin.System.getDomainSettings();
+     * // {
+     * //     "rules": [
+     * //         {
+     * //             "match": [
+     * //                 "https://openfin.co"
+     * //             ],
+     * //             "options": {
+     * //                 "downloadSettings": {
+     * //                     "rules": [
+     * //                         {
+     * //                             "match": [
+     * //                                 "<all_urls>"
+     * //                             ],
+     * //                             "behavior": "prompt"
+     * //                         }
+     * //                     ]
+     * //                 }
+     * //             }
+     * //         }
+     * //     ]
+     * // }
+     *
+     * // Valid rule behaviors are 'prompt' and 'no-prompt'
+     * domainSettings.rules[0].options.downloadSettings.rules[0].behavior = 'no-prompt';
+     *
+     * await fin.System.setDomainSettings(domainSettings);
+     *
+     * const newDomainSettings = await fin.System.getDomainSettings();
+     * // {
+     * //     "rules": [
+     * //         {
+     * //             "match": [
+     * //                 "https://openfin.co"
+     * //             ],
+     * //             "options": {
+     * //                 "downloadSettings": {
+     * //                     "rules": [
+     * //                         {
+     * //                             "match": [
+     * //                                 "<all_urls>"
+     * //                             ],
+     * //                             "behavior": "no-prompt"
+     * //                         }
+     * //                     ]
+     * //                 }
+     * //             }
+     * //         }
+     * //     ]
+     * // }
+     * ```
+     */
+    async setDomainSettings(domainSettings) {
+        await this.wire.sendAction('set-domain-settings', { domainSettings, ...this.identity });
+    }
 }
 exports.default = System;