@webex/jsdoctrinetest 3.0.0-beta.9 → 3.0.0-bnr.0

package/dist/types/@webex/plugin-meetings/src/members/index.d.ts

@@ -0,0 +1,320 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
+import { MediaRequestManager } from '../multistream/mediaRequestManager';
+/**
+ * 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;
+    /**
+     * 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;
+    }): 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
+     * @returns {Promise}
+     * @public
+     * @memberof Members
+     */
+    admitMembers(memberIds: Array<any>): 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
+     * @returns {Promise}
+     * @public
+     * @memberof Members
+     */
+    muteMember(memberId: string, mute?: boolean): 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[];
+}

package/dist/types/@webex/plugin-meetings/src/members/request.d.ts

@@ -0,0 +1,50 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class MembersRequest
+ */
+export default class MembersRequest extends StatelessWebexPlugin {
+    namespace: string;
+    /**
+     *
+     * @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): 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): any;
+    removeMember(options: any): any;
+    muteMember(options: any): any;
+    raiseOrLowerHandMember(options: any): any;
+    lowerAllHandsMember(options: any): any;
+    transferHostToMember(options: any): 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;
+    }): 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;
+}

package/dist/types/@webex/plugin-meetings/src/members/util.d.ts

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

package/dist/types/@webex/plugin-meetings/src/metrics/config.d.ts

@@ -0,0 +1,178 @@
+export declare const eventType: {
+    MEDIA_QUALITY: string;
+    CALL_INITIATED: string;
+    MERCURY_CONNECTION_LOST: string;
+    MERCURY_CONNECTION_RESTORED: string;
+    MOVE_MEDIA: string;
+    LOCAL_SDP_GENERATED: string;
+    REMOTE_SDP_RECEIVED: string;
+    LOCUS_JOIN_REQUEST: string;
+    LOCUS_JOIN_RESPONSE: string;
+    ALERT_DISPLAYED: string;
+    ICE_START: string;
+    ICE_END: string;
+    ICE_DISCONNECT: string;
+    RECEIVING_MEDIA_START: string;
+    RECEIVING_MEDIA_STOP: string;
+    SENDING_MEDIA_START: string;
+    SENDING_MEDIA_STOP: string;
+    MEDIA_RENDER_START: string;
+    MEDIA_RENDER_STOP: string;
+    MEDIA_CAPABILITIES: string;
+    MEDIA_RECONNECTING: string;
+    MEDIA_RECOVERED: string;
+    CALL_ABORTED: string;
+    PIN_PROMPT: string;
+    PIN_COLLECTED: string;
+    LOBBY_ENTERED: string;
+    LOBBY_EXITED: string;
+    SHARE_INITIATED: string;
+    SHARE_STOPPED: string;
+    LOCAL_SHARE_FLOOR_GRANTED: string;
+    SHARE_LAYOUT_DISPLAYED: string;
+    WHITEBOARD_SHARE_INITIATED: string;
+    WHITEBOARD_SHARE_STOPPED: string;
+    WHITEBOARD_SHARE_FLOOR_GRANTED: string;
+    MUTED: string;
+    UNMUTED: string;
+    LEAVE: string;
+    REMOTE_ENDED: string;
+    REMOTE_STARTED: string;
+    MEDIA_REQUEST: string;
+    MEDIA_RESPONSE: string;
+    PSTN_AUDIO_ATTEMPT_START: string;
+    PSTN_AUDIO_ATTEMPT_FINISH: string;
+    PSTN_AUDIO_ATTEMPT_SKIP: string;
+};
+export declare const error: {
+    name: {
+        MEDIA_ENGINE: string;
+        ICE_FAILED: string;
+        LOCUS_RESPONSE: string;
+        LOCUS_LEAVE: string;
+        OTHER: string;
+    };
+    notFatalErrorList: number[];
+    errors: {
+        1000: string[];
+        1001: string[];
+        1002: string[];
+        1003: string[];
+        1004: string[];
+        1005: string[];
+        1006: string[];
+        1007: string[];
+        2001: string[];
+        2002: string[];
+        2003: string[];
+        2004: string[];
+        2005: string[];
+        2006: string[];
+        3001: string[];
+        3002: string[];
+        3004: string[];
+        3005: string[];
+        3006: string[];
+        3007: string[];
+        4001: string[];
+        4002: string[];
+        4003: string[];
+        4004: string[];
+        4005: string[];
+        4006: string[];
+        4007: string[];
+        4008: string[];
+        4009: string[];
+        4010: string[];
+        4011: string[];
+        4012: string[];
+        4013: string[];
+        4014: string[];
+        4015: string[];
+        4016: string[];
+        4017: string[];
+        4018: string[];
+        4019: string[];
+        4020: string[];
+        4021: string[];
+        4022: string[];
+        4023: string[];
+        4024: string[];
+        4025: string[];
+        4026: string[];
+        4027: string[];
+        4028: string[];
+        4029: string[];
+        4030: string[];
+        5000: string[];
+        5001: string[];
+    };
+};
+export declare const trigger: {
+    USER_INTERACTION: string;
+    MERCURY_EVENT: string;
+    LOCI_UPDATE: string;
+    MEDIA_ENGINE_EVENT: string;
+    TIMEOUT: string;
+    SIGNALING: string;
+    OTHER: string;
+};
+export declare const pstnAudioType: {
+    DIAL_IN: string;
+    DIAL_OUT: string;
+};
+export declare const displayLocation: {
+    TOAST: string;
+    ROOM_LIST: string;
+    CALL_PANE: string;
+    CALL_VIEW: string;
+    OTHER: string;
+};
+export declare const mediaType: {
+    AUDIO: string;
+    VIDEO: string;
+    SHARE: string;
+    WHITEBOARD: string;
+};
+export declare const reconnection: {
+    RECOVERED_BY_NEW: string;
+    RECOVERED_BY_RETRY: string;
+};
+export declare const errorCodes: {
+    USER_CREATE_FAILED: number;
+    USER_ALREADY_PARTICIPANT: number;
+    CONVO_ALREADY_EXISTS: number;
+    ALREADY_ANNOUNCEMENT_SPACE: number;
+    NOT_ANNOUNCEMENT_SPACE: number;
+    USER_NOT_MODERATOR_IN_ANNOUNCEMENT_SPACE: number;
+    TEMP_ID_ALREADY_EXISTS: number;
+    PARENT_ACTIVITY_ID_NOT_FOUND_OR_INVALID: number;
+};
+export declare const statusCodes: {
+    NETWORK_OR_CORS: number;
+    BAD_REQUEST: number;
+    FORBIDDEN: number;
+    NOT_FOUND: number;
+    CONFLICT: number;
+};
+export declare const errorObjects: {
+    category: {
+        media: string;
+        expected: string;
+    };
+    name: {
+        mediaEngine: string;
+    };
+};
+export declare const UNKNOWN = "unknown";
+export declare const OS_NAME: {
+    WINDOWS: string;
+    MAC: string;
+    IOS: string;
+    ANDROID: string;
+    CHROME: string;
+    LINUX: string;
+    OTHERS: string;
+};
+export declare const CLIENT_NAME = "webex-js-sdk";
+export declare const PLATFORM = "Web";

package/dist/types/@webex/plugin-meetings/src/metrics/constants.d.ts

@@ -0,0 +1,57 @@
+declare const BEHAVIORAL_METRICS: {
+    MEETINGS_REGISTRATION_FAILED: string;
+    MEETINGS_REGISTRATION_SUCCESS: string;
+    MERCURY_CONNECTION_FAILURE: string;
+    MERCURY_CONNECTION_RESTORED: string;
+    JOIN_SUCCESS: string;
+    JOIN_FAILURE: string;
+    ADD_MEDIA_SUCCESS: string;
+    ADD_MEDIA_FAILURE: string;
+    CONNECTION_SUCCESS: string;
+    CONNECTION_FAILURE: string;
+    MEETING_LEAVE_FAILURE: string;
+    MEETING_END_ALL_FAILURE: string;
+    MEETING_END_ALL_INITIATED: string;
+    GET_USER_MEDIA_FAILURE: string;
+    GET_DISPLAY_MEDIA_FAILURE: string;
+    JOIN_WITH_MEDIA_FAILURE: string;
+    DISCONNECT_DUE_TO_INACTIVITY: string;
+    MEETING_MEDIA_INACTIVE: string;
+    MEETING_RECONNECT_FAILURE: string;
+    MEETING_MAX_REJOIN_FAILURE: string;
+    MEETING_SHARE_FAILURE: string;
+    MEETING_START_WHITEBOARD_SHARE_FAILURE: string;
+    MEETING_STOP_WHITEBOARD_SHARE_FAILURE: string;
+    MUTE_AUDIO_FAILURE: string;
+    MUTE_VIDEO_FAILURE: string;
+    SET_MEETING_QUALITY_FAILURE: string;
+    STOP_FLOOR_REQUEST_FAILURE: string;
+    ADD_DIAL_IN_FAILURE: string;
+    ADD_DIAL_OUT_FAILURE: string;
+    UPDATE_MEDIA_FAILURE: string;
+    UNMUTE_AUDIO_FAILURE: string;
+    UNMUTE_VIDEO_FAILURE: string;
+    ROAP_ANSWER_FAILURE: string;
+    ROAP_GLARE_CONDITION: string;
+    PEERCONNECTION_FAILURE: string;
+    INVALID_ICE_CANDIDATE: string;
+    UPLOAD_LOGS_FAILURE: string;
+    RECEIVE_TRANSCRIPTION_FAILURE: string;
+    ENABLE_BNR_SUCCESS: string;
+    ENABLE_BNR_FAILURE: string;
+    DISABLE_BNR_SUCCESS: string;
+    DISABLE_BNR_FAILURE: string;
+    FETCH_MEETING_INFO_V1_SUCCESS: string;
+    FETCH_MEETING_INFO_V1_FAILURE: string;
+    ADHOC_MEETING_SUCCESS: string;
+    ADHOC_MEETING_FAILURE: string;
+    VERIFY_PASSWORD_SUCCESS: string;
+    VERIFY_PASSWORD_ERROR: string;
+    VERIFY_CAPTCHA_ERROR: string;
+    MOVE_TO_SUCCESS: string;
+    MOVE_TO_FAILURE: string;
+    MOVE_FROM_SUCCESS: string;
+    MOVE_FROM_FAILURE: string;
+    TURN_DISCOVERY_FAILURE: string;
+};
+export { BEHAVIORAL_METRICS as default };