@webex/internal-plugin-device 2.59.2 → 2.59.3-next.1

package/dist/device.js

@@ -26,10 +26,10 @@ var _featuresModel = _interopRequireDefault(require("./features/features-model")
 var _dec, _dec2, _dec3, _dec4, _dec5, _obj;
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return _Object$getOwnPropertyDescriptor2(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor2(source, key)); }); } return target; }
-/**
- * Determine if the plugin should be initialized based on cached storage.
- *
- * @returns {boolean} - If the device is ephemeral.
+/**
+ * Determine if the plugin should be initialized based on cached storage.
+ *
+ * @returns {boolean} - If the device is ephemeral.
  */
 function decider() {
   return !this.config.ephemeral;
@@ -43,276 +43,276 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
   extraProperties: 'allow',
   idAttribute: 'url',
   children: {
-    /**
-     * The class object that contains all of the feature collections.
-     *
-     * @type {FeaturesModel}
+    /**
+     * The class object that contains all of the feature collections.
+     *
+     * @type {FeaturesModel}
      */
     features: _featuresModel.default
   },
-  /**
-   * A collection of device properties mostly assigned by the retrieved DTO from
-   * the **WDM** service that are mapped against the ampersand properties.
-   *
-   * @type {Object}
+  /**
+   * A collection of device properties mostly assigned by the retrieved DTO from
+   * the **WDM** service that are mapped against the ampersand properties.
+   *
+   * @type {Object}
    */
   props: {
-    /**
-     * This property determines whether or not giphy support is enabled.
-     *
-     * @type {'ALLOW' | 'BLOCK'}
+    /**
+     * This property determines whether or not giphy support is enabled.
+     *
+     * @type {'ALLOW' | 'BLOCK'}
      */
     clientMessagingGiphy: 'string',
-    /**
-     * This property should store the company name.
-     *
-     * @type {string}
+    /**
+     * This property should store the company name.
+     *
+     * @type {string}
      */
     customerCompanyName: 'string',
-    /**
-     * This property should store the logo url.
-     *
-     * @type {string}
+    /**
+     * This property should store the logo url.
+     *
+     * @type {string}
      */
     customerLogoUrl: 'string',
-    /**
-     * This property doesn't have any real values, but is sent during device
-     * refresh to prevent the **wdm** service from falling back to an iOS device
-     * type.
-     *
-     * @type {string}
+    /**
+     * This property doesn't have any real values, but is sent during device
+     * refresh to prevent the **wdm** service from falling back to an iOS device
+     * type.
+     *
+     * @type {string}
      */
     deviceType: 'string',
-    /**
-     * This property should store the help url.
-     *
-     * @type {string}
+    /**
+     * This property should store the help url.
+     *
+     * @type {string}
      */
     helpUrl: 'string',
-    /**
-     * This property should store the intranet inactivity timer duration.
-     *
-     * @type {number}
+    /**
+     * This property should store the intranet inactivity timer duration.
+     *
+     * @type {number}
      */
     intranetInactivityDuration: 'number',
-    /**
-     * This property stores the url required to validate if the device is able
-     * to actively reach the intranet network.
-     *
-     * @type {string}
+    /**
+     * This property stores the url required to validate if the device is able
+     * to actively reach the intranet network.
+     *
+     * @type {string}
      */
     intranetInactivityCheckUrl: 'string',
-    /**
-     * This property stores the inactivity timer duration, and could possibly
-     * deprecate the `intranetInactivityDuration` property.
-     *
-     * @type {number}
+    /**
+     * This property stores the inactivity timer duration, and could possibly
+     * deprecate the `intranetInactivityDuration` property.
+     *
+     * @type {number}
      */
     inNetworkInactivityDuration: 'number',
-    /**
-     * This property stores the ECM (external content management) enabled value
-     * for the whole organization.
-     *
-     * @type {boolean}
+    /**
+     * This property stores the ECM (external content management) enabled value
+     * for the whole organization.
+     *
+     * @type {boolean}
      */
     ecmEnabledForAllUsers: ['boolean', false, false],
-    /**
-     * This property stores an array of ECM (external content management)
-     * providers that are currently available.
-     *
-     * @returns {Array<string>}
+    /**
+     * This property stores an array of ECM (external content management)
+     * providers that are currently available.
+     *
+     * @returns {Array<string>}
      */
     ecmSupportedStorageProviders: ['array', false, function () {
       return [];
     }],
-    /**
-     * This property stores the modification time value retrieved from the
-     * **WDM** endpoint formatted as ISO 8601.
-     *
-     * @type {string}
+    /**
+     * This property stores the modification time value retrieved from the
+     * **WDM** endpoint formatted as ISO 8601.
+     *
+     * @type {string}
      */
     modificationTime: 'string',
-    /**
-     * This property stores the navigation bar color.
-     *
-     * @type {string}
+    /**
+     * This property stores the navigation bar color.
+     *
+     * @type {string}
      */
     navigationBarColor: 'string',
-    /**
-     * This property stores the partner company's name when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the partner company's name when available.
+     *
+     * @type {string}
      */
     partnerCompanyName: 'string',
-    /**
-     * This property stores the partner company's logo when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the partner company's logo when available.
+     *
+     * @type {string}
      */
     partnerLogoUrl: 'string',
-    /**
-     * This property stores the availability of people data from the **WDM**
-     * service.
-     *
-     * @type {boolean}
+    /**
+     * This property stores the availability of people data from the **WDM**
+     * service.
+     *
+     * @type {boolean}
      */
     peopleInsightsEnabled: 'boolean',
-    /**
-     * This property stores the reporting site's description when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the reporting site's description when available.
+     *
+     * @type {string}
      */
     reportingSiteDesc: 'string',
-    /**
-     * This property stores the reporting site's access url when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the reporting site's access url when available.
+     *
+     * @type {string}
      */
     reportingSiteUrl: 'string',
-    /**
-     * This property stores the encryption key url when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the encryption key url when available.
+     *
+     * @type {string}
      */
     searchEncryptionKeyUrl: 'string',
-    /**
-     * This property stores the availability of support-provided text from the
-     * **WDM** service.
-     *
-     * @type {boolean}
+    /**
+     * This property stores the availability of support-provided text from the
+     * **WDM** service.
+     *
+     * @type {boolean}
      */
     showSupportText: 'boolean',
-    /**
-     * This property stores the support provider's company name when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the support provider's company name when available.
+     *
+     * @type {string}
      */
     supportProviderCompanyName: 'string',
-    /**
-     * This property stores the support provider's logo url when available.
-     *
-     * @type {string}
+    /**
+     * This property stores the support provider's logo url when available.
+     *
+     * @type {string}
      */
     supportProviderLogoUrl: 'string',
-    /**
-     * This property stores the device's url retrieved from a registration
-     * request. This property gets set via the initial registration process by a
-     * `this.set()` method.
-     *
-     * @type {string}
+    /**
+     * This property stores the device's url retrieved from a registration
+     * request. This property gets set via the initial registration process by a
+     * `this.set()` method.
+     *
+     * @type {string}
      */
     url: 'string',
-    /**
-     * This property stores the device's userId uuid value, which can also be
-     * derived from the device's registerd user's userId retrieved from
-     * the **Hydra** service.
-     *
-     * @type {string}
+    /**
+     * This property stores the device's userId uuid value, which can also be
+     * derived from the device's registerd user's userId retrieved from
+     * the **Hydra** service.
+     *
+     * @type {string}
      */
     userId: 'string',
-    /**
-     * This property stores whether or not file sharing is enabled
-     *
-     * @type {'BLOCK_BOTH' | 'BLOCK_UPLOAD'}
+    /**
+     * This property stores whether or not file sharing is enabled
+     *
+     * @type {'BLOCK_BOTH' | 'BLOCK_UPLOAD'}
      */
     webFileShareControl: 'string',
-    /**
-     * This property stores the current web socket url used by the registered
-     * device.
-     *
-     * @type {string}
+    /**
+     * This property stores the current web socket url used by the registered
+     * device.
+     *
+     * @type {string}
      */
     webSocketUrl: 'string',
-    /**
-     * This property stores the value indicating whether or not white board file
-     * sharing is enabled for the current device.
-     *
-     * @type {'ALLOW' | 'BLOCK'}
+    /**
+     * This property stores the value indicating whether or not white board file
+     * sharing is enabled for the current device.
+     *
+     * @type {'ALLOW' | 'BLOCK'}
      */
     whiteboardFileShareControl: 'string'
   },
-  /**
-   * A list of derived properties that populate based when their parent data
-   * available via the device's properties.
-   *
-   * @type {Object}
+  /**
+   * A list of derived properties that populate based when their parent data
+   * available via the device's properties.
+   *
+   * @type {Object}
    */
   derived: {
-    /**
-     * This property determines if the current device is registered.
-     *
-     * @type {boolean}
+    /**
+     * This property determines if the current device is registered.
+     *
+     * @type {boolean}
      */
     registered: {
       deps: ['url'],
-      /**
-       * Checks if the device is registered by validating that the url exists.
-       * Amperstand does not allow this to method to be written as an arrow
-       * function.
-       *
-       * @returns {boolean}
+      /**
+       * Checks if the device is registered by validating that the url exists.
+       * Amperstand does not allow this to method to be written as an arrow
+       * function.
+       *
+       * @returns {boolean}
        */
       fn: function fn() {
         return !!this.url;
       }
     }
   },
-  /**
-   * Stores timer data as well as other state details.
-   *
-   * @type {Object}
+  /**
+   * Stores timer data as well as other state details.
+   *
+   * @type {Object}
    */
   session: {
-    /**
-     * This property stores the logout timer object
-     *
-     * @type {any}
+    /**
+     * This property stores the logout timer object
+     *
+     * @type {any}
      */
     logoutTimer: 'any',
-    /**
-     * This property stores the date for the last activity the user made
-     * with the current device.
-     *
-     * @type {number}
+    /**
+     * This property stores the date for the last activity the user made
+     * with the current device.
+     *
+     * @type {number}
      */
     lastUserActivityDate: 'number',
-    /**
-     * This property stores whether or not the reachability check has been
-     * performed to prevent the reachability check from performing its
-     * operation more than once after a successful check.
-     *
-     * @returns {boolean}
+    /**
+     * This property stores whether or not the reachability check has been
+     * performed to prevent the reachability check from performing its
+     * operation more than once after a successful check.
+     *
+     * @returns {boolean}
      */
     isReachabilityChecked: ['boolean', false, false],
-    /**
-     * This property stores whether or not the current device is in a meeting
-     * to prevent an unneeded timeout of a meeting due to inactivity.
-     *
-     * @type {boolean}
+    /**
+     * This property stores whether or not the current device is in a meeting
+     * to prevent an unneeded timeout of a meeting due to inactivity.
+     *
+     * @type {boolean}
      */
     isInMeeting: 'boolean',
-    /**
-     * This property identifies if the device is currently in network to prevent
-     * the `resetLogoutTimer()` method from being called repeatedly once its
-     * known client is connected to the organization's internal network.
-     *
-     * @type {boolean}
+    /**
+     * This property identifies if the device is currently in network to prevent
+     * the `resetLogoutTimer()` method from being called repeatedly once its
+     * known client is connected to the organization's internal network.
+     *
+     * @type {boolean}
      */
     isInNetwork: 'boolean'
   },
   // Event method members.
-  /**
-   * Trigger meeting started event for webex instance. Used by web-client team.
-   *
-   * @returns {void}
+  /**
+   * Trigger meeting started event for webex instance. Used by web-client team.
+   *
+   * @returns {void}
    */
   meetingStarted: function meetingStarted() {
     this.webex.trigger('meeting started');
   },
-  /**
-   * Trigger meeting ended event for webex instance. Used by web-client team.
-   *
-   * @returns {void}
+  /**
+   * Trigger meeting ended event for webex instance. Used by web-client team.
+   *
+   * @returns {void}
    */
   meetingEnded: function meetingEnded() {
     this.webex.trigger('meeting ended');
@@ -425,12 +425,12 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
   },
   /* eslint-enable require-jsdoc */
   // Helper method members
-  /**
-   * Determine if registration methods can be performed. This method utilizes
-   * the `services` plugin to confirm if the appropriate service urls are
-   * available for device registration.
-   *
-   * @returns {Promise<void, Error>}
+  /**
+   * Determine if registration methods can be performed. This method utilizes
+   * the `services` plugin to confirm if the appropriate service urls are
+   * available for device registration.
+   *
+   * @returns {Promise<void, Error>}
    */
   canRegister: function canRegister() {
     this.logger.info('device: validating if registration can occur');
@@ -446,10 +446,10 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
       );
     });
   },
-  /**
-   * Check if the device can currently reach the inactivity check url.
-   *
-   * @returns {Promise<void, Error>}
+  /**
+   * Check if the device can currently reach the inactivity check url.
+   *
+   * @returns {Promise<void, Error>}
    */
   checkNetworkReachability: function checkNetworkReachability() {
     var _this4 = this;
@@ -489,11 +489,11 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
       return _promise.default.resolve(_this4.resetLogoutTimer());
     });
   },
-  /**
-   * Clears the registration ttl value if available.
-   *
-   * @param {Object} options - Values to be cleared.
-   * @returns {void}
+  /**
+   * Clears the registration ttl value if available.
+   *
+   * @param {Object} options - Values to be cleared.
+   * @returns {void}
    */
   clear: function clear() {
     this.logger.info('device: clearing registered device');
@@ -504,11 +504,11 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
     }
     (0, _apply.default)(_webexCore.WebexPlugin.prototype.clear, this, args);
   },
-  /**
-   * Get the current websocket url with the appropriate priority host.
-   *
-   * @param {boolean} [wait=false] - Willing to wait on a valid url.
-   * @returns {Promise<string, Error>} - The priority-mapped web socket url.
+  /**
+   * Get the current websocket url with the appropriate priority host.
+   *
+   * @param {boolean} [wait=false] - Willing to wait on a valid url.
+   * @returns {Promise<string, Error>} - The priority-mapped web socket url.
    */
   getWebSocketUrl: function getWebSocketUrl() {
     var _this5 = this;
@@ -542,11 +542,11 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
     }
     return _promise.default.reject(new Error('device: failed to get the current websocket url'));
   },
-  /**
-   * Process a successful device registration.
-   *
-   * @param {Object} response - response object from registration success.
-   * @returns {void}
+  /**
+   * Process a successful device registration.
+   *
+   * @param {Object} response - response object from registration success.
+   * @returns {void}
    */
   processRegistrationSuccess: function processRegistrationSuccess(response) {
     var _this6 = this;
@@ -591,11 +591,11 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
     // Emit the registration:success event.
     this.trigger(_constants.DEVICE_EVENT_REGISTRATION_SUCCESS, this);
   },
-  /**
-   * Reset the current local logout timer for the registered device if
-   * registered.
-   *
-   * @returns {void}
+  /**
+   * Reset the current local logout timer for the registered device if
+   * registered.
+   *
+   * @returns {void}
    */
   resetLogoutTimer: function resetLogoutTimer() {
     this.logger.info('device: resetting logout timer');
@@ -619,11 +619,11 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
       }
     }
   },
-  /**
-   * Set the value of the logout timer for the current registered device.
-   *
-   * @param {number} duration - Value in seconds of the new logout timer.
-   * @returns {void}
+  /**
+   * Set the value of the logout timer for the current registered device.
+   *
+   * @param {number} duration - Value in seconds of the new logout timer.
+   * @returns {void}
    */
   setLogoutTimer: function setLogoutTimer(duration) {
     var _this7 = this;
@@ -642,11 +642,11 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
       _this7.webex.logout();
     }, duration * 1000);
   },
-  /**
-   * Wait for the device to be registered.
-   *
-   * @param {number} [timeout=10] - The maximum duration to wait, in seconds.
-   * @returns {Promise<void, Error>}
+  /**
+   * Wait for the device to be registered.
+   *
+   * @param {number} [timeout=10] - The maximum duration to wait, in seconds.
+   * @returns {Promise<void, Error>}
    */
   waitForRegistration: function waitForRegistration() {
     var _this8 = this;
@@ -716,7 +716,7 @@ var Device = _webexCore.WebexPlugin.extend((_dec = (0, _webexCore.waitForValue)(
       _this9.resetLogoutTimer();
     });
   } /* eslint-enable require-jsdoc */,
-  version: "2.59.2"
+  version: "2.59.0"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight, _dec], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "register", [_common.oneFlight, _dec2], (0, _getOwnPropertyDescriptor.default)(_obj, "register"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "unregister", [_common.oneFlight, _dec3], (0, _getOwnPropertyDescriptor.default)(_obj, "unregister"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "markUrlFailedAndGetNew", [_dec4], (0, _getOwnPropertyDescriptor.default)(_obj, "markUrlFailedAndGetNew"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "initialize", [_dec5], (0, _getOwnPropertyDescriptor.default)(_obj, "initialize"), _obj)), _obj)));
 var _default = Device;
 exports.default = _default;