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

package/dist/members/index.js

@@ -27,66 +27,66 @@ var _request = _interopRequireDefault(require("./request"));
 var _util = _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; } }
-/**
- * Members Update Event
- * Emitted when something in the roster list needs to be updated
- * @event members:update
- * @instance
- * @property {Object} delta the changes to the members list
- * @property {Array} delta.updated array only the updates, includes removals, as they will have updated status and member properties
- * @property {Array} delta.added array added members to the meeting
- * @property {Array} full array the full members collection
- * @memberof Members
+/**
+ * Members Update Event
+ * Emitted when something in the roster list needs to be updated
+ * @event members:update
+ * @instance
+ * @property {Object} delta the changes to the members list
+ * @property {Array} delta.updated array only the updates, includes removals, as they will have updated status and member properties
+ * @property {Array} delta.added array added members to the meeting
+ * @property {Array} full array the full members collection
+ * @memberof Members
  */
-/**
- * Members Content Update Event
- * Emitted when who is sharing changes
- * @event members:content:update
- * @instance
- * @property {String} activeContentSharingId
- * @property {String} endedContentSharingId
- * @memberof Members
+/**
+ * Members Content Update Event
+ * Emitted when who is sharing changes
+ * @event members:content:update
+ * @instance
+ * @property {String} activeContentSharingId
+ * @property {String} endedContentSharingId
+ * @memberof Members
  */
-/**
- * Members Host Update Event
- * Emitted when who is the host changes
- * @event members:host:update
- * @instance
- * @property {String} activeHostId
- * @property {String} endedHostId
- * @memberof Members
+/**
+ * Members Host Update Event
+ * Emitted when who is the host changes
+ * @event members:host:update
+ * @instance
+ * @property {String} activeHostId
+ * @property {String} endedHostId
+ * @memberof Members
  */
-/**
- * Members Self Update Event
- * Emitted when who is the self changes
- * @event members:self:update
- * @instance
- * @property {String} activeSelfId
- * @property {String} endedSelfId
- * @memberof Members
+/**
+ * Members Self Update Event
+ * Emitted when who is the self changes
+ * @event members:self:update
+ * @instance
+ * @property {String} activeSelfId
+ * @property {String} endedSelfId
+ * @memberof Members
  */
-/**
- * @class Members
+/**
+ * @class Members
  */
 var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
   (0, _inherits2.default)(Members, _StatelessWebexPlugin);
   var _super = _createSuper(Members);
-  /**
-   *
-   * @param {Object} attrs
-   * @param {Object} options
-   * @memberof Members
+  /**
+   *
+   * @param {Object} attrs
+   * @param {Object} options
+   * @memberof Members
    */
   function Members(attrs, options) {
     var _this;
     (0, _classCallCheck2.default)(this, Members);
     _this = _super.call(this, {}, options);
-    /**
-     * The Members Request object to interact with server
-     * @instance
-     * @type {MembersRequest}
-     * @private
-     * @memberof Members
+    /**
+     * The Members Request object to interact with server
+     * @instance
+     * @type {MembersRequest}
+     * @private
+     * @memberof Members
      */
     // @ts-ignore
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "hostId", void 0);
@@ -100,87 +100,87 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "type", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "namespace", _constants.MEETINGS);
     _this.membersRequest = new _request.default({}, options);
-    /**
-     * The Members Collection cache
-     * @instance
-     * @type {MembersCollection}
-     * @private
-     * @memberof Members
+    /**
+     * The Members Collection cache
+     * @instance
+     * @type {MembersCollection}
+     * @private
+     * @memberof Members
      */
     _this.membersCollection = new _collection.default();
-    /**
-     * The current locus url for the active meeting
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * The current locus url for the active meeting
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.locusUrl = attrs.locusUrl || null;
-    /**
-     * The current hostId for the meeting
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * The current hostId for the meeting
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.hostId = null;
-    /**
-     * The current type for the meeting, could be MEETING or CALL
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * The current type for the meeting, could be MEETING or CALL
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.type = null;
-    /**
-     * Locus has a self object, sent individually to the client
-     * i.e., each person in the call gets their own self object from locus.
-     * We need to maintain that self object, because we also get information about all the participants
-     * and differentiate those participants from self.
-     * The self id shouldnt ever change, but it does have properties that will change
-     * and we use values in locus-info, such as to determine if i am admitted to the meeting or not as guest.
-     * The current selfId for the meeting
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * Locus has a self object, sent individually to the client
+     * i.e., each person in the call gets their own self object from locus.
+     * We need to maintain that self object, because we also get information about all the participants
+     * and differentiate those participants from self.
+     * The self id shouldnt ever change, but it does have properties that will change
+     * and we use values in locus-info, such as to determine if i am admitted to the meeting or not as guest.
+     * The current selfId for the meeting
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.selfId = null;
-    /**
-     * The current mediaShareContentId for the meeting
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * The current mediaShareContentId for the meeting
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.mediaShareContentId = null;
-    /**
-     * The current mediaShareWhiteboardId for the meeting
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * The current mediaShareWhiteboardId for the meeting
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.mediaShareWhiteboardId = null;
-    /**
-     * The current recordingId for the meeting, if it exists
-     * @instance
-     * @type {String}
-     * @private
-     * @memberof Members
+    /**
+     * The current recordingId for the meeting, if it exists
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Members
      */
     _this.recordingId = null;
     return _this;
   }
 
-  /**
-   * Internal update the self Id value
-   * @param {Object} payload
-   * @param {Object} payload.newSelf
-   * @param {Object} payload.oldSelf
-   * @returns {undefined}
-   * @private
-   * @memberof Members
+  /**
+   * Internal update the self Id value
+   * @param {Object} payload
+   * @param {Object} payload.newSelf
+   * @param {Object} payload.oldSelf
+   * @returns {undefined}
+   * @private
+   * @memberof Members
    */
   (0, _createClass2.default)(Members, [{
     key: "locusSelfUpdate",
@@ -217,14 +217,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       });
     }
 
-    /**
-     * Internal update the hostId value
-     * @param {Object} payload
-     * @param {Object} payload.newHost
-     * @param {Object} payload.oldHost
-     * @returns {undefined}
-     * @private
-     * @memberof Members
+    /**
+     * Internal update the hostId value
+     * @param {Object} payload
+     * @param {Object} payload.newHost
+     * @param {Object} payload.oldHost
+     * @returns {undefined}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "locusHostUpdate",
@@ -261,14 +261,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       });
     }
 
-    /**
-     * when new participant updates come in, both delta and full participants, update them in members collection
-     * delta object in the event will have {updated, added} and full will be the full membersCollection
-     * @param {Object} payload
-     * @param {Object} payload.participants
-     * @returns {undefined}
-     * @private
-     * @memberof Members
+    /**
+     * when new participant updates come in, both delta and full participants, update them in members collection
+     * delta object in the event will have {updated, added} and full will be the full membersCollection
+     * @param {Object} payload
+     * @param {Object} payload.participants
+     * @returns {undefined}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "locusParticipantsUpdate",
@@ -287,14 +287,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Internal update the content id
-     * @param {Object} payload
-     * @param {Object} payload.current
-     * @param {Object} payload.previous
-     * @returns {undefined}
-     * @private
-     * @memberof Members
+    /**
+     * Internal update the content id
+     * @param {Object} payload
+     * @param {Object} payload.current
+     * @param {Object} payload.previous
+     * @returns {undefined}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "locusMediaSharesUpdate",
@@ -357,13 +357,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       });
     }
 
-    /**
-     * Internal update the locus url value
-     * @param {Object} payload
-     * @param {String} payload.locusUrl
-     * @returns {undefined}
-     * @private
-     * @memberof Members
+    /**
+     * Internal update the locus url value
+     * @param {Object} payload
+     * @param {String} payload.locusUrl
+     * @returns {undefined}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "locusUrlUpdate",
@@ -373,13 +373,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Internal update the type of meeting
-     * @param {Object} payload
-     * @param {String} payload.type
-     * @returns {undefined}
-     * @private
-     * @memberof Members
+    /**
+     * Internal update the type of meeting
+     * @param {Object} payload
+     * @param {String} payload.type
+     * @returns {undefined}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "locusFullStateTypeUpdate",
@@ -395,12 +395,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * sets values in the members collection for updated and added properties from delta
-     * @param {Object} membersUpdate {updated: [], added: []}
-     * @returns {Object} membersCollection
-     * @private
-     * @memberof Members
+    /**
+     * sets values in the members collection for updated and added properties from delta
+     * @param {Object} membersUpdate {updated: [], added: []}
+     * @returns {Object} membersCollection
+     * @private
+     * @memberof Members
      */
   }, {
     key: "handleMembersUpdate",
@@ -416,12 +416,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersCollection.getAll();
     }
 
-    /**
-     * set members to the member collection from each updated/added lists as passed in
-     * @param {Array} list
-     * @returns {undefined}
-     * @private
-     * @memberof Members
+    /**
+     * set members to the member collection from each updated/added lists as passed in
+     * @param {Array} list
+     * @returns {undefined}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "constructMembers",
@@ -432,12 +432,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       });
     }
 
-    /**
-     * Internal update the participants value
-     * @param {Object} payload
-     * @returns {Object}
-     * @private
-     * @memberof Members
+    /**
+     * Internal update the participants value
+     * @param {Object} payload
+     * @returns {Object}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "handleLocusInfoUpdatedParticipants",
@@ -452,14 +452,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return memberUpdate;
     }
 
-    /**
-     * Update the locus Url
-     * @param {Object} locus
-     * @param {String} [locusUrl] optional, takes precedence
-     * @throws {ParameterError}
-     * @returns {undefined}
-     * @public
-     * @memberof Members
+    /**
+     * Update the locus Url
+     * @param {Object} locus
+     * @param {String} [locusUrl] optional, takes precedence
+     * @throws {ParameterError}
+     * @returns {undefined}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "setLocusUrl",
@@ -474,14 +474,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Update the host id
-     * @param {Object} locus
-     * @param {String} [hostId] optional, takes precedence
-     * @throws {ParameterError}
-     * @returns {undefined}
-     * @public
-     * @memberof Members
+    /**
+     * Update the host id
+     * @param {Object} locus
+     * @param {String} [hostId] optional, takes precedence
+     * @throws {ParameterError}
+     * @returns {undefined}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "setHostId",
@@ -496,14 +496,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Update the type
-     * @param {Object} fullState
-     * @param {String} [type] optional, takes precedence
-     * @throws {ParameterError}
-     * @returns {undefined}
-     * @public
-     * @memberof Members
+    /**
+     * Update the type
+     * @param {Object} fullState
+     * @param {String} [type] optional, takes precedence
+     * @throws {ParameterError}
+     * @returns {undefined}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "setType",
@@ -518,13 +518,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Update the self Id
-     * @param {Object} locus
-     * @param {String} [selfId] optional, takes precedence
-     * @throws {Error}
-     * @returns {undefined}
-     * @memberof Members
+    /**
+     * Update the self Id
+     * @param {Object} locus
+     * @param {String} [selfId] optional, takes precedence
+     * @throws {Error}
+     * @returns {undefined}
+     * @memberof Members
      */
   }, {
     key: "setSelfId",
@@ -539,13 +539,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Update the media share content id
-     * @param {Object} locus
-     * @param {String} [contentId] optional, takes precedence
-     * @throws {Error}
-     * @returns {undefined}
-     * @memberof Members
+    /**
+     * Update the media share content id
+     * @param {Object} locus
+     * @param {String} [contentId] optional, takes precedence
+     * @throws {Error}
+     * @returns {undefined}
+     * @memberof Members
      */
   }, {
     key: "setMediaShareContentId",
@@ -562,13 +562,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Update the media share whiteboard id
-     * @param {Object} locus
-     * @param {String} [whiteboardId] optional, takes precedence
-     * @throws {Error}
-     * @returns {undefined}
-     * @memberof Members
+    /**
+     * Update the media share whiteboard id
+     * @param {Object} locus
+     * @param {String} [whiteboardId] optional, takes precedence
+     * @throws {Error}
+     * @returns {undefined}
+     * @memberof Members
      */
   }, {
     key: "setMediaShareWhiteboardId",
@@ -585,14 +585,14 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       }
     }
 
-    /**
-     * Find all the updates, and added members
-     * Removed/left members will end up in updates
-     * Each array contains only members
-     * @param {Array} participants the locus participants
-     * @returns {Object} {added: {Array}, updated: {Array}}
-     * @private
-     * @memberof Members
+    /**
+     * Find all the updates, and added members
+     * Removed/left members will end up in updates
+     * Each array contains only members
+     * @param {Array} participants the locus participants
+     * @returns {Object} {added: {Array}, updated: {Array}}
+     * @private
+     * @memberof Members
      */
   }, {
     key: "update",
@@ -634,12 +634,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return membersUpdate;
     }
 
-    /**
-     * Adds a guest Member to the associated meeting
-     * @param {String} invitee
-     * @param {Boolean} [alertIfActive]
-     * @returns {Promise}
-     * @memberof Members
+    /**
+     * Adds a guest Member to the associated meeting
+     * @param {String} invitee
+     * @param {Boolean} [alertIfActive]
+     * @returns {Promise}
+     * @memberof Members
      */
   }, {
     key: "addMember",
@@ -654,11 +654,11 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.addMembers(options);
     }
 
-    /**
-     * Cancels an outgoing PSTN call to the associated meeting
-     * @param {String} invitee
-     * @returns {Promise}
-     * @memberof Members
+    /**
+     * Cancels an outgoing PSTN call to the associated meeting
+     * @param {String} invitee
+     * @returns {Promise}
+     * @memberof Members
      */
   }, {
     key: "cancelPhoneInvite",
@@ -673,12 +673,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.cancelPhoneInvite(options);
     }
 
-    /**
-     * Admits waiting members (invited guests to meeting)
-     * @param {Array} memberIds
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Admits waiting members (invited guests to meeting)
+     * @param {Array} memberIds
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "admitMembers",
@@ -690,12 +690,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.admitMember(options);
     }
 
-    /**
-     * Removes a member from the meeting
-     * @param {String} memberId
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Removes a member from the meeting
+     * @param {String} memberId
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "removeMember",
@@ -710,13 +710,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.removeMember(options);
     }
 
-    /**
-     * Audio mutes another member in a meeting
-     * @param {String} memberId
-     * @param {boolean} [mute] default true
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Audio mutes another member in a meeting
+     * @param {String} memberId
+     * @param {boolean} [mute] default true
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "muteMember",
@@ -732,13 +732,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.muteMember(options);
     }
 
-    /**
-     * Raise or lower the hand of a member in a meeting
-     * @param {String} memberId
-     * @param {boolean} [raise] - to raise hand (=true) or lower (=false), default: true
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Raise or lower the hand of a member in a meeting
+     * @param {String} memberId
+     * @param {boolean} [raise] - to raise hand (=true) or lower (=false), default: true
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "raiseOrLowerHand",
@@ -754,12 +754,12 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.raiseOrLowerHandMember(options);
     }
 
-    /**
-     * Lower all hands of members in a meeting
-     * @param {String} requestingMemberId - id of the participant which requested the lower all hands
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Lower all hands of members in a meeting
+     * @param {String} requestingMemberId - id of the participant which requested the lower all hands
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "lowerAllHands",
@@ -774,13 +774,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.lowerAllHandsMember(options);
     }
 
-    /**
-     * Transfers the host to another member
-     * @param {String} memberId
-     * @param {boolean} [moderator] default true
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Transfers the host to another member
+     * @param {String} memberId
+     * @param {boolean} [moderator] default true
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "transferHostToMember",
@@ -796,13 +796,13 @@ var Members = /*#__PURE__*/function (_StatelessWebexPlugin) {
       return this.membersRequest.transferHostToMember(options);
     }
 
-    /**
-     * Sends DTMF tones for the PSTN member of a meeting
-     * @param {String} tones a string of one or more DTMF tones to send
-     * @param {String} memberId member id
-     * @returns {Promise}
-     * @public
-     * @memberof Members
+    /**
+     * Sends DTMF tones for the PSTN member of a meeting
+     * @param {String} tones a string of one or more DTMF tones to send
+     * @param {String} memberId member id
+     * @returns {Promise}
+     * @public
+     * @memberof Members
      */
   }, {
     key: "sendDialPadKey",