@openfin/core 25.68.30 → 25.70.2

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

@@ -1,49 +1,49 @@
-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
-     * @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
-     * @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
-     * @experimental
-     * @static
-     */
-    wrapSync(identity: OpenFin.Identity): OpenFin.View;
-    /**
-     * Asynchronously returns a View object that represents the current view
-     * @return {Promise.<View>}
-     * @tutorial View.getCurrent
-     * @experimental
-     * @static
-     */
-    getCurrent(): Promise<OpenFin.View>;
-    /**
-     * Synchronously returns a View object that represents the current view
-     * @return {View}
-     * @tutorial View.getCurrentSync
-     * @experimental
-     * @static
-     */
-    getCurrentSync(): OpenFin.View;
-}
+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
+     * @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
+     * @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
+     * @experimental
+     * @static
+     */
+    wrapSync(identity: OpenFin.Identity): OpenFin.View;
+    /**
+     * Asynchronously returns a View object that represents the current view
+     * @return {Promise.<View>}
+     * @tutorial View.getCurrent
+     * @experimental
+     * @static
+     */
+    getCurrent(): Promise<OpenFin.View>;
+    /**
+     * Synchronously returns a View object that represents the current view
+     * @return {View}
+     * @tutorial View.getCurrentSync
+     * @experimental
+     * @static
+     */
+    getCurrentSync(): OpenFin.View;
+}

package/src/api/view/Factory.js

@@ -1,103 +1,103 @@
-"use strict";
-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
-     * @experimental
-     * @static
-     */
-    async create(options) {
-        const { uuid } = this.wire.me;
-        if (!options.name || typeof options.name !== 'string') {
-            throw new Error('Please provide a name property as a string in order to create a View.');
-        }
-        if (this.wire.environment.childViews) {
-            await this.wire.environment.createChildContent({
-                entityType: 'view',
-                options: { ...options, uuid }
-            });
-        }
-        else {
-            await this.wire.sendAction('create-view', { ...options, uuid });
-        }
-        return this.wrapSync({ uuid, name: options.name });
-    }
-    /**
-     * Asynchronously returns a View object that represents an existing view.
-     * @param { Identity } identity
-     * @return {Promise.<View>}
-     * @tutorial View.wrap
-     * @experimental
-     * @static
-     */
-    async wrap(identity) {
-        this.wire.sendAction('view-wrap');
-        const errorMsg = validate_1.validateIdentity(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new index_1.View(this.wire, identity);
-    }
-    /**
-     * Synchronously returns a View object that represents an existing view.
-     * @param { Identity } identity
-     * @return {View}
-     * @tutorial View.wrapSync
-     * @experimental
-     * @static
-     */
-    wrapSync(identity) {
-        this.wire.sendAction('view-wrap-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const errorMsg = validate_1.validateIdentity(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new index_1.View(this.wire, identity);
-    }
-    /**
-     * Asynchronously returns a View object that represents the current view
-     * @return {Promise.<View>}
-     * @tutorial View.getCurrent
-     * @experimental
-     * @static
-     */
-    getCurrent() {
-        this.wire.sendAction('view-get-current').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        if (!this.wire.me.isView) {
-            throw new Error('You are not in a View context');
-        }
-        const { uuid, name } = this.wire.me;
-        return this.wrap({ uuid, name });
-    }
-    /**
-     * Synchronously returns a View object that represents the current view
-     * @return {View}
-     * @tutorial View.getCurrentSync
-     * @experimental
-     * @static
-     */
-    getCurrentSync() {
-        this.wire.sendAction('view-get-current-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        if (!this.wire.me.isView) {
-            throw new Error('You are not in a View context');
-        }
-        const { uuid, name } = this.wire.me;
-        return this.wrapSync({ uuid, name });
-    }
-}
-exports.default = ViewModule;
+"use strict";
+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
+     * @experimental
+     * @static
+     */
+    async create(options) {
+        const { uuid } = this.wire.me;
+        if (!options.name || typeof options.name !== 'string') {
+            throw new Error('Please provide a name property as a string in order to create a View.');
+        }
+        if (this.wire.environment.childViews) {
+            await this.wire.environment.createChildContent({
+                entityType: 'view',
+                options: { ...options, uuid }
+            });
+        }
+        else {
+            await this.wire.sendAction('create-view', { ...options, uuid });
+        }
+        return this.wrapSync({ uuid, name: options.name });
+    }
+    /**
+     * Asynchronously returns a View object that represents an existing view.
+     * @param { Identity } identity
+     * @return {Promise.<View>}
+     * @tutorial View.wrap
+     * @experimental
+     * @static
+     */
+    async wrap(identity) {
+        this.wire.sendAction('view-wrap');
+        const errorMsg = validate_1.validateIdentity(identity);
+        if (errorMsg) {
+            throw new Error(errorMsg);
+        }
+        return new index_1.View(this.wire, identity);
+    }
+    /**
+     * Synchronously returns a View object that represents an existing view.
+     * @param { Identity } identity
+     * @return {View}
+     * @tutorial View.wrapSync
+     * @experimental
+     * @static
+     */
+    wrapSync(identity) {
+        this.wire.sendAction('view-wrap-sync').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        const errorMsg = validate_1.validateIdentity(identity);
+        if (errorMsg) {
+            throw new Error(errorMsg);
+        }
+        return new index_1.View(this.wire, identity);
+    }
+    /**
+     * Asynchronously returns a View object that represents the current view
+     * @return {Promise.<View>}
+     * @tutorial View.getCurrent
+     * @experimental
+     * @static
+     */
+    getCurrent() {
+        this.wire.sendAction('view-get-current').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        if (!this.wire.me.isView) {
+            throw new Error('You are not in a View context');
+        }
+        const { uuid, name } = this.wire.me;
+        return this.wrap({ uuid, name });
+    }
+    /**
+     * Synchronously returns a View object that represents the current view
+     * @return {View}
+     * @tutorial View.getCurrentSync
+     * @experimental
+     * @static
+     */
+    getCurrentSync() {
+        this.wire.sendAction('view-get-current-sync').catch((e) => {
+            // we do not want to expose this error, just continue if this analytics-only call fails
+        });
+        if (!this.wire.me.isView) {
+            throw new Error('You are not in a View context');
+        }
+        const { uuid, name } = this.wire.me;
+        return this.wrapSync({ uuid, name });
+    }
+}
+exports.default = ViewModule;