@webex/plugin-meetings 2.60.0 → 2.60.1-next.10

package/dist/meetings/index.d.ts

@@ -1,6 +1,12 @@
 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
@@ -54,11 +60,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
@@ -67,6 +75,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
@@ -125,21 +161,21 @@ export default class Meetings extends WebexPlugin {
      */
     private _toggleUnifiedMeetings;
     /**
-     * API to enable or disable TURN discovery
-     * @param {Boolean} enable
+     * API to toggle starting adhoc meeting
+     * @param {Boolean} changeState
      * @private
      * @memberof Meetings
      * @returns {undefined}
      */
-    private _toggleTurnDiscovery;
+    private _toggleAdhocMeetings;
     /**
-     * API to toggle starting adhoc meeting
-     * @param {Boolean} changeState
+     * API to toggle TCP reachability, needs to be called before webex.meetings.register()
+     * @param {Boolean} newValue
      * @private
      * @memberof Meetings
      * @returns {undefined}
      */
-    private _toggleAdhocMeetings;
+    private _toggleTcpReachability;
     /**
      * Explicitly sets up the meetings plugin by registering
      * the device, connecting to mercury, and listening for locus events.
@@ -158,6 +194,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<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={}]
@@ -171,35 +225,30 @@ export default class Meetings extends WebexPlugin {
      * @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;
-    /**
-     * 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<import("../reachability").ReachabilityResults>;
     /**
      * Get geoHint for info for meetings
      * @returns {Promise}
@@ -232,19 +281,37 @@ export default class Meetings extends WebexPlugin {
      */
     private destroy;
     /**
-     * Create a meeting.
-     * @param {string} destination - sipURL, spaceId, phonenumber, or locus object}
+     * 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): any;
+    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
@@ -274,11 +341,30 @@ export default class Meetings extends WebexPlugin {
     }): any;
     /**
      * syncs all the meeting from server
+     * @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
      */
-    syncMeetings(): any;
+    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
@@ -293,4 +379,12 @@ export default class Meetings extends WebexPlugin {
      * @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;
 }