@webex/plugin-meetings 3.7.0-wxcc.1 → 3.8.0

package/dist/meeting/request.d.ts

@@ -0,0 +1,295 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
+import { SendReactionOptions, ToggleReactionsOptions } from './request.type';
+import { AnnotationInfo } from '../annotation/annotation.types';
+/**
+ * @class MeetingRequest
+ */
+export default class MeetingRequest extends StatelessWebexPlugin {
+    changeVideoLayoutDebounced: any;
+    meetingRef: WeakRef<any>;
+    locusDeltaRequest: (options: object) => Promise<any>;
+    buildLocusDeltaRequestOptions: (options: object) => Promise<any>;
+    /**
+     * Constructor
+     * @param {Object} attrs
+     * @param {Object} options
+     */
+    constructor(attrs: any, options: any);
+    /**
+     * Returns joinCookie from boundedStorage if present.
+     * @returns {Object} joinCookie
+     */
+    private getJoinCookie;
+    /**
+     * Make a network request to join a meeting
+     * @param {Object} options
+     * @param {String} options.sipUri
+     * @param {String} options.deviceUrl
+     * @param {String} options.locusUrl
+     * @param {String} options.resourceId,
+     * @param {String} options.correlationId
+     * @param {boolean} options.ensureConversation
+     * @param {boolean} options.moderator
+     * @param {boolean} options.pin
+     * @param {boolean} options.moveToResource
+     * @param {Object} options.roapMessage
+     * @param {boolean} options.breakoutsSupported
+     * @param {String} options.locale,
+     * @param {Array} options.deviceCapabilities
+     * @param {boolean} options.liveAnnotationSupported
+     * @param {String} options.alias
+     * @returns {Promise}
+     */
+    joinMeeting(options: {
+        sipUri: string;
+        deviceUrl: string;
+        locusUrl: string;
+        locusClusterUrl: string;
+        resourceId: string;
+        correlationId: string;
+        ensureConversation: boolean;
+        moderator: boolean;
+        pin: boolean;
+        moveToResource: boolean;
+        roapMessage: any;
+        asResourceOccupant: any;
+        inviteeAddress: any;
+        meetingNumber: any;
+        permissionToken: any;
+        preferTranscoding: any;
+        reachability: any;
+        breakoutsSupported: boolean;
+        locale?: string;
+        deviceCapabilities?: Array<string>;
+        liveAnnotationSupported: boolean;
+        ipVersion?: IP_VERSION;
+        alias?: string;
+    }): Promise<any>;
+    /**
+     * Send a request to refresh the captcha
+     * @param {Object} options
+     * @param {String} options.captchaRefreshUrl
+     * @param {String} options.captchaId
+     * @returns {Promise}
+     * @private
+     */
+    private refreshCaptcha;
+    /**
+     * Make a network request to add a dial in device
+     * @param {Object} options
+     * @param {String} options.correlationId
+     * @param {String} options.locusUrl url for the meeting
+     * @param {String} options.dialInUrl identifier for the to-be provisioned device
+     * @param {String} options.clientUrl identifier for the web device
+     * @returns {Promise}
+     * @private
+     */
+    private dialIn;
+    /**
+     * Make a network request to add a dial out device
+     * @param {Object} options
+     * @param {String} options.correlationId
+     * @param {String} options.locusUrl url for the meeting
+     * @param {String} options.dialOutUrl identifier for the to-be provisioned device
+     * @param {String} options.phoneNumber phone number to dial out to
+     * @param {String} options.clientUrl identifier for the web device
+     * @returns {Promise}
+     * @private
+     */
+    private dialOut;
+    /**
+     * Sends a requests to get the latest locus DTO, it might be a full Locus or a delta, depending on the url provided
+     * @param {Object} options
+     * @param {String} options.locusUrl sync url to get ht elatest locus delta
+     * @returns {Promise}
+     */
+    getLocusDTO(options: {
+        url: string;
+    }): any;
+    /**
+     * Make a network request to make a provisioned phone leave the meeting
+     * @param {Object} options
+     * @param {String} options.locusUrl
+     * @param {String} options.phoneUrl
+     * @param {String} options.correlationId
+     * @param {String} options.selfId
+     * @returns {Promise}
+     * @private
+     */
+    private disconnectPhoneAudio;
+    /**
+     * Prepares request options to to leave a meeting
+     * @param {Object} options
+     * @param {Url} options.locusUrl
+     * @param {String} options.selfId
+     * @param {Url} options.deviceUrl
+     * @param {String} options.resourceId,
+     * @param {String} options.correlationId
+     * @returns {Object} request options
+     */
+    prepareLeaveMeetingRequestOptions({ locusUrl, selfId, deviceUrl: url, resourceId, correlationId, }: {
+        locusUrl: string;
+        selfId: string;
+        deviceUrl: string;
+        resourceId: string;
+        correlationId: string;
+    }): {
+        method: string;
+        uri: string;
+        body: {
+            device: {
+                deviceType: any;
+                url: string;
+            };
+            usingResource: string;
+            correlationId: string;
+        };
+    };
+    /**
+     * Make a network request to leave a meeting
+     * @param {Object} options
+     * @returns {Promise}
+     */
+    leaveMeeting({ locusUrl, selfId, deviceUrl: url, resourceId, correlationId, }: {
+        locusUrl: string;
+        selfId: string;
+        deviceUrl: string;
+        resourceId: string;
+        correlationId: string;
+    }): Promise<any>;
+    /**
+     * Builds request options to leave a meeting
+     * @param {Object} options
+     * @returns {Object} request options
+     */
+    buildLeaveMeetingRequestOptions(options: any): Promise<any>;
+    /**
+     * Make a network request to acknowledge a meeting
+     * @param {Object} options
+     * @param {String} options.locusUrl
+     * @param {String} options.deviceUrl
+     * @param {String} options.correlationId
+     * @returns {Promise}
+     */
+    acknowledgeMeeting(options: {
+        locusUrl: string;
+        deviceUrl: string;
+        correlationId: string;
+    }): Promise<any>;
+    /**
+     * Makes a network request to lock the meeting
+     * @param {Object} options
+     * @param {Boolean} options.lock Whether it is locked or not
+     * @returns {Promise}
+     */
+    lockMeeting(options: any): Promise<any>;
+    /**
+     * Make a network request to decline a meeting
+     * @param {Object} options
+     * @param {String} options.locusUrl
+     * @param {String} options.deviceUrl
+     * @param {String} options.reason
+     * @returns {Promise}
+     */
+    declineMeeting(options: {
+        locusUrl: string;
+        deviceUrl: string;
+        reason: string;
+    }): Promise<any>;
+    /**
+     * change the content floor grant
+     * @param {Object} options options for floor grant
+     * @param {String} options.disposition floor action (granted/released)
+     * @param {String} options.personUrl personUrl who is requesting floor
+     * @param {String} options.deviceUrl Url of a device
+     * @param {String} options.resourceId Populated if you are paired to a device
+     * @param {String} options.uri floor grant uri
+     * @param {String} options.shareInstanceId id for current share
+     * @returns {Promise}
+     */
+    changeMeetingFloor(options: {
+        disposition: string;
+        personUrl: string;
+        deviceUrl: string;
+        resourceId: string;
+        uri: string;
+        annotationInfo: AnnotationInfo;
+        shareInstanceId: string;
+    } | any): any;
+    /**
+     * Sends a request to the DTMF endpoint to send tones
+     * @param {Object} options
+     * @param {String} options.locusUrl
+     * @param {String} options.deviceUrl
+     * @param {String} options.tones a string of one or more DTMF tones to send
+     * @returns {Promise}
+     */
+    sendDTMF({ locusUrl, deviceUrl, tones }: {
+        locusUrl: string;
+        deviceUrl: string;
+        tones: string;
+    }): Promise<any>;
+    /**
+     * Sends a request to the controls endpoint to set the video layout
+     * @param {Object} options
+     * @param {String} options.locusUrl
+     * @param {String} options.deviceUrl
+     * @param {String} options.layoutType a layout type that should be available in meeting constants {@link #layout_types}
+     * @param {Object} options.main preferred dimensions for the remote main video stream
+     * @param {Number} options.main.width preferred width of main video stream
+     * @param {Number} options.main.height preferred height of main video stream
+     * @param {Object} options.content preferred dimensions for the remote content share stream
+     * @param {Number} options.content.width preferred width of content share stream
+     * @param {Number} options.content.height preferred height of content share stream
+     * @returns {Promise}
+     */
+    changeVideoLayout({ locusUrl, deviceUrl, layoutType, main, content, }: {
+        locusUrl: string;
+        deviceUrl: string;
+        layoutType: string;
+        main: {
+            width: number;
+            height: number;
+        };
+        content: {
+            width: number;
+            height: number;
+        };
+    }): Promise<any>;
+    /**
+     * Make a network request to end meeting for all
+     * @param {Object} options
+     * @param {Url} options.locusUrl
+     * @returns {Promise}
+     */
+    endMeetingForAll({ locusUrl }: {
+        locusUrl: string;
+    }): Promise<any>;
+    /**
+     * Send a locus keepAlive (used in lobby)
+     * @param {Object} options
+     * @param {Url} options.keepAliveUrl
+     * @returns {Promise}
+     */
+    keepAlive({ keepAliveUrl }: {
+        keepAliveUrl: string;
+    }): any;
+    /**
+     * Make a network request to send a reaction.
+     * @param {Object} options
+     * @param {Url} options.reactionChannelUrl
+     * @param {Reaction} options.reaction
+     * @param {string} options.senderID
+     * @returns {Promise}
+     */
+    sendReaction({ reactionChannelUrl, reaction, participantId }: SendReactionOptions): any;
+    /**
+     * Make a network request to enable or disable reactions.
+     * @param {boolean} options.enable - determines if we need to enable or disable.
+     * @param {locusUrl} options.locusUrl
+     * @returns {Promise}
+     */
+    toggleReactions({ enable, locusUrl, requestingParticipantId }: ToggleReactionsOptions): Promise<any>;
+    getLocusStatusByUrl(locusUrl: string): any;
+}

package/dist/meeting/request.type.d.ts

@@ -0,0 +1,11 @@
+import { Reaction } from '../reactions/reactions.type';
+export type SendReactionOptions = {
+    reactionChannelUrl: string;
+    reaction: Reaction;
+    participantId: string;
+};
+export type ToggleReactionsOptions = {
+    enable: boolean;
+    locusUrl: string;
+    requestingParticipantId: string;
+};

package/dist/meeting/state.d.ts

@@ -0,0 +1,9 @@
+declare const MeetingStateMachine: {
+    /**
+     * Initializes the StateMachine for the meeting
+     * @param {Meeting} meetingRef A reference to a meeting instance
+     * @returns {StateMachine}
+     */
+    create(meetingRef: any): any;
+};
+export default MeetingStateMachine;

package/dist/meeting/util.d.ts

@@ -0,0 +1,119 @@
+import { LocalCameraStream, LocalMicrophoneStream } from '@webex/media-helpers';
+import { SELF_POLICY, IP_VERSION } from '../constants';
+declare const MeetingUtil: {
+    parseLocusJoin: (response: any) => any;
+    remoteUpdateAudioVideo: (meeting: any, audioMuted?: boolean, videoMuted?: boolean) => any;
+    hasOwner: (info: any) => any;
+    isOwnerSelf: (owner: any, selfId: any) => boolean;
+    isPinOrGuest: (err: any) => boolean;
+    /**
+     * Returns the current state of knowledge about whether we are on an ipv4-only or ipv6-only or mixed (ipv4 and ipv6) network.
+     * The return value matches the possible values of "ipver" parameter used by the backend APIs.
+     *
+     * @param {Object} webex webex instance
+     * @returns {IP_VERSION|undefined} ipver value to be passed to the backend APIs or undefined if we should not pass any value to the backend
+     */
+    getIpVersion(webex: any): IP_VERSION | undefined;
+    joinMeeting: (meeting: any, options: any) => any;
+    cleanUp: (meeting: any) => any;
+    disconnectPhoneAudio: (meeting: any, phoneUrl: any) => any;
+    /**
+     * Returns options for leaving a meeting.
+     * @param {any} meeting
+     * @param {any} options
+     * @returns {any} leave options
+     */
+    prepareLeaveMeetingOptions: (meeting: any, options?: any) => any;
+    leaveMeeting: (meeting: any, options?: any) => any;
+    declineMeeting: (meeting: any, reason: any) => any;
+    isUserInLeftState: (locusInfo: any) => boolean;
+    isUserInIdleState: (locusInfo: any) => boolean;
+    isUserInJoinedState: (locusInfo: any) => boolean;
+    isMediaEstablished: (currentMediaStatus: any) => any;
+    joinMeetingOptions: (meeting: any, options?: any) => any;
+    /**
+     * Returns request options for leaving a meeting.
+     * @param {any} meeting
+     * @param {any} options
+     * @returns {any} request options
+     */
+    buildLeaveFetchRequestOptions: (meeting: any, options?: any) => any;
+    getTrack: (stream: any) => {
+        audioTrack: any;
+        videoTrack: any;
+    };
+    getModeratorFromLocusInfo: (locusInfo: any) => any;
+    getPolicyFromLocusInfo: (locusInfo: any) => any;
+    getUserDisplayHintsFromLocusInfo: (locusInfo: any) => any;
+    canInviteNewParticipants: (displayHints: any) => any;
+    canAdmitParticipant: (displayHints: any) => any;
+    canUserLock: (displayHints: any) => any;
+    canUserUnlock: (displayHints: any) => any;
+    canUserRaiseHand: (displayHints: any) => any;
+    canUserLowerAllHands: (displayHints: any) => any;
+    canUserLowerSomeoneElsesHand: (displayHints: any) => any;
+    bothLeaveAndEndMeetingAvailable: (displayHints: any) => any;
+    canManageBreakout: (displayHints: any) => any;
+    canBroadcastMessageToBreakout: (displayHints: any, policies?: {}) => boolean;
+    isSuppressBreakoutSupport: (displayHints: any) => any;
+    canAdmitLobbyToBreakout: (displayHints: any) => boolean;
+    isBreakoutPreassignmentsEnabled: (displayHints: any) => boolean;
+    canUserAskForHelp: (displayHints: any) => boolean;
+    lockMeeting: (actions: any, request: any, locusUrl: any) => any;
+    unlockMeeting: (actions: any, request: any, locusUrl: any) => any;
+    handleAudioLogging: (audioStream?: LocalMicrophoneStream) => void;
+    handleVideoLogging: (videoStream?: LocalCameraStream) => void;
+    handleDeviceLogging: (devices?: any[]) => void;
+    endMeetingForAll: (meeting: any) => any;
+    canEnableClosedCaption: (displayHints: any) => any;
+    isSaveTranscriptsEnabled: (displayHints: any) => any;
+    canStartTranscribing: (displayHints: any) => any;
+    canStopTranscribing: (displayHints: any) => any;
+    isClosedCaptionActive: (displayHints: any) => any;
+    isWebexAssistantActive: (displayHints: any) => any;
+    canViewCaptionPanel: (displayHints: any) => any;
+    isRealTimeTranslationEnabled: (displayHints: any) => any;
+    canSelectSpokenLanguages: (displayHints: any) => any;
+    waitingForOthersToJoin: (displayHints: any) => any;
+    canSendReactions: (originalValue: any, displayHints: any) => any;
+    canUserRenameSelfAndObserved: (displayHints: any) => any;
+    canUserRenameOthers: (displayHints: any) => any;
+    canShareWhiteBoard: (displayHints: any) => any;
+    /**
+     * Adds the current locus sequence information to a request body
+     * @param {Object} meeting The meeting object
+     * @param {Object} requestBody The body of a request to locus
+     * @returns {void}
+     */
+    addSequence: (meeting: any, requestBody: any) => void;
+    /**
+     * Updates the locus info for the meeting with the delta locus
+     * returned from requests that include the sequence information
+     * Returns the original response object
+     * @param {Object} meeting The meeting object
+     * @param {Object} response The response of the http request
+     * @returns {Object}
+     */
+    updateLocusWithDelta: (meeting: any, response: any) => any;
+    generateBuildLocusDeltaRequestOptions: (originalMeeting: any) => (originalOptions: any) => any;
+    generateLocusDeltaRequest: (originalMeeting: any) => (originalOptions: any) => any;
+    selfSupportsFeature: (feature: SELF_POLICY, userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    parseInterpretationInfo: (meeting: any, meetingInfo: any) => void;
+    /**
+     * Returns a CA-recognized error payload for the specified raw error message/reason.
+     *
+     * New errors can be added to this function for handling in the future
+     *
+     * @param {String} reason the raw error message
+     * @returns {Array<object>} an array of payload objects
+     */
+    getChangeMeetingFloorErrorPayload: (reason: string) => {
+        fatal: boolean;
+        category: string;
+        errorCode: number;
+        errorDescription: string;
+        name: string;
+        shownToUser: boolean;
+    }[];
+};
+export default MeetingUtil;

package/dist/meeting/voicea-meeting.d.ts

@@ -0,0 +1,16 @@
+export declare const getSpeaker: (members: any, csis?: any[]) => unknown;
+export declare const getSpeakerFromProxyOrStore: ({ csisKey, meetingMembers, transcriptData }: {
+    csisKey: any;
+    meetingMembers: any;
+    transcriptData: any;
+}) => {
+    speaker: {
+        speakerId: string;
+        name: string;
+    };
+    needsCaching: boolean;
+};
+export declare const processNewCaptions: ({ data, meeting }: {
+    data: any;
+    meeting: any;
+}) => void;

package/dist/meeting-info/collection.d.ts

@@ -0,0 +1,20 @@
+import Collection from '../common/collection';
+/**
+ * @class MeetingInfoCollection
+ */
+export default class MeetingInfoCollection extends Collection {
+    namespace: string;
+    /**
+     * @memberof MeetingInfoCollection
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @param {String} id ID of the meeting info you wish to retreive
+     * @returns {MeetingInfo} returns a meeting info instance
+     * @public
+     * @memberof MeetingInfoCollection
+     */
+    get(id: string): any;
+}

package/dist/meeting-info/index.d.ts

@@ -0,0 +1,69 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * @class MeetingInfo
+ */
+export default class MeetingInfo {
+    meetingInfoCollection: any;
+    meetingInfoRequest: any;
+    webex: any;
+    /**
+     *
+     * @param {WebexSDK} webex
+     */
+    constructor(webex: any);
+    /**
+     * @param {string} id
+     * @returns {object}
+     * @public
+     * @memberof MeetingInfo
+     */
+    getMeetingInfo(id: string): any;
+    /**
+     * @param {string} id
+     * @param {object} info
+     * @returns {null}
+     * @public
+     * @memberof MeetingInfo
+     */
+    setMeetingInfo(id: string, info: object): void;
+    /**
+     * Helper to make the actual MeetingInfo request and set the meetingInfo if successful, else reject
+     * @param {Object} options
+     * @returns {Promise}
+     * @private
+     * @memberof MeetingInfo
+     */
+    private requestFetchInfo;
+    /**
+     * Helper to generate the options for the MeetingInfo request
+     * @param {String} destination
+     * @param {String} type
+     * @returns {Promise}
+     * @private
+     * @memberof MeetingInfo
+     */
+    private fetchInfoOptions;
+    /**
+     * Fetches meeting info from the server
+     * @param {String} destination one of many different types of destinations to look up info for
+     * @param {String} [type] to match up with the destination value
+     * @param {String} [password] meeting password
+     * @param {Object} [captchaInfo] captcha code and id
+     * @param {String} [installedOrgID]
+     * @param {String} [locusId]
+     * @param {Object} [extraParams]
+     * @param {Boolean} [options] meeting Id and whether Call Analyzer events should be sent
+     * @returns {Promise} returns a meeting info object
+     * @public
+     * @memberof MeetingInfo
+     */
+    fetchMeetingInfo(destination: string, type?: string, password?: string, captchaInfo?: {
+        code: string;
+        id: string;
+    }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
+        meetingId?: string;
+        sendCAevents?: boolean;
+    }): any;
+}

package/dist/meeting-info/meeting-info-v2.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Error to indicate that wbxappapi requires a password
+ */
+export declare class MeetingInfoV2PasswordError extends Error {
+    meetingInfo: any;
+    sdkMessage: any;
+    wbxAppApiCode: any;
+    body: any;
+    /**
+     *
+     * @constructor
+     * @param {Number} [wbxAppApiErrorCode]
+     * @param {Object} [meetingInfo]
+     * @param {String} [message]
+     */
+    constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string);
+}
+/**
+ * Error generating a adhoc space meeting
+ */
+export declare class MeetingInfoV2AdhocMeetingError extends Error {
+    sdkMessage: any;
+    wbxAppApiCode: any;
+    /**
+     *
+     * @constructor
+     * @param {Number} [wbxAppApiErrorCode]
+     * @param {String} [message]
+     */
+    constructor(wbxAppApiErrorCode?: number, message?: string);
+}
+/**
+ * Error preventing join because of a meeting policy
+ */
+export declare class MeetingInfoV2PolicyError extends Error {
+    meetingInfo: object;
+    sdkMessage: string;
+    wbxAppApiCode: number;
+    /**
+     *
+     * @constructor
+     * @param {Number} [wbxAppApiErrorCode]
+     * @param {Object} [meetingInfo]
+     * @param {String} [message]
+     */
+    constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string);
+}
+/**
+ * Error to indicate that preferred webex site not present to start adhoc meeting
+ */
+export declare class MeetingInfoV2CaptchaError extends Error {
+    captchaInfo: any;
+    isPasswordRequired: any;
+    sdkMessage: any;
+    wbxAppApiCode: any;
+    body: any;
+    /**
+     *
+     * @constructor
+     * @param {Number} [wbxAppApiErrorCode]
+     * @param {Object} [captchaInfo]
+     * @param {String} [message]
+     */
+    constructor(wbxAppApiErrorCode?: number, captchaInfo?: object, message?: string);
+}
+/**
+ * @class MeetingInfo
+ */
+export default class MeetingInfoV2 {
+    webex: any;
+    /**
+     *
+     * @param {WebexSDK} webex
+     */
+    constructor(webex: any);
+    /**
+     * converts hydra id into conversation url and persons Id
+     * @param {String} destination one of many different types of destinations to look up info for
+     * @param {String} [type] to match up with the destination value
+     * @returns {Promise} destination and type
+     * @public
+     * @memberof MeetingInfo
+     */
+    fetchInfoOptions(destination: string, type?: string): any;
+    /**
+     * Raises a MeetingInfoV2PolicyError for policy error codes
+     * @param {any} err the error from the request
+     * @returns {void}
+     */
+    handlePolicyError: (err: any) => void;
+    /**
+     * Creates adhoc space meetings for a space by fetching the conversation infomation
+     * @param {String} conversationUrl conversationUrl to start adhoc meeting on
+     * @param {String} installedOrgID org ID of user's machine
+     * @returns {Promise} returns a meeting info object
+     * @public
+     * @memberof MeetingInfo
+     */
+    createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: string): Promise<any>;
+    /**
+     * Fetches meeting info from the server
+     * @param {String} destination one of many different types of destinations to look up info for
+     * @param {String} [type] to match up with the destination value
+     * @param {String} password
+     * @param {Object} captchaInfo
+     * @param {String} captchaInfo.code
+     * @param {String} captchaInfo.id
+     * @param {String} installedOrgID org ID of user's machine
+     * @param {String} locusId
+     * @param {Object} extraParams
+     * @param {Object} options
+     * @returns {Promise} returns a meeting info object
+     * @public
+     * @memberof MeetingInfo
+     */
+    fetchMeetingInfo(destination: string, type?: string, password?: string, captchaInfo?: {
+        code: string;
+        id: string;
+    }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
+        meetingId?: string;
+        sendCAevents?: boolean;
+    }): Promise<any>;
+}