@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.200

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

@@ -0,0 +1,159 @@
+import { IExternalRoles, IMediaStatus } from './types';
+/**
+ * @class Member
+ */
+export default class Member {
+    associatedUser: any;
+    id: any;
+    isAudioMuted: any;
+    isContentSharing: any;
+    isDevice: any;
+    isGuest: any;
+    isHandRaised: any;
+    isHost: any;
+    isInLobby: any;
+    isInMeeting: any;
+    isModerator: any;
+    isModeratorAssignmentProhibited: any;
+    isMutable: any;
+    isNotAdmitted: any;
+    isRecording: any;
+    isRemovable: any;
+    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;
+    /**
+     * @param {Object} participant - the locus participant
+     * @param {Object} [options] - constructor params
+     * @param {String} options.selfId
+     * @param {String} options.hostId
+     * @param {String} options.contentSharingId
+     * @param {String} options.type
+     * @returns {Member}
+     * @memberof Member
+     */
+    constructor(participant: object, options?: {
+        selfId: string;
+        hostId: string;
+        contentSharingId: string;
+        type: string;
+    } | any);
+    /**
+     * set all the participant values extracted directly from locus participant
+     * @param {Object} participant the locus participant object
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processParticipant;
+    /**
+     * Use the members options and participant values to set on the member
+     * @param {Object} participant the locus participant object
+     * @param {Object} options the passed in options, what was set on members
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processParticipantOptions;
+    /**
+     * processes what already exists on the member to determine other info about the member
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processMember;
+    /**
+     * set the status on member object
+     * @param {Object} participant the locus participant object
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processStatus;
+    /**
+     * set the isContentSharing on member
+     * @param {Boolean} flag
+     * @returns {undefined}
+     * @public
+     * @memberof Member
+     */
+    setIsContentSharing(flag: boolean): void;
+    /**
+     * set the isHost on member
+     * @param {Boolean} flag
+     * @returns {undefined}
+     * @public
+     * @memberof Member
+     */
+    setIsHost(flag: boolean): void;
+    /**
+     * set the isSelf on member
+     * @param {Boolean} flag
+     * @returns {undefined}
+     * @public
+     * @memberof Member
+     */
+    setIsSelf(flag: boolean): void;
+    /**
+     * determine if this member is content sharing
+     * @param {Object} participant
+     * @param {String} sharingId
+     * @returns {undefined}
+     * @public
+     * @memberof Member
+     */
+    processIsContentSharing(participant: object, sharingId: string): void;
+    /**
+     * Determine if this member is recording
+     * @param {Object} participant
+     * @param {String} recordingId
+     * @returns {undefined}
+     * @public
+     * @memberof Member
+     */
+    processIsRecording(participant: object, recordingId: string): void;
+    /**
+     * determine if this member is the self
+     * @param {Object} participant
+     * @param {String} selfId
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processIsSelf;
+    /**
+     * determine if this member is the host
+     * @param {Object} participant
+     * @param {String} hostId
+     * @returns {undefined}
+     * @private
+     * @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
+     * @returns {undefined}
+     * @private
+     * @memberof Member
+     */
+    private processType;
+}

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/member/util.d.ts

@@ -0,0 +1,2 @@
+declare const MemberUtil: any;
+export default MemberUtil;

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

@@ -0,0 +1,29 @@
+/**
+ * @class MembersCollection
+ */
+export default class MembersCollection {
+    members: any;
+    namespace: string;
+    /**
+     * @param {Object} locus
+     * @memberof Members
+     */
+    constructor();
+    set(id: any, member: any): void;
+    setAll(members: any): void;
+    /**
+     * @param {String} id
+     * @returns {Member}
+     */
+    get(id: string): any;
+    /**
+     * @returns {Object} returns an object map of Member instances
+     * @memberof MembersCollection
+     */
+    getAll(): any;
+    /**
+     * @returns {void}
+     * reset members
+     */
+    reset(): void;
+}

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

@@ -0,0 +1,353 @@
+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
+ * @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 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
+ */
+/**
+ * @class Members
+ */
+export default class Members extends StatelessWebexPlugin {
+    hostId: any;
+    locusUrl: any;
+    mediaShareContentId: any;
+    mediaShareWhiteboardId: any;
+    membersCollection: any;
+    membersRequest: any;
+    receiveSlotManager: ReceiveSlotManager;
+    mediaRequestManagers: {
+        audio: MediaRequestManager;
+        video: MediaRequestManager;
+    };
+    recordingId: any;
+    selfId: any;
+    type: any;
+    namespace: string;
+    /**
+     *
+     * @param {Object} attrs
+     * @param {Object} options
+     * @memberof Members
+     */
+    constructor(attrs: any, options: object);
+    /**
+     * Internal update the self Id value
+     * @param {Object} payload
+     * @param {Object} payload.newSelf
+     * @param {Object} payload.oldSelf
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    locusSelfUpdate(payload: {
+        newSelf: any;
+        oldSelf: any;
+    }): void;
+    /**
+     * Internal update the hostId value
+     * @param {Object} payload
+     * @param {Object} payload.newHost
+     * @param {Object} payload.oldHost
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    locusHostUpdate(payload: {
+        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
+     * @param {Object} payload
+     * @param {Object} payload.participants
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    locusParticipantsUpdate(payload: {
+        participants: object;
+        isReplace?: boolean;
+    }): void;
+    /**
+     * Internal update the content id
+     * @param {Object} payload
+     * @param {Object} payload.current
+     * @param {Object} payload.previous
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    locusMediaSharesUpdate(payload: {
+        current: any;
+        previous: any;
+    }): void;
+    /**
+     * Internal update the locus url value
+     * @param {Object} payload
+     * @param {String} payload.locusUrl
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    locusUrlUpdate(payload: any): void;
+    /**
+     * Internal update the type of meeting
+     * @param {Object} payload
+     * @param {String} payload.type
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    locusFullStateTypeUpdate(payload: {
+        type: string;
+    }): void;
+    /**
+     * sets values in the members collection for updated and added properties from delta
+     * @param {Object} membersUpdate {updated: [], added: []}
+     * @returns {Object} membersCollection
+     * @private
+     * @memberof Members
+     */
+    private handleMembersUpdate;
+    /**
+     * set members to the member collection from each updated/added lists as passed in
+     * @param {Array} list
+     * @returns {undefined}
+     * @private
+     * @memberof Members
+     */
+    private constructMembers;
+    /**
+     * Internal update the participants value
+     * @param {Object} payload
+     * @returns {Object}
+     * @private
+     * @memberof Members
+     */
+    private handleLocusInfoUpdatedParticipants;
+    /**
+     * Update the locus Url
+     * @param {Object} locus
+     * @param {String} [locusUrl] optional, takes precedence
+     * @throws {ParameterError}
+     * @returns {undefined}
+     * @public
+     * @memberof Members
+     */
+    setLocusUrl(locus: any, locusUrl?: string): void;
+    /**
+     * Update the host id
+     * @param {Object} locus
+     * @param {String} [hostId] optional, takes precedence
+     * @throws {ParameterError}
+     * @returns {undefined}
+     * @public
+     * @memberof Members
+     */
+    setHostId(locus: any, hostId?: string): void;
+    /**
+     * Update the type
+     * @param {Object} fullState
+     * @param {String} [type] optional, takes precedence
+     * @throws {ParameterError}
+     * @returns {undefined}
+     * @public
+     * @memberof Members
+     */
+    setType(fullState: any, type?: string): void;
+    /**
+     * Update the self Id
+     * @param {Object} locus
+     * @param {String} [selfId] optional, takes precedence
+     * @throws {Error}
+     * @returns {undefined}
+     * @memberof Members
+     */
+    setSelfId(locus: any, selfId?: string): void;
+    /**
+     * Update the media share content id
+     * @param {Object} locus
+     * @param {String} [contentId] optional, takes precedence
+     * @throws {Error}
+     * @returns {undefined}
+     * @memberof Members
+     */
+    setMediaShareContentId(locus: any, contentId?: string): void;
+    /**
+     * Update the media share whiteboard id
+     * @param {Object} locus
+     * @param {String} [whiteboardId] optional, takes precedence
+     * @throws {Error}
+     * @returns {undefined}
+     * @memberof Members
+     */
+    setMediaShareWhiteboardId(locus: any, whiteboardId?: string): void;
+    /**
+     * 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
+     */
+    private update;
+    /**
+     * Adds a guest Member to the associated meeting
+     * @param {String} invitee
+     * @param {Boolean} [alertIfActive]
+     * @returns {Promise}
+     * @memberof Members
+     */
+    addMember(invitee: any, alertIfActive?: boolean): any;
+    /**
+     * Cancels an outgoing PSTN call to the associated meeting
+     * @param {String} invitee
+     * @returns {Promise}
+     * @memberof Members
+     */
+    cancelPhoneInvite(invitee: any): any;
+    /**
+     * Admits waiting members (invited guests to meeting)
+     * @param {Array} memberIds
+     * @param {Object} sessionLocusUrls: {authorizingLocusUrl, mainLocusUrl}
+     * @returns {Promise}
+     * @public
+     * @memberof Members
+     */
+    admitMembers(memberIds: Array<any>, sessionLocusUrls?: {
+        authorizingLocusUrl: string;
+        mainLocusUrl: string;
+    }): any;
+    /**
+     * Removes a member from the meeting
+     * @param {String} memberId
+     * @returns {Promise}
+     * @public
+     * @memberof Members
+     */
+    removeMember(memberId: string): any;
+    /**
+     * 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, 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
+     * @param {boolean} [raise] - to raise hand (=true) or lower (=false), default: true
+     * @returns {Promise}
+     * @public
+     * @memberof Members
+     */
+    raiseOrLowerHand(memberId: string, raise?: boolean): any;
+    /**
+     * 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
+     */
+    lowerAllHands(requestingMemberId: string): any;
+    /**
+     * Transfers the host to another member
+     * @param {String} memberId
+     * @param {boolean} [moderator] default true
+     * @returns {Promise}
+     * @public
+     * @memberof Members
+     */
+    transferHostToMember(memberId: string, moderator?: boolean): any;
+    /**
+     * 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
+     */
+    sendDialPadKey(tones?: string, memberId?: string): any;
+    /** Finds a member that has any device with a csi matching provided value
+     *
+     * @param {number} csi
+     * @returns {Member}
+     */
+    findMemberByCsi(csi: any): unknown;
+    /**
+     * Returns an array of a member's CSIs matching the mediaType and mediaContent
+     *
+     * @param {string} memberId
+     * @param {string} mediaType 'audio' or 'video'
+     * @param {string} mediaContent 'main' or 'slides'
+     * @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

@@ -0,0 +1,114 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class MembersRequest
+ */
+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}
+     * @returns {Promise}
+     * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
+     * @memberof MembersRequest
+     */
+    addMembers(options: any): Promise<any>;
+    /**
+     *
+     * @param {Object} options
+     * @returns {Promise}
+     * @throws {Error} if the options are not valid and complete, must have memberIds AND locusUrl
+     * @memberof MembersRequest
+     */
+    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
+     * @param {String} options.locusUrl
+     * @param {String} options.url device url SIP user
+     * @param {String} options.tones a string of one or more DTMF tones to send
+     * @param {String} options.memberId ID of PSTN user
+     * @returns {Promise}
+     */
+    sendDialPadKey(options: {
+        locusUrl: string;
+        url: string;
+        tones: string;
+        memberId: string;
+    }): 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): Promise<any>;
+}