@webex/plugin-meetings 3.0.0-beta.24 → 3.0.0-beta.241

package/dist/types/meetings/index.d.ts

@@ -1,7 +1,10 @@
 import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
+import '@webex/internal-plugin-metrics';
 import { WebexPlugin } from '@webex/webex-core';
 import 'webrtc-adapter';
+import Reachability from '../reachability';
+import { INoiseReductionEffect, IVirtualBackgroundEffect } from './meetings.types';
 /**
  * Meetings Ready Event
  * Emitted when the meetings instance on webex is ready
@@ -55,11 +58,13 @@ export default class Meetings extends WebexPlugin {
     meetingCollection: any;
     personalMeetingRoom: any;
     preferredWebexSite: any;
-    reachability: any;
+    reachability: Reachability;
     registered: any;
     request: any;
     geoHintInfo: any;
     meetingInfo: any;
+    mediaHelpers: any;
+    breakoutLocusForHandleLater: any;
     namespace: string;
     /**
      * Initializes the Meetings Plugin
@@ -68,6 +73,34 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     constructor(...args: any[]);
+    /**
+     * check whether you need to handle this main session's locus data or not
+     * @param {Object} meeting current meeting data
+     * @param {Object} newLocus new locus data
+     * @returns {boolean}
+     * @private
+     * @memberof Meetings
+     */
+    private isNeedHandleMainLocus;
+    /**
+     * check whether you need to handle this locus data or not
+     * @param {Object} meeting old locus data
+     * @param {Object} newLocus new locus data
+     * @returns {boolean}
+     * @private
+     * @memberof Meetings
+     */
+    private isNeedHandleLocusDTO;
+    /**
+     * get corresponding meeting object by locus data
+     * @param {Object} data a locus event
+     * @param {String} data.locusUrl
+     * @param {Object} data.locus
+     * @returns {Object}
+     * @private
+     * @memberof Meetings
+     */
+    getCorrespondingMeetingByLocus(data: any): any;
     /**
      * handle locus events and takes meeting actions with them as they come in
      * @param {Object} data a locus event
@@ -159,6 +192,24 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     unregister(): any;
+    /**
+     * Creates a noise reduction effect
+     *
+     * @param {INoiseReductionEffect} options optional custom effect options
+     * @returns {Promise<effect>} noise reduction effect.
+     * @public
+     * @memberof Meetings
+     */
+    createNoiseReductionEffect: (options?: INoiseReductionEffect) => Promise<any>;
+    /**
+     * Creates a virtual background effect
+     *
+     * @param {IVirtualBackgroundEffect} options optional custom effect options
+     * @returns {Promise<effect>} virtual background effect.
+     * @public
+     * @memberof Meetings
+     */
+    createVirtualBackgroundEffect: (options?: IVirtualBackgroundEffect) => Promise<any>;
     /**
      * Uploads logs to the webex services for tracking
      * @param {Object} [options={}]
@@ -180,27 +231,20 @@ export default class Meetings extends WebexPlugin {
         userId?: string;
         orgId?: string;
     }): any;
-    /**
-     * initializes the reachability instance for Meetings
-     * @returns {undefined}
-     * @public
-     * @memberof Meetings
-     */
-    setReachability(): void;
     /**
      * gets the reachability instance for Meetings
      * @returns {Reachability}
      * @public
      * @memberof Meetings
      */
-    getReachability(): any;
+    getReachability(): Reachability;
     /**
      * initializes and starts gathering reachability for Meetings
      * @returns {Promise}
      * @public
      * @memberof Meetings
      */
-    startReachability(): any;
+    startReachability(): Promise<unknown>;
     /**
      * Get geoHint for info for meetings
      * @returns {Promise}
@@ -234,18 +278,22 @@ export default class Meetings extends WebexPlugin {
     private destroy;
     /**
      * Create a meeting.
-     * @param {string} destination - sipURL, spaceId, phonenumber, or locus object}
+     * @param {string} destination - sipURL, 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
+     * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
+     * @param {string} correlationId - the optional specified correlationId
      * @returns {Promise<Meeting>} A new Meeting.
      * @public
      * @memberof Meetings
      */
-    create(destination: string, type?: string, useRandomDelayForInfo?: boolean): any;
+    create(destination: string, type?: string, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string): any;
     /**
      * @param {String} destination see create()
      * @param {String} type see create()
      * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
+     * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
+     * @param {String} correlationId the optional specified correlationId
      * @returns {Promise} a new meeting instance complete with meeting info and destination
      * @private
      * @memberof Meetings
@@ -280,6 +328,22 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     syncMeetings(): any;
+    /**
+     * sort out locus array for initial creating
+     * @param {Array} loci original locus array
+     * @returns {undefined}
+     * @public
+     * @memberof Meetings
+     */
+    sortLocusArrayToUpdate(loci: any[]): any[];
+    /**
+     * check breakout locus which waiting for main locus's meeting to be created, then handle the breakout locus
+     * @param {Object} newCreatedLocus the locus which just create meeting object of it
+     * @returns {undefined}
+     * @public
+     * @memberof Meetings
+     */
+    checkHandleBreakoutLocus(newCreatedLocus: any): void;
     /**
      * Get all scheduled meetings.
      * @param {object} options

package/dist/types/meetings/meetings.types.d.ts

@@ -0,0 +1,4 @@
+import type { NoiseReductionEffectOptions, VirtualBackgroundEffectOptions } from '@webex/media-helpers';
+type INoiseReductionEffect = Omit<NoiseReductionEffectOptions, 'authToken' | 'workletProcessorUrl' | 'legacyProcessorUrl'>;
+type IVirtualBackgroundEffect = Omit<VirtualBackgroundEffectOptions, 'authToken'>;
+export type { INoiseReductionEffect, IVirtualBackgroundEffect };

package/dist/types/member/index.d.ts

@@ -1,3 +1,4 @@
+import { IExternalRoles, IMediaStatus } from './types';
 /**
  * @class Member
  */
@@ -21,10 +22,14 @@ export default class Member {
     isSelf: any;
     isUser: any;
     isVideoMuted: any;
+    roles: IExternalRoles;
+    mediaStatus: IMediaStatus;
     name: any;
     participant: any;
     status: any;
     supportsBreakouts: boolean;
+    supportsInterpretation: boolean;
+    supportLiveAnnotation: boolean;
     type: any;
     namespace: string;
     /**
@@ -135,6 +140,14 @@ export default class Member {
      * @memberof Member
      */
     private processIsHost;
+    /**
+     * process the roles that have been applied to this member
+     * @param {Object} participant
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processRoles;
     /**
      * set the type for the member, could be MEETING or CALL
      * @param {String} type

package/dist/types/member/types.d.ts

@@ -0,0 +1,32 @@
+export interface IExternalRoles {
+    cohost: boolean;
+    moderator: boolean;
+    presenter: boolean;
+}
+export declare enum ServerRoles {
+    Cohost = "COHOST",
+    Moderator = "MODERATOR",
+    Presenter = "PRESENTER"
+}
+export type ServerRoleShape = {
+    type: ServerRoles;
+    hasRole: boolean;
+};
+export type ParticipantWithRoles = {
+    controls: {
+        role: {
+            roles: Array<ServerRoleShape>;
+        };
+    };
+};
+export declare enum MediaStatus {
+    RECVONLY = "RECVONLY",
+    SENDONLY = "SENDONLY",
+    SENDRECV = "SENDRECV",
+    INACTIVE = "INACTIVE",
+    UNKNOWN = "UNKNOWN"
+}
+export interface IMediaStatus {
+    audio: MediaStatus;
+    video: MediaStatus;
+}

package/dist/types/members/collection.d.ts

@@ -21,4 +21,9 @@ export default class MembersCollection {
      * @memberof MembersCollection
      */
     getAll(): any;
+    /**
+     * @returns {void}
+     * reset members
+     */
+    reset(): void;
 }

package/dist/types/members/index.d.ts

@@ -1,6 +1,7 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
+import { ServerRoleShape } from './types';
 /**
  * Members Update Event
  * Emitted when something in the roster list needs to be updated
@@ -91,6 +92,13 @@ export default class Members extends StatelessWebexPlugin {
         newHost: any;
         oldHost: any;
     }): void;
+    /**
+     * clear member collection
+     * @returns {void}
+     * @private
+     * @memberof Members
+     */
+    clearMembers(): void;
     /**
      * 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
@@ -102,6 +110,7 @@ export default class Members extends StatelessWebexPlugin {
      */
     locusParticipantsUpdate(payload: {
         participants: object;
+        isReplace?: boolean;
     }): void;
     /**
      * Internal update the content id
@@ -245,11 +254,15 @@ 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
      */
-    admitMembers(memberIds: Array<any>): any;
+    admitMembers(memberIds: Array<any>, sessionLocusUrls?: {
+        authorizingLocusUrl: string;
+        mainLocusUrl: string;
+    }): any;
     /**
      * Removes a member from the meeting
      * @param {String} memberId
@@ -262,11 +275,21 @@ 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
      */
-    muteMember(memberId: string, mute?: boolean): any;
+    muteMember(memberId: string, mute?: boolean, isAudio?: boolean): any;
+    /**
+     * 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
+     */
+    assignRoles(memberId: string, roles: Array<ServerRoleShape>): any;
     /**
      * Raise or lower the hand of a member in a meeting
      * @param {String} memberId
@@ -317,4 +340,14 @@ export default class Members extends StatelessWebexPlugin {
      * @returns {Member}
      */
     getCsisForMember(memberId: any, mediaType?: string, mediaContent?: string): any[];
+    /**
+     * 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
+     */
+    editDisplayName(memberId: string, requestingParticipantId: string, alias: string): any;
 }

package/dist/types/members/request.d.ts

@@ -4,6 +4,15 @@ import { StatelessWebexPlugin } from '@webex/webex-core';
  */
 export default class MembersRequest extends StatelessWebexPlugin {
     namespace: string;
+    locusDeltaRequest: (options: object) => Promise<any>;
+    /**
+     * Constructor
+     * @param {Object} attrs
+     * @param {Object} options
+     */
+    constructor(attrs: {
+        meeting: any;
+    }, options: object);
     /**
      *
      * @param {Object} options with format of {invitee: string, locusUrl: string}
@@ -11,7 +20,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
      * @memberof MembersRequest
      */
-    addMembers(options: any): any;
+    addMembers(options: any): Promise<any>;
     /**
      *
      * @param {Object} options
@@ -19,12 +28,67 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @throws {Error} if the options are not valid and complete, must have memberIds AND locusUrl
      * @memberof MembersRequest
      */
-    admitMember(options: any): any;
-    removeMember(options: any): any;
-    muteMember(options: any): any;
-    raiseOrLowerHandMember(options: any): any;
-    lowerAllHandsMember(options: any): any;
-    transferHostToMember(options: any): any;
+    admitMember(options: any): Promise<any>;
+    /**
+     * 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: any): Promise<any>;
+    /**
+     * 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: any): Promise<any>;
+    /**
+     * 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): Promise<any>;
+    /**
+     * 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: any): Promise<any>;
+    /**
+     * 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: any): Promise<any>;
+    /**
+     *
+     * @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;
+    }): Promise<any>;
+    /**
+     * 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: any): Promise<any>;
     /**
      * Sends a request to the DTMF endpoint to send tones
      * @param {Object} options
@@ -39,12 +103,12 @@ export default class MembersRequest extends StatelessWebexPlugin {
         url: string;
         tones: string;
         memberId: string;
-    }): any;
+    }): Promise<any>;
     /**
      * @param {Object} options with format of {invitee: string, locusUrl: string}
      * @returns {Promise}
      * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
      * @memberof MembersRequest
      */
-    cancelPhoneInvite(options: any): any;
+    cancelPhoneInvite(options: any): Promise<any>;
 }

package/dist/types/members/types.d.ts

@@ -0,0 +1,24 @@
+export declare enum ServerRoles {
+    Cohost = "COHOST",
+    Moderator = "MODERATOR",
+    Presenter = "PRESENTER"
+}
+export type ServerRoleShape = {
+    type: ServerRoles;
+    hasRole: boolean;
+};
+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;
+};

package/dist/types/members/util.d.ts

@@ -1,2 +1,210 @@
-declare const MembersUtil: any;
+import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
+declare const MembersUtil: {
+    /**
+     * @param {Object} invitee with emailAddress, email or phoneNumber
+     * @param {String} locusUrl
+     * @param {Boolean} alertIfActive
+     * @returns {Object} the format object
+     */
+    generateAddMemberOptions: (invitee: object, locusUrl: string, alertIfActive: boolean) => {
+        invitee: object;
+        locusUrl: string;
+        alertIfActive: boolean;
+    };
+    /**
+     * @param {Array} memberIds
+     * @param {String} locusUrl
+     * @returns {Object} the format object
+     */
+    generateAdmitMemberOptions: (memberIds: Array<any>, locusUrl: string) => {
+        locusUrl: string;
+        memberIds: any[];
+    };
+    /**
+     * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
+     * @returns {Object} with {invitees: [{address}], alertIfActive}
+     */
+    getAddMemberBody: (options: any) => {
+        invitees: {
+            address: any;
+        }[];
+        alertIfActive: any;
+    };
+    /**
+     * @param {Object} options with {memberIds, authorizingLocusUrl}
+     * @returns {Object} admit with {memberIds}
+     */
+    getAdmitMemberRequestBody: (options: any) => any;
+    /**
+     * @param {Object} format with {memberIds, locusUrl, sessionLocusUrls}
+     * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
+     * if a host/cohost is in a breakout session, the locus url should be the main session locus url
+     */
+    getAdmitMemberRequestParams: (format: any) => {
+        method: string;
+        uri: string;
+        body: any;
+    };
+    /**
+     * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
+     * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
+     */
+    getAddMemberRequestParams: (format: any) => {
+        method: string;
+        uri: any;
+        body: {
+            invitees: {
+                address: any;
+            }[];
+            alertIfActive: any;
+        };
+    };
+    isInvalidInvitee: (invitee: any) => boolean;
+    getRemoveMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            reason: any;
+        };
+    };
+    generateTransferHostMemberOptions: (transfer: any, moderator: any, locusUrl: any) => {
+        moderator: any;
+        locusUrl: any;
+        memberId: any;
+    };
+    generateRemoveMemberOptions: (removal: any, locusUrl: any) => {
+        reason: string;
+        memberId: any;
+        locusUrl: any;
+    };
+    generateMuteMemberOptions: (memberId: any, status: any, locusUrl: any, isAudio: any) => {
+        memberId: any;
+        muted: any;
+        locusUrl: any;
+        isAudio: any;
+    };
+    generateRaiseHandMemberOptions: (memberId: any, status: any, locusUrl: any) => {
+        memberId: any;
+        raised: any;
+        locusUrl: any;
+    };
+    /**
+     * @param {String} memberId
+     * @param {[ServerRoleShape]} roles
+     * @param {String} locusUrl
+     * @returns {RoleAssignmentOptions}
+     */
+    generateRoleAssignmentMemberOptions: (memberId: string, roles: Array<ServerRoleShape>, locusUrl: string) => RoleAssignmentOptions;
+    generateLowerAllHandsMemberOptions: (requestingParticipantId: any, locusUrl: any) => {
+        requestingParticipantId: any;
+        locusUrl: any;
+    };
+    /**
+     * @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
+     * @param {String} locusUrl url
+     * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
+     */
+    generateEditDisplayNameMemberOptions: (memberId: any, requestingParticipantId: any, alias: any, locusUrl: any) => {
+        memberId: any;
+        requestingParticipantId: any;
+        alias: any;
+        locusUrl: any;
+    };
+    getMuteMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            [x: string]: {
+                muted: any;
+            };
+        };
+    };
+    /**
+     * @param {RoleAssignmentOptions} options
+     * @returns {RoleAssignmentRequest} the request parameters (method, uri, body) needed to make a addMember request
+     */
+    getRoleAssignmentMemberRequestParams: (options: RoleAssignmentOptions) => RoleAssignmentRequest;
+    getRaiseHandMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            hand: {
+                raised: any;
+            };
+        };
+    };
+    getLowerAllHandsMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            hand: {
+                raised: boolean;
+            };
+            requestingParticipantId: any;
+        };
+    };
+    /**
+     * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
+     * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
+     */
+    editDisplayNameMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            aliasValue: any;
+            requestingParticipantId: any;
+        };
+    };
+    getTransferHostToMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            role: {
+                moderator: any;
+            };
+        };
+    };
+    genderateSendDTMFOptions: (url: any, tones: any, memberId: any, locusUrl: any) => {
+        url: any;
+        tones: any;
+        memberId: any;
+        locusUrl: any;
+    };
+    generateSendDTMFRequestParams: ({ url, tones, memberId, locusUrl }: {
+        url: any;
+        tones: any;
+        memberId: any;
+        locusUrl: any;
+    }) => {
+        method: string;
+        uri: string;
+        body: {
+            device: {
+                url: any;
+            };
+            memberId: any;
+            dtmf: {
+                correlationId: any;
+                tones: any;
+                direction: string;
+            };
+        };
+    };
+    cancelPhoneInviteOptions: (invitee: any, locusUrl: any) => {
+        invitee: any;
+        locusUrl: any;
+    };
+    generateCancelInviteRequestParams: (options: any) => {
+        method: string;
+        uri: any;
+        body: {
+            actionType: string;
+            invitees: {
+                address: any;
+            }[];
+        };
+    };
+};
 export default MembersUtil;