@webex/plugin-meetings 3.0.0-beta.29 → 3.0.0-beta.290

package/src/members/index.ts

@@ -16,6 +16,7 @@ import MembersRequest from './request';
 import MembersUtil from './util';
 import {ReceiveSlotManager} from '../multistream/receiveSlotManager';
 import {MediaRequestManager} from '../multistream/mediaRequestManager';
+import {ServerRoleShape} from './types';
 
 /**
  * Members Update Event
@@ -96,8 +97,14 @@ export default class Members extends StatelessWebexPlugin {
      * @private
      * @memberof Members
      */
+
     // @ts-ignore
-    this.membersRequest = new MembersRequest({}, options);
+    this.membersRequest = new MembersRequest(
+      {
+        meeting: attrs.meeting,
+      },
+      options
+    );
     /**
      * The Members Collection cache
      * @instance
@@ -282,6 +289,25 @@ export default class Members extends StatelessWebexPlugin {
     );
   }
 
+  /**
+   * clear member collection
+   * @returns {void}
+   * @private
+   * @memberof Members
+   */
+  clearMembers() {
+    this.membersCollection.reset();
+    Trigger.trigger(
+      this,
+      {
+        file: 'members',
+        function: 'clearMembers',
+      },
+      EVENT_TRIGGERS.MEMBERS_CLEAR,
+      {}
+    );
+  }
+
   /**
    * 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
@@ -291,12 +317,15 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload: {participants: object}) {
+  locusParticipantsUpdate(payload: {participants: object; isReplace?: boolean}) {
     if (payload) {
+      if (payload.isReplace) {
+        this.clearMembers();
+      }
       const delta = this.handleLocusInfoUpdatedParticipants(payload);
       const full = this.handleMembersUpdate(delta); // SDK should propagate the full list for both delta and non delta updates
 
-      this.receiveSlotManager.updateMemberIds();
+      this.receiveSlotManager?.updateMemberIds();
 
       Trigger.trigger(
         this,
@@ -308,6 +337,7 @@ export default class Members extends StatelessWebexPlugin {
         {
           delta,
           full,
+          isReplace: !!payload.isReplace,
         }
       );
     }
@@ -733,15 +763,22 @@ export default class Members extends StatelessWebexPlugin {
   /**
    * Admits waiting members (invited guests to meeting)
    * @param {Array} memberIds
+   * @param {Object} sessionLocusUrls: {authorizingLocusUrl, mainLocusUrl}
    * @returns {Promise}
    * @public
    * @memberof Members
    */
-  public admitMembers(memberIds: Array<any>) {
+  public admitMembers(
+    memberIds: Array<any>,
+    sessionLocusUrls?: {authorizingLocusUrl: string; mainLocusUrl: string}
+  ) {
     if (isEmpty(memberIds)) {
       return Promise.reject(new ParameterError('No member ids provided to admit.'));
     }
-    const options = MembersUtil.generateAdmitMemberOptions(memberIds, this.locusUrl);
+    const options = {
+      sessionLocusUrls,
+      ...MembersUtil.generateAdmitMemberOptions(memberIds, this.locusUrl),
+    };
 
     return this.membersRequest.admitMember(options);
   }
@@ -773,11 +810,12 @@ export default class Members extends StatelessWebexPlugin {
    * Audio mutes another member in a meeting
    * @param {String} memberId
    * @param {boolean} [mute] default true
+   * @param {boolean} [isAudio] default true
    * @returns {Promise}
    * @public
    * @memberof Members
    */
-  public muteMember(memberId: string, mute = true) {
+  public muteMember(memberId: string, mute = true, isAudio = true) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError(
@@ -790,11 +828,37 @@ export default class Members extends StatelessWebexPlugin {
         new ParameterError('The member id must be defined to mute the member.')
       );
     }
-    const options = MembersUtil.generateMuteMemberOptions(memberId, mute, this.locusUrl);
+    const options = MembersUtil.generateMuteMemberOptions(memberId, mute, this.locusUrl, isAudio);
 
     return this.membersRequest.muteMember(options);
   }
 
+  /**
+   * Assign role(s) to a member in the meeting
+   * @param {String} memberId
+   * @param {[ServerRoleShape]} roles - to assign an array of roles
+   * @returns {Promise}
+   * @public
+   * @memberof Members
+   */
+  public assignRoles(memberId: string, roles: Array<ServerRoleShape>) {
+    if (!this.locusUrl) {
+      return Promise.reject(
+        new ParameterError(
+          'The associated locus url for this meetings members object must be defined.'
+        )
+      );
+    }
+    if (!memberId) {
+      return Promise.reject(
+        new ParameterError('The member id must be defined to assign the roles to a member.')
+      );
+    }
+    const options = MembersUtil.generateRoleAssignmentMemberOptions(memberId, roles, this.locusUrl);
+
+    return this.membersRequest.assignRolesMember(options);
+  }
+
   /**
    * Raise or lower the hand of a member in a meeting
    * @param {String} memberId
@@ -960,4 +1024,39 @@ export default class Members extends StatelessWebexPlugin {
 
     return csis;
   }
+
+  /**
+   * Edit display name of participants in a meeting
+   * @param {string} memberId - id of the participant who is receiving request
+   * @param {string} requestingParticipantId - id of the participant who is sending request (optional)
+   * @param {string} [alias] - alias name
+   * @returns {Promise}
+   * @public
+   * @memberof Members
+   */
+  public editDisplayName(memberId: string, requestingParticipantId: string, alias: string) {
+    if (!this.locusUrl) {
+      return Promise.reject(
+        new ParameterError(
+          'The associated locus url for this meetings members object must be defined.'
+        )
+      );
+    }
+    if (!memberId) {
+      return Promise.reject(
+        new ParameterError('The member id must be defined to edit display name of the member.')
+      );
+    }
+
+    const {locusUrl} = this;
+
+    const options = MembersUtil.generateEditDisplayNameMemberOptions(
+      memberId,
+      requestingParticipantId,
+      alias,
+      locusUrl
+    );
+
+    return this.membersRequest.editDisplayNameMember(options);
+  }
 }

package/src/members/request.ts

@@ -5,12 +5,26 @@ import {MEETINGS} from '../constants';
 import ParameterError from '../common/errors/parameter';
 
 import MembersUtil from './util';
+import MeetingUtil from '../meeting/util';
 
 /**
  * @class MembersRequest
  */
 export default class MembersRequest extends StatelessWebexPlugin {
   namespace = MEETINGS;
+  locusDeltaRequest: (options: object) => Promise<any>;
+
+  /**
+   * Constructor
+   * @param {Object} attrs
+   * @param {Object} options
+   */
+  constructor(attrs: {meeting: any}, options: object) {
+    const {meeting, ...otherAttrs} = attrs;
+    super(otherAttrs, options);
+
+    this.locusDeltaRequest = MeetingUtil.generateLocusDeltaRequest(meeting);
+  }
 
   /**
    *
@@ -36,8 +50,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
     }
     const requestParams = MembersUtil.getAddMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
   /**
@@ -55,10 +68,16 @@ export default class MembersRequest extends StatelessWebexPlugin {
     }
     const requestParams = MembersUtil.getAdmitMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to remove a member
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @returns {Promise}
+   */
   removeMember(options) {
     if (!options || !options.locusUrl || !options.memberId) {
       throw new ParameterError(
@@ -68,10 +87,16 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getRemoveMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to mute a member
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @returns {Promise}
+   */
   muteMember(options) {
     if (!options || !options.locusUrl || !options.memberId) {
       throw new ParameterError(
@@ -82,9 +107,35 @@ export default class MembersRequest extends StatelessWebexPlugin {
     const requestParams = MembersUtil.getMuteMemberRequestParams(options);
 
     // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
+  }
+
+  /**
+   * Sends a request to the DTMF endpoint to send tones
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of PSTN user
+   * @returns {Promise}
+   */
+  assignRolesMember(options: any) {
+    if (!options || !options.locusUrl || !options.memberId) {
+      throw new ParameterError(
+        'memberId must be defined, and the associated locus url for this meeting object must be defined.'
+      );
+    }
+
+    const requestParams = MembersUtil.getRoleAssignmentMemberRequestParams(options);
+
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to raise or lower a member's hand
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @returns {Promise}
+   */
   raiseOrLowerHandMember(options) {
     if (!options || !options.locusUrl || !options.memberId) {
       throw new ParameterError(
@@ -94,10 +145,16 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getRaiseHandMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to lower all hands
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.requestingParticipantId ID of requesting participant
+   * @returns {Promise}
+   */
   lowerAllHandsMember(options) {
     if (!options || !options.locusUrl || !options.requestingParticipantId) {
       throw new ParameterError(
@@ -107,10 +164,36 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getLowerAllHandsMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
+  }
+
+  /**
+   *
+   * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
+   * @returns {Promise}
+   * @throws {Error} if the options are not valid and complete, must have requestingParticipantId AND locusUrl
+   * @memberof MembersRequest
+   */
+  editDisplayNameMember(options: {locusUrl: string; requestingParticipantId: string}) {
+    if (!options || !options.locusUrl || !options.requestingParticipantId) {
+      throw new ParameterError(
+        'requestingParticipantId must be defined, and the associated locus url for this meeting object must be defined.'
+      );
+    }
+
+    const requestParams = MembersUtil.editDisplayNameMemberRequestParams(options);
+
+    return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to raise or lower a member's hand
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.memberId ID of member
+   * @param {String} options.moderator ID of moderator
+   * @returns {Promise}
+   */
   transferHostToMember(options) {
     if (!options || !options.locusUrl || !options.memberId || !options.moderator) {
       throw new ParameterError(
@@ -120,8 +203,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getTransferHostToMemberRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
   /**
@@ -150,8 +232,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.generateSendDTMFRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 
   /**
@@ -169,7 +250,6 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.generateCancelInviteRequestParams(options);
 
-    // @ts-ignore
-    return this.request(requestParams);
+    return this.locusDeltaRequest(requestParams);
   }
 }

package/src/members/types.ts

@@ -0,0 +1,29 @@
+export enum ServerRoles {
+  Cohost = 'COHOST',
+  Moderator = 'MODERATOR',
+  Presenter = 'PRESENTER',
+}
+
+export type ServerRoleShape = {
+  type: ServerRoles;
+  hasRole: boolean;
+  hostKey?: string;
+};
+
+export type RoleAssignmentOptions = {
+  roles: Array<ServerRoleShape>;
+  locusUrl: string;
+  memberId: string;
+};
+
+export type RoleAssignmentBody = {
+  role: {
+    roles: Array<ServerRoleShape>;
+  };
+};
+
+export type RoleAssignmentRequest = {
+  method: string;
+  uri: string;
+  body: RoleAssignmentBody;
+};