@openfin/core 33.76.27 → 33.76.36

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

@@ -1,48 +1,86 @@
 import type * as OpenFin from '../../OpenFin';
 import { Base } from '../base';
-/**
- * @lends View
- */
 export default class ViewModule extends Base {
     /**
      * Creates a new View.
-     * @param { View~options } options - View creation options
-     * @return {Promise.<View>}
-     * @tutorial View.create
+     * @param options - View creation options
+     *
+     * @example
+     * ```js
+     * let view;
+     * async function createView() {
+     *     const me = await fin.Window.getCurrent();
+     *     return fin.View.create({
+     *         name: 'viewNameCreate',
+     *         target: me.identity,
+     *         bounds: {top: 10, left: 10, width: 200, height: 200}
+     *     });
+     * }
+     *
+     * createView()
+     *     .then((createdView) => {
+     *         view = createdView;
+     *         console.log('View created.', view);
+     *         view.navigate('https://google.com');
+     *         console.log('View navigated to given url.');
+     *     })
+     *     .catch(err => console.log(err));
+     * ```
+     * Note that created views needs to navigate somewhere for them to actually render a website.
      * @experimental
      * @static
      */
     create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
     /**
      * Asynchronously returns a View object that represents an existing view.
-     * @param { Identity } identity
-     * @return {Promise.<View>}
-     * @tutorial View.wrap
+     * @param identity
+     *
+     * @example
+     * ```js
+     * fin.View.wrap({ uuid: 'testViewUuid', name: 'testViewName' }))
+     *     .then(view => console.log('wrapped view', view))
+     *     .catch(err => console.log(err));
+     * ```
      * @experimental
      * @static
      */
     wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
     /**
      * Synchronously returns a View object that represents an existing view.
-     * @param { Identity } identity
-     * @return {View}
-     * @tutorial View.wrapSync
+     * @param identity
+     *
+     * @example
+     * ```js
+     * const view = fin.View.wrapSync({ uuid: 'testView', name: 'testViewName' });
+     * await view.hide();
+     * ```
      * @experimental
      * @static
      */
     wrapSync(identity: OpenFin.Identity): OpenFin.View;
     /**
      * Asynchronously returns a View object that represents the current view
-     * @return {Promise.<View>}
-     * @tutorial View.getCurrent
+     *
+     * @example
+     * ```js
+     * fin.View.getCurrent()
+     *     .then(view => console.log('current view', view))
+     *     .catch(err => console.log(err));
+     *
+     * ```
      * @experimental
      * @static
      */
     getCurrent(): Promise<OpenFin.View>;
     /**
      * Synchronously returns a View object that represents the current view
-     * @return {View}
-     * @tutorial View.getCurrentSync
+     *
+     * @example
+     * ```js
+     * const view = fin.View.getCurrentSync();
+     * console.log(view);
+     *
+     * ```
      * @experimental
      * @static
      */

package/src/api/view/Factory.js

@@ -3,15 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const base_1 = require("../base");
 const validate_1 = require("../../util/validate");
 const index_1 = require("./index");
-/**
- * @lends View
- */
 class ViewModule extends base_1.Base {
     /**
      * Creates a new View.
-     * @param { View~options } options - View creation options
-     * @return {Promise.<View>}
-     * @tutorial View.create
+     * @param options - View creation options
+     *
+     * @example
+     * ```js
+     * let view;
+     * async function createView() {
+     *     const me = await fin.Window.getCurrent();
+     *     return fin.View.create({
+     *         name: 'viewNameCreate',
+     *         target: me.identity,
+     *         bounds: {top: 10, left: 10, width: 200, height: 200}
+     *     });
+     * }
+     *
+     * createView()
+     *     .then((createdView) => {
+     *         view = createdView;
+     *         console.log('View created.', view);
+     *         view.navigate('https://google.com');
+     *         console.log('View navigated to given url.');
+     *     })
+     *     .catch(err => console.log(err));
+     * ```
+     * Note that created views needs to navigate somewhere for them to actually render a website.
      * @experimental
      * @static
      */
@@ -33,9 +51,14 @@ class ViewModule extends base_1.Base {
     }
     /**
      * Asynchronously returns a View object that represents an existing view.
-     * @param { Identity } identity
-     * @return {Promise.<View>}
-     * @tutorial View.wrap
+     * @param identity
+     *
+     * @example
+     * ```js
+     * fin.View.wrap({ uuid: 'testViewUuid', name: 'testViewName' }))
+     *     .then(view => console.log('wrapped view', view))
+     *     .catch(err => console.log(err));
+     * ```
      * @experimental
      * @static
      */
@@ -49,9 +72,13 @@ class ViewModule extends base_1.Base {
     }
     /**
      * Synchronously returns a View object that represents an existing view.
-     * @param { Identity } identity
-     * @return {View}
-     * @tutorial View.wrapSync
+     * @param identity
+     *
+     * @example
+     * ```js
+     * const view = fin.View.wrapSync({ uuid: 'testView', name: 'testViewName' });
+     * await view.hide();
+     * ```
      * @experimental
      * @static
      */
@@ -67,8 +94,14 @@ class ViewModule extends base_1.Base {
     }
     /**
      * Asynchronously returns a View object that represents the current view
-     * @return {Promise.<View>}
-     * @tutorial View.getCurrent
+     *
+     * @example
+     * ```js
+     * fin.View.getCurrent()
+     *     .then(view => console.log('current view', view))
+     *     .catch(err => console.log(err));
+     *
+     * ```
      * @experimental
      * @static
      */
@@ -84,8 +117,13 @@ class ViewModule extends base_1.Base {
     }
     /**
      * Synchronously returns a View object that represents the current view
-     * @return {View}
-     * @tutorial View.getCurrentSync
+     *
+     * @example
+     * ```js
+     * const view = fin.View.getCurrentSync();
+     * console.log(view);
+     *
+     * ```
      * @experimental
      * @static
      */