@webex/plugin-meetings 2.59.2 → 2.59.3-next.1

package/dist/meetings/index.js

@@ -46,61 +46,61 @@ var _collection = _interopRequireDefault(require("./collection"));
 var _util2 = _interopRequireDefault(require("./util"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-/**
- * Meetings Ready Event
- * Emitted when the meetings instance on webex is ready
- * @event meetings:ready
- * @instance
- * @memberof Meetings
+/**
+ * Meetings Ready Event
+ * Emitted when the meetings instance on webex is ready
+ * @event meetings:ready
+ * @instance
+ * @memberof Meetings
  */
-/**
- * Meetings Network Disconnected Event
- * Emitted when the meetings instance is disconnected from
- * the internal mercury server
- * @event network:disconnected
- * @instance
- * @memberof Meetings
+/**
+ * Meetings Network Disconnected Event
+ * Emitted when the meetings instance is disconnected from
+ * the internal mercury server
+ * @event network:disconnected
+ * @instance
+ * @memberof Meetings
  */
-/**
- * Meetings Registered Event
- * Emitted when the meetings instance has been registered and listening
- * @event meetings:registered
- * @instance
- * @memberof Meetings
+/**
+ * Meetings Registered Event
+ * Emitted when the meetings instance has been registered and listening
+ * @event meetings:registered
+ * @instance
+ * @memberof Meetings
  */
-/**
- * Meeting Removed Event
- * Emitted when a meeting was removed from the cache of meetings
- * @event meeting:removed
- * @instance
- * @type {Object}
- * @property {String} meetingId the removed meeting
- * @property {Object} response the server response
- * @property {String} type what type of meeting it was
- * @memberof Meetings
+/**
+ * Meeting Removed Event
+ * Emitted when a meeting was removed from the cache of meetings
+ * @event meeting:removed
+ * @instance
+ * @type {Object}
+ * @property {String} meetingId the removed meeting
+ * @property {Object} response the server response
+ * @property {String} type what type of meeting it was
+ * @memberof Meetings
  */
-/**
- * Meeting Added Event
- * Emitted when a meeting was added to the cache of meetings
- * @event meeting:added
- * @instance
- * @type {Object}
- * @property {String} meetingId the added meeting
- * @property {String} type what type of meeting it was
- * @memberof Meetings
+/**
+ * Meeting Added Event
+ * Emitted when a meeting was added to the cache of meetings
+ * @event meeting:added
+ * @instance
+ * @type {Object}
+ * @property {String} meetingId the added meeting
+ * @property {String} type what type of meeting it was
+ * @memberof Meetings
  */
-/**
- * Maintain a cache of meetings and sync with services.
- * @class
+/**
+ * Maintain a cache of meetings and sync with services.
+ * @class
  */
 var Meetings = /*#__PURE__*/function (_WebexPlugin) {
   (0, _inherits2.default)(Meetings, _WebexPlugin);
   var _super = _createSuper(Meetings);
-  /**
-   * Initializes the Meetings Plugin
-   * @constructor
-   * @public
-   * @memberof Meetings
+  /**
+   * Initializes the Meetings Plugin
+   * @constructor
+   * @public
+   * @memberof Meetings
    */
   function Meetings() {
     var _this;
@@ -110,12 +110,12 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     }
     _this = _super.call.apply(_super, [this].concat(args));
 
-    /**
-     * The Meetings request to interact with server
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Meetings
+    /**
+     * The Meetings request to interact with server
+     * @instance
+     * @type {Object}
+     * @private
+     * @memberof Meetings
      */
     // @ts-ignore
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "loggerRequest", void 0);
@@ -132,61 +132,61 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     _this.request = new _request2.default({}, {
       parent: _this.webex
     });
-    /**
-     * Log upload request helper
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Meetings
+    /**
+     * Log upload request helper
+     * @instance
+     * @type {Object}
+     * @private
+     * @memberof Meetings
      */
     // @ts-ignore
     _this.loggerRequest = new _request.default({
       webex: _this.webex
     });
     _this.meetingCollection = new _collection.default();
-    /**
-     * The PersonalMeetingRoom object to interact with server
-     * @instance
-     * @type {Object}
-     * @public
-     * @memberof Meetings
+    /**
+     * The PersonalMeetingRoom object to interact with server
+     * @instance
+     * @type {Object}
+     * @public
+     * @memberof Meetings
      */
     _this.personalMeetingRoom = null;
-    /**
-     * The Reachability object to interact with server, starts as null until {@link Meeting#setReachability} is called
-     * starts as null
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Meetings
+    /**
+     * The Reachability object to interact with server, starts as null until {@link Meeting#setReachability} is called
+     * starts as null
+     * @instance
+     * @type {Object}
+     * @private
+     * @memberof Meetings
      */
     _this.reachability = null;
 
-    /**
-     * If the meetings plugin has been registered and listening via {@link Meetings#register}
-     * @instance
-     * @type {Boolean}
-     * @public
-     * @memberof Meetings
+    /**
+     * If the meetings plugin has been registered and listening via {@link Meetings#register}
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Meetings
      */
     _this.registered = false;
 
-    /**
-     * This values indicates the preferred webex site the user will start there meeting, getsits value from {@link Meetings#register}
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Meetings
+    /**
+     * This values indicates the preferred webex site the user will start there meeting, getsits value from {@link Meetings#register}
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Meetings
      */
     _this.preferredWebexSite = '';
 
-    /**
-     * The public interface for the internal Media util files. These are helpful to expose outside the context
-     * of a meeting so that a user can access media without creating a meeting instance.
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Meetings
+    /**
+     * The public interface for the internal Media util files. These are helpful to expose outside the context
+     * of a meeting so that a user can access media without creating a meeting instance.
+     * @instance
+     * @type {Object}
+     * @private
+     * @memberof Meetings
      */
     _this.media = {
       getUserMedia: _media.default.getUserMedia,
@@ -196,16 +196,16 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     return _this;
   }
 
-  /**
-   * handle locus events and takes meeting actions with them as they come in
-   * @param {Object} data a locus event
-   * @param {String} data.locusUrl
-   * @param {Object} data.locus
-   * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
-   * @param {String} data.eventType
-   * @returns {undefined}
-   * @private
-   * @memberof Meetings
+  /**
+   * handle locus events and takes meeting actions with them as they come in
+   * @param {Object} data a locus event
+   * @param {String} data.locusUrl
+   * @param {Object} data.locus
+   * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
+   * @param {String} data.eventType
+   * @returns {undefined}
+   * @private
+   * @memberof Meetings
    */
   (0, _createClass2.default)(Meetings, [{
     key: "handleLocusEvent",
@@ -303,14 +303,14 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       }
     }
 
-    /**
-     * handles locus events through mercury that are not roap
-     * @param {Object} envelope
-     * @param {Object} envelope.data
-     * @param {String} envelope.data.eventType
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
+    /**
+     * handles locus events through mercury that are not roap
+     * @param {Object} envelope
+     * @param {Object} envelope.data
+     * @param {String} envelope.data.eventType
+     * @returns {undefined}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "handleLocusMercury",
@@ -323,11 +323,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       }
     }
 
-    /**
-     * handles mecury offline event
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
+    /**
+     * handles mecury offline event
+     * @returns {undefined}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "handleMercuryOffline",
@@ -338,11 +338,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       }, _constants.EVENT_TRIGGERS.MEETINGS_NETWORK_DISCONNECTED);
     }
 
-    /**
-     * registers for locus and roap mercury events
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
+    /**
+     * registers for locus and roap mercury events
+     * @returns {undefined}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "listenForEvents",
@@ -368,11 +368,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * stops listening for locus and roap mercury events
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
+    /**
+     * stops listening for locus and roap mercury events
+     * @returns {undefined}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "stopListeningForEvents",
@@ -385,10 +385,10 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       this.webex.internal.mercury.off(_constants.ONLINE);
     }
 
-    /**
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
+    /**
+     * @returns {undefined}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "onReady",
@@ -403,12 +403,12 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
         // @ts-ignore
         _loggerProxy.default.set(_this4.webex.logger);
 
-        /**
-         * The MeetingInfo object to interact with server
-         * @instance
-         * @type {Object}
-         * @private
-         * @memberof Meetings
+        /**
+         * The MeetingInfo object to interact with server
+         * @instance
+         * @type {Object}
+         * @private
+         * @memberof Meetings
          */
         // @ts-ignore
         _this4.meetingInfo = _this4.config.experimental.enableUnifiedMeetings ?
@@ -436,12 +436,12 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * API to toggle unified meetings
-     * @param {Boolean} changeState
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
+    /**
+     * API to toggle unified meetings
+     * @param {Boolean} changeState
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
      */
   }, {
     key: "_toggleUnifiedMeetings",
@@ -459,12 +459,12 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       }
     }
 
-    /**
-     * API to enable or disable TURN discovery
-     * @param {Boolean} enable
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
+    /**
+     * API to enable or disable TURN discovery
+     * @param {Boolean} enable
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
      */
   }, {
     key: "_toggleTurnDiscovery",
@@ -476,12 +476,12 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       this.config.experimental.enableTurnDiscovery = enable;
     }
 
-    /**
-     * API to toggle starting adhoc meeting
-     * @param {Boolean} changeState
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
+    /**
+     * API to toggle starting adhoc meeting
+     * @param {Boolean} changeState
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
      */
   }, {
     key: "_toggleAdhocMeetings",
@@ -497,13 +497,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       }
     }
 
-    /**
-     * Explicitly sets up the meetings plugin by registering
-     * the device, connecting to mercury, and listening for locus events.
-     *
-     * @returns {Promise}
-     * @public
-     * @memberof Meetings
+    /**
+     * Explicitly sets up the meetings plugin by registering
+     * the device, connecting to mercury, and listening for locus events.
+     *
+     * @returns {Promise}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "register",
@@ -549,13 +549,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * Explicitly tears down the meetings plugin by deregistering
-     * the device, disconnecting from mercury, and stops listening to locus events
-     *
-     * @returns {Promise}
-     * @public
-     * @memberof Meetings
+    /**
+     * Explicitly tears down the meetings plugin by deregistering
+     * the device, disconnecting from mercury, and stops listening to locus events
+     *
+     * @returns {Promise}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "unregister",
@@ -582,17 +582,17 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       );
     }
 
-    /**
-     * Uploads logs to the webex services for tracking
-     * @param {Object} [options={}]
-     * @param {String} [options.callStart] Call Start Time
-     * @param {String} [options.feedbackId] ID used for tracking
-     * @param {String} [options.locusId]
-     * @param {String} [options.correlationId]
-     * @param {String} [options.meetingId] webex meeting ID
-     * @param {String} [options.userId] userId
-     * @param {String} [options.orgId] org id
-     * @returns {String} feedback ID logs were submitted under
+    /**
+     * Uploads logs to the webex services for tracking
+     * @param {Object} [options={}]
+     * @param {String} [options.callStart] Call Start Time
+     * @param {String} [options.feedbackId] ID used for tracking
+     * @param {String} [options.locusId]
+     * @param {String} [options.correlationId]
+     * @param {String} [options.meetingId] webex meeting ID
+     * @param {String} [options.userId] userId
+     * @param {String} [options.orgId] org id
+     * @returns {String} feedback ID logs were submitted under
      */
   }, {
     key: "uploadLogs",
@@ -629,11 +629,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * initializes the reachability instance for Meetings
-     * @returns {undefined}
-     * @public
-     * @memberof Meetings
+    /**
+     * initializes the reachability instance for Meetings
+     * @returns {undefined}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "setReachability",
@@ -642,11 +642,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       this.reachability = new _reachability.default(this.webex);
     }
 
-    /**
-     * gets the reachability instance for Meetings
-     * @returns {Reachability}
-     * @public
-     * @memberof Meetings
+    /**
+     * gets the reachability instance for Meetings
+     * @returns {Reachability}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "getReachability",
@@ -654,11 +654,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       return this.reachability;
     }
 
-    /**
-     * initializes and starts gathering reachability for Meetings
-     * @returns {Promise}
-     * @public
-     * @memberof Meetings
+    /**
+     * initializes and starts gathering reachability for Meetings
+     * @returns {Promise}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "startReachability",
@@ -669,11 +669,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       return this.getReachability().gatherReachability();
     }
 
-    /**
-     * Get geoHint for info for meetings
-     * @returns {Promise}
-     * @private
-     * @memberof Meetings
+    /**
+     * Get geoHint for info for meetings
+     * @returns {Promise}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "getGeoHint",
@@ -684,12 +684,12 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * Fetch user preferred webex site information
-     * This also has other infomation about the user
-     * @returns {Promise}
-     * @private
-     * @memberof Meetings
+    /**
+     * Fetch user preferred webex site information
+     * This also has other infomation about the user
+     * @returns {Promise}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "fetchUserPreferredWebexSite",
@@ -702,11 +702,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * gets the personal meeting room instance, for saved PMR values for this user
-     * @returns {PersonalMeetingRoom}
-     * @public
-     * @memberof Meetings
+    /**
+     * gets the personal meeting room instance, for saved PMR values for this user
+     * @returns {PersonalMeetingRoom}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "getPersonalMeetingRoom",
@@ -714,13 +714,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       return this.personalMeetingRoom;
     }
 
-    /**
-     * @param {Meeting} meeting
-     * @param {Object} reason
-     * @param {String} type
-     * @returns {Undefined}
-     * @private
-     * @memberof Meetings
+    /**
+     * @param {Meeting} meeting
+     * @param {Object} reason
+     * @param {String} type
+     * @returns {Undefined}
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "destroy",
@@ -736,14 +736,14 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * Create a meeting.
-     * @param {string} destination - sipURL, spaceId, phonenumber, or locus object}
-     * @param {string} [type] - the optional specified type, such as locusId
-     * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
-     * @returns {Promise<Meeting>} A new Meeting.
-     * @public
-     * @memberof Meetings
+    /**
+     * Create a meeting.
+     * @param {string} destination - sipURL, spaceId, phonenumber, or locus object}
+     * @param {string} [type] - the optional specified type, such as locusId
+     * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
+     * @returns {Promise<Meeting>} A new Meeting.
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "create",
@@ -837,13 +837,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * @param {String} destination see create()
-     * @param {String} type see create()
-     * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
-     * @returns {Promise} a new meeting instance complete with meeting info and destination
-     * @private
-     * @memberof Meetings
+    /**
+     * @param {String} destination see create()
+     * @param {String} type see create()
+     * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
+     * @returns {Promise} a new meeting instance complete with meeting info and destination
+     * @private
+     * @memberof Meetings
      */
   }, {
     key: "createMeeting",
@@ -962,13 +962,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       }
       return createMeeting;
     }()
-    /**
-     * get a specifc meeting given it's type matched to the value, i.e., locus url
-     * @param {String} type
-     * @param {Object} value
-     * @returns {Meeting}
-     * @public
-     * @memberof Meetings
+    /**
+     * get a specifc meeting given it's type matched to the value, i.e., locus url
+     * @param {String} type
+     * @param {Object} value
+     * @returns {Meeting}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "getMeetingByType",
@@ -976,14 +976,14 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       return this.meetingCollection.getByKey(type, value);
     }
 
-    /**
-     * Get all meetings.
-     * @param {object} options
-     * @param {object} options.startDate - get meetings after this start date
-     * @param {object} options.endDate - get meetings before this end date
-     * @returns {Object} All currently active meetings.
-     * @public
-     * @memberof Meetings
+    /**
+     * Get all meetings.
+     * @param {object} options
+     * @param {object} options.startDate - get meetings after this start date
+     * @param {object} options.endDate - get meetings before this end date
+     * @returns {Object} All currently active meetings.
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "getAllMeetings",
@@ -994,11 +994,11 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       return this.meetingCollection.getAll(options);
     }
 
-    /**
-     * syncs all the meeting from server
-     * @returns {undefined}
-     * @public
-     * @memberof Meetings
+    /**
+     * syncs all the meeting from server
+     * @returns {undefined}
+     * @public
+     * @memberof Meetings
      */
   }, {
     key: "syncMeetings",
@@ -1032,13 +1032,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * Get all scheduled meetings.
-     * @param {object} options
-     * @param {object} options.startDate - get meetings after this start date
-     * @param {object} options.endDate - get meetings before this end date
-     * @returns {Object} All scheduled meetings.
-     * @memberof Meetings
+    /**
+     * Get all scheduled meetings.
+     * @param {object} options
+     * @param {object} options.startDate - get meetings after this start date
+     * @param {object} options.endDate - get meetings before this end date
+     * @returns {Object} All scheduled meetings.
+     * @memberof Meetings
      */
   }, {
     key: "getScheduledMeetings",
@@ -1048,9 +1048,9 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
-    /**
-     * Get the logger instance for plugin-meetings
-     * @returns {Logger}
+    /**
+     * Get the logger instance for plugin-meetings
+     * @returns {Logger}
      */
   }, {
     key: "getLogger",