@webex/plugin-meetings 3.2.0 → 3.3.0

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

@@ -1,16 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,69 +0,0 @@
-/*!
- * 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

@@ -1,123 +0,0 @@
-/**
- * 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>;
-}

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

@@ -1,22 +0,0 @@
-/**
- * @class MeetingInfoRequest
- */
-export default class MeetingInfoRequest {
-    webex: any;
-    /**
-     * Meeting Info Request Constructor
-     * @param {WebexSDK} webex
-     */
-    constructor(webex: any);
-    /**
-     *
-     * @param {Object} options with format of {type: String, desintation: String}
-     * where type is PERSONAL_ROOM, SIP_URI, CONVERSATION_URL, and destination is userId, sipUri, conversationUrl respectively
-     * type can also be specified as an option and be of the list SIP_URI,MEETING_ID,LOCUS_ID,PERSONAL_ROOM,MEETING_LINK,ONE_ON_ONE,MEDIA_SIP_URI,CONVERSATION_URL,TEMP_SIP_URI
-     * with the desination matching
-     * @returns {Promise} returns a promise that resolves/rejects the result of the request
-     * @throws {Error} if the options are not valid and complete
-     * @memberof MeetingInfoRequest
-     */
-    fetchMeetingInfo(options: any): any;
-}

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

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

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

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

package/dist/meetings/collection.d.ts

@@ -1,40 +0,0 @@
-import Collection from '../common/collection';
-/**
- * @export
- * @class MeetingCollection
- */
-export default class MeetingCollection extends Collection {
-    /**
-     * @constructor
-     * @public
-     * @memberof MeetingCollection
-     */
-    constructor();
-    set(meeting: any): any;
-    /**
-     * get a specific meeting searching for key
-     * @param {String} key
-     * @param {Any} value
-     * @returns {Meeting} if found, else returns null
-     * @public
-     * @memberof MeetingCollection
-     */
-    getByKey(key: string, value: any): any;
-    /**
-     * get a specific meeting searching for key
-     * @param {String} breakoutUrl
-     * @returns {Meeting} if found, else returns null
-     * @public
-     * @memberof MeetingCollection
-     */
-    getActiveBreakoutLocus(breakoutUrl: string): any;
-    /**
-     * Gets the meeting that has a webrtc media connection
-     * NOTE: this function assumes there is no more than 1 such meeting
-     *
-     * @returns {Meeting} first meeting found, else undefined
-     * @public
-     * @memberof MeetingCollection
-     */
-    getActiveWebrtcMeeting(): any;
-}

package/dist/meetings/index.d.ts

@@ -1,398 +0,0 @@
-import '@webex/internal-plugin-mercury';
-import '@webex/internal-plugin-conversation';
-import '@webex/internal-plugin-metrics';
-import { WebexPlugin } from '@webex/webex-core';
-import * as mediaHelpersModule from '@webex/media-helpers';
-import 'webrtc-adapter';
-import { CallStateForMetrics } from '../meeting';
-import Reachability from '../reachability';
-import { INoiseReductionEffect, IVirtualBackgroundEffect } from './meetings.types';
-/**
- * Meetings Ready Event
- * Emitted when the meetings instance on webex is ready
- * @event meetings:ready
- * @instance
- * @memberof Meetings
- */
-/**
- * Meetings Network Disconnected Event
- * Emitted when the meetings instance is disconnected from
- * the internal mercury server
- * @event network:disconnected
- * @instance
- * @memberof Meetings
- */
-/**
- * Meetings Registered Event
- * Emitted when the meetings instance has been registered and listening
- * @event meetings:registered
- * @instance
- * @memberof Meetings
- */
-/**
- * Meeting Removed Event
- * Emitted when a meeting was removed from the cache of meetings
- * @event meeting:removed
- * @instance
- * @type {Object}
- * @property {String} meetingId the removed meeting
- * @property {Object} response the server response
- * @property {String} type what type of meeting it was
- * @memberof Meetings
- */
-/**
- * Meeting Added Event
- * Emitted when a meeting was added to the cache of meetings
- * @event meeting:added
- * @instance
- * @type {Object}
- * @property {String} meetingId the added meeting
- * @property {String} type what type of meeting it was
- * @memberof Meetings
- */
-/**
- * Maintain a cache of meetings and sync with services.
- * @class
- */
-export default class Meetings extends WebexPlugin {
-    loggerRequest: any;
-    media: any;
-    meetingCollection: any;
-    personalMeetingRoom: any;
-    preferredWebexSite: any;
-    reachability: Reachability;
-    registered: any;
-    request: any;
-    geoHintInfo: any;
-    meetingInfo: any;
-    mediaHelpers: any;
-    breakoutLocusForHandleLater: any;
-    namespace: string;
-    /**
-     * Initializes the Meetings Plugin
-     * @constructor
-     * @public
-     * @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
-     * @param {String} data.locusUrl
-     * @param {Object} data.locus
-     * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
-     * @param {String} data.eventType
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private handleLocusEvent;
-    /**
-     * handles locus events through mercury that are not roap
-     * @param {Object} envelope
-     * @param {Object} envelope.data
-     * @param {String} envelope.data.eventType
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private handleLocusMercury;
-    /**
-     * handles mecury offline event
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private handleMercuryOffline;
-    /**
-     * registers for locus and roap mercury events
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private listenForEvents;
-    /**
-     * stops listening for locus and roap mercury events
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private stopListeningForEvents;
-    /**
-     * @returns {undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private onReady;
-    /**
-     * API to toggle unified meetings
-     * @param {Boolean} changeState
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
-     */
-    private _toggleUnifiedMeetings;
-    /**
-     * API to toggle starting adhoc meeting
-     * @param {Boolean} changeState
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
-     */
-    private _toggleAdhocMeetings;
-    /**
-     * API to toggle TCP reachability, needs to be called before webex.meetings.register()
-     * @param {Boolean} newValue
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
-     */
-    private _toggleTcpReachability;
-    /**
-     * API to toggle TLS reachability, needs to be called before webex.meetings.register()
-     * @param {Boolean} newValue
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
-     */
-    private _toggleTlsReachability;
-    /**
-     * Explicitly sets up the meetings plugin by registering
-     * the device, connecting to mercury, and listening for locus events.
-     *
-     * @returns {Promise}
-     * @public
-     * @memberof Meetings
-     */
-    register(): Promise<void>;
-    /**
-     * Explicitly tears down the meetings plugin by deregistering
-     * the device, disconnecting from mercury, and stops listening to locus events
-     *
-     * @returns {Promise}
-     * @public
-     * @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<mediaHelpersModule.NoiseReductionEffect>;
-    /**
-     * 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<mediaHelpersModule.VirtualBackgroundEffect>;
-    /**
-     * Uploads logs to the webex services for tracking
-     * @param {Object} [options={}]
-     * @param {String} [options.callStart] Call Start Time
-     * @param {String} [options.feedbackId] ID used for tracking
-     * @param {String} [options.locusId]
-     * @param {String} [options.correlationId]
-     * @param {String} [options.meetingId] webex meeting ID
-     * @param {String} [options.userId] userId
-     * @param {String} [options.orgId] org id
-     * @returns {String} feedback ID logs were submitted under
-     */
-    uploadLogs(options?: {
-        autoupload?: boolean;
-        callStart?: string;
-        feedbackId?: string;
-        locussessionid?: string;
-        locusId?: string;
-        correlationId?: string;
-        meetingId?: string;
-        userId?: string;
-        orgId?: string;
-    }): any;
-    /**
-     * gets the reachability instance for Meetings
-     * @returns {Reachability}
-     * @public
-     * @memberof Meetings
-     */
-    getReachability(): Reachability;
-    /**
-     * initializes and starts gathering reachability for Meetings
-     * @returns {Promise}
-     * @public
-     * @memberof Meetings
-     */
-    startReachability(): Promise<import("../reachability").ReachabilityResults>;
-    /**
-     * Get geoHint for info for meetings
-     * @returns {Promise}
-     * @private
-     * @memberof Meetings
-     */
-    getGeoHint(): any;
-    /**
-     * Fetch user preferred webex site information
-     * This also has other infomation about the user
-     * @returns {Promise}
-     * @private
-     * @memberof Meetings
-     */
-    fetchUserPreferredWebexSite(): any;
-    /**
-     * gets the personal meeting room instance, for saved PMR values for this user
-     * @returns {PersonalMeetingRoom}
-     * @public
-     * @memberof Meetings
-     */
-    getPersonalMeetingRoom(): any;
-    /**
-     * @param {Meeting} meeting
-     * @param {Object} reason
-     * @param {String} type
-     * @returns {Undefined}
-     * @private
-     * @memberof Meetings
-     */
-    private destroy;
-    /**
-     * Create a meeting or return an existing meeting.
-     *
-     * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
-     *
-     * @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 (callStateForMetrics.correlationId can be provided instead)
-     * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
-     * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
-     * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
-     * @param {String} [meetingLookupUrl] - meeting info prefetch url
-     * @returns {Promise<Meeting>} A new Meeting.
-     * @public
-     * @memberof Meetings
-     */
-    create(destination: string, type?: string, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any): any;
-    /**
-     * Create meeting
-     *
-     * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
-     *
-     * @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 {CallStateForMetrics} callStateForMetrics - information about call state for metrics
-     * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
-     * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
-     * @param {String} [meetingLookupUrl] - meeting info prefetch url
-     * @returns {Promise} a new meeting instance complete with meeting info and destination
-     * @private
-     * @memberof Meetings
-     */
-    private createMeeting;
-    /**
-     * get a specifc meeting given it's type matched to the value, i.e., locus url
-     * @param {String} type
-     * @param {Object} value
-     * @returns {Meeting}
-     * @public
-     * @memberof Meetings
-     */
-    getMeetingByType(type: string, value: object): any;
-    /**
-     * Get all meetings.
-     * @param {object} options
-     * @param {object} options.startDate - get meetings after this start date
-     * @param {object} options.endDate - get meetings before this end date
-     * @returns {Object} All currently active meetings.
-     * @public
-     * @memberof Meetings
-     */
-    getAllMeetings(options?: {
-        startDate: object;
-        endDate: object;
-    }): any;
-    /**
-     * Syncs all the meetings from server. Does nothing and returns immediately if unverified guest.
-     * @param {boolean} keepOnlyLocusMeetings - whether the sync should keep only locus meetings or any other meeting in meetingCollection
-     * @returns {Promise<void>}
-     * @public
-     * @memberof Meetings
-     */
-    syncMeetings({ keepOnlyLocusMeetings }?: {
-        keepOnlyLocusMeetings?: boolean;
-    }): Promise<void>;
-    /**
-     * 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
-     * @param {object} options.startDate - get meetings after this start date
-     * @param {object} options.endDate - get meetings before this end date
-     * @returns {Object} All scheduled meetings.
-     * @memberof Meetings
-     */
-    getScheduledMeetings(): any;
-    /**
-     * Get the logger instance for plugin-meetings
-     * @returns {Logger}
-     */
-    getLogger(): any;
-    /**
-     * Returns the first meeting it finds that has the webrtc media connection created.
-     * Useful for debugging in the console.
-     *
-     * @private
-     * @returns {Meeting} Meeting object that has a webrtc media connection, else undefined
-     */
-    getActiveWebrtcMeeting(): any;
-}