@webex/plugin-meetings 2.60.0-next.1 → 2.60.0-next.11

package/dist/meetings/collection.d.ts

@@ -0,0 +1,40 @@
+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/collection.js

@@ -83,6 +83,23 @@ var MeetingCollection = exports.default = /*#__PURE__*/function (_Collection) {
       }
       return null;
     }
+
+    /**
+     * 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
+     */
+  }, {
+    key: "getActiveWebrtcMeeting",
+    value: function getActiveWebrtcMeeting() {
+      // @ts-ignore
+      return (0, _lodash.find)(this.meetings, function (meeting) {
+        return meeting.mediaProperties.webrtcMediaConnection;
+      });
+    }
   }]);
   return MeetingCollection;
 }(_collection.default);

package/dist/meetings/collection.js.map

@@ -1 +1 @@
-{"version":3,"names":["_lodash","require","_collection","_interopRequireDefault","_createSuper","Derived","hasNativeReflectConstruct","_isNativeReflectConstruct","_createSuperInternal","Super","_getPrototypeOf2","default","result","NewTarget","constructor","_Reflect$construct","arguments","apply","_possibleConstructorReturn2","Reflect","sham","Proxy","Boolean","prototype","valueOf","call","e","MeetingCollection","exports","_Collection","_inherits2","_super","_classCallCheck2","_createClass2","key","value","set","meeting","meetings","id","getByKey","find","getActiveBreakoutLocus","breakoutUrl","_meeting$breakouts","_meeting$breakouts2","breakouts","url","isActiveBreakout","Collection"],"sources":["collection.ts"],"sourcesContent":["import {find} from 'lodash';\n\nimport Collection from '../common/collection';\n\n/**\n * @export\n * @class MeetingCollection\n */\nexport default class MeetingCollection extends Collection {\n  /**\n   * @constructor\n   * @public\n   * @memberof MeetingCollection\n   */\n  constructor() {\n    super('meetings');\n  }\n\n  set(meeting) {\n    // @ts-ignore\n    this.meetings[meeting.id] = meeting;\n\n    // @ts-ignore\n    return this.meetings[meeting.id];\n  }\n\n  /**\n   * get a specific meeting searching for key\n   * @param {String} key\n   * @param {Any} value\n   * @returns {Meeting} if found, else returns null\n   * @public\n   * @memberof MeetingCollection\n   */\n  public getByKey(key: string, value: any) {\n    if (key && value) {\n      // @ts-ignore\n      return find(this.meetings, (meeting) => meeting[key] === value);\n    }\n\n    return null;\n  }\n\n  /**\n   * get a specific meeting searching for key\n   * @param {String} breakoutUrl\n   * @returns {Meeting} if found, else returns null\n   * @public\n   * @memberof MeetingCollection\n   */\n  public getActiveBreakoutLocus(breakoutUrl: string) {\n    if (breakoutUrl) {\n      // @ts-ignore\n      return find(\n        // @ts-ignore\n        this.meetings,\n        (meeting) => meeting.breakouts?.url === breakoutUrl && meeting.breakouts?.isActiveBreakout\n      );\n    }\n\n    return null;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AAA8C,SAAAG,aAAAC,OAAA,QAAAC,yBAAA,GAAAC,yBAAA,oBAAAC,qBAAA,QAAAC,KAAA,OAAAC,gBAAA,CAAAC,OAAA,EAAAN,OAAA,GAAAO,MAAA,MAAAN,yBAAA,QAAAO,SAAA,OAAAH,gBAAA,CAAAC,OAAA,QAAAG,WAAA,EAAAF,MAAA,GAAAG,kBAAA,CAAAN,KAAA,EAAAO,SAAA,EAAAH,SAAA,YAAAD,MAAA,GAAAH,KAAA,CAAAQ,KAAA,OAAAD,SAAA,gBAAAE,2BAAA,CAAAP,OAAA,QAAAC,MAAA;AAAA,SAAAL,0BAAA,eAAAY,OAAA,qBAAAJ,kBAAA,oBAAAA,kBAAA,CAAAK,IAAA,2BAAAC,KAAA,oCAAAC,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAV,kBAAA,CAAAO,OAAA,8CAAAI,CAAA;AAE9C;AACA;AACA;AACA;AAHA,IAIqBC,iBAAiB,GAAAC,OAAA,CAAAjB,OAAA,0BAAAkB,WAAA;EAAA,IAAAC,UAAA,CAAAnB,OAAA,EAAAgB,iBAAA,EAAAE,WAAA;EAAA,IAAAE,MAAA,GAAA3B,YAAA,CAAAuB,iBAAA;EACpC;AACF;AACA;AACA;AACA;EACE,SAAAA,kBAAA,EAAc;IAAA,IAAAK,gBAAA,CAAArB,OAAA,QAAAgB,iBAAA;IAAA,OAAAI,MAAA,CAAAN,IAAA,OACN,UAAU;EAClB;EAAC,IAAAQ,aAAA,CAAAtB,OAAA,EAAAgB,iBAAA;IAAAO,GAAA;IAAAC,KAAA,EAED,SAAAC,IAAIC,OAAO,EAAE;MACX;MACA,IAAI,CAACC,QAAQ,CAACD,OAAO,CAACE,EAAE,CAAC,GAAGF,OAAO;;MAEnC;MACA,OAAO,IAAI,CAACC,QAAQ,CAACD,OAAO,CAACE,EAAE,CAAC;IAClC;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAL,GAAA;IAAAC,KAAA,EAQA,SAAAK,SAAgBN,GAAW,EAAEC,KAAU,EAAE;MACvC,IAAID,GAAG,IAAIC,KAAK,EAAE;QAChB;QACA,OAAO,IAAAM,YAAI,EAAC,IAAI,CAACH,QAAQ,EAAE,UAACD,OAAO;UAAA,OAAKA,OAAO,CAACH,GAAG,CAAC,KAAKC,KAAK;QAAA,EAAC;MACjE;MAEA,OAAO,IAAI;IACb;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAD,GAAA;IAAAC,KAAA,EAOA,SAAAO,uBAA8BC,WAAmB,EAAE;MACjD,IAAIA,WAAW,EAAE;QACf;QACA,OAAO,IAAAF,YAAI;QACT;QACA,IAAI,CAACH,QAAQ,EACb,UAACD,OAAO;UAAA,IAAAO,kBAAA,EAAAC,mBAAA;UAAA,OAAK,EAAAD,kBAAA,GAAAP,OAAO,CAACS,SAAS,cAAAF,kBAAA,uBAAjBA,kBAAA,CAAmBG,GAAG,MAAKJ,WAAW,MAAAE,mBAAA,GAAIR,OAAO,CAACS,SAAS,cAAAD,mBAAA,uBAAjBA,mBAAA,CAAmBG,gBAAgB;QAAA,CAC5F,CAAC;MACH;MAEA,OAAO,IAAI;IACb;EAAC;EAAA,OAAArB,iBAAA;AAAA,EArD4CsB,mBAAU"}
+{"version":3,"names":["_lodash","require","_collection","_interopRequireDefault","_createSuper","Derived","hasNativeReflectConstruct","_isNativeReflectConstruct","_createSuperInternal","Super","_getPrototypeOf2","default","result","NewTarget","constructor","_Reflect$construct","arguments","apply","_possibleConstructorReturn2","Reflect","sham","Proxy","Boolean","prototype","valueOf","call","e","MeetingCollection","exports","_Collection","_inherits2","_super","_classCallCheck2","_createClass2","key","value","set","meeting","meetings","id","getByKey","find","getActiveBreakoutLocus","breakoutUrl","_meeting$breakouts","_meeting$breakouts2","breakouts","url","isActiveBreakout","getActiveWebrtcMeeting","mediaProperties","webrtcMediaConnection","Collection"],"sources":["collection.ts"],"sourcesContent":["import {find} from 'lodash';\n\nimport Collection from '../common/collection';\n\n/**\n * @export\n * @class MeetingCollection\n */\nexport default class MeetingCollection extends Collection {\n  /**\n   * @constructor\n   * @public\n   * @memberof MeetingCollection\n   */\n  constructor() {\n    super('meetings');\n  }\n\n  set(meeting) {\n    // @ts-ignore\n    this.meetings[meeting.id] = meeting;\n\n    // @ts-ignore\n    return this.meetings[meeting.id];\n  }\n\n  /**\n   * get a specific meeting searching for key\n   * @param {String} key\n   * @param {Any} value\n   * @returns {Meeting} if found, else returns null\n   * @public\n   * @memberof MeetingCollection\n   */\n  public getByKey(key: string, value: any) {\n    if (key && value) {\n      // @ts-ignore\n      return find(this.meetings, (meeting) => meeting[key] === value);\n    }\n\n    return null;\n  }\n\n  /**\n   * get a specific meeting searching for key\n   * @param {String} breakoutUrl\n   * @returns {Meeting} if found, else returns null\n   * @public\n   * @memberof MeetingCollection\n   */\n  public getActiveBreakoutLocus(breakoutUrl: string) {\n    if (breakoutUrl) {\n      // @ts-ignore\n      return find(\n        // @ts-ignore\n        this.meetings,\n        (meeting) => meeting.breakouts?.url === breakoutUrl && meeting.breakouts?.isActiveBreakout\n      );\n    }\n\n    return null;\n  }\n\n  /**\n   * Gets the meeting that has a webrtc media connection\n   * NOTE: this function assumes there is no more than 1 such meeting\n   *\n   * @returns {Meeting} first meeting found, else undefined\n   * @public\n   * @memberof MeetingCollection\n   */\n  public getActiveWebrtcMeeting() {\n    // @ts-ignore\n    return find(this.meetings, (meeting) => meeting.mediaProperties.webrtcMediaConnection);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AAA8C,SAAAG,aAAAC,OAAA,QAAAC,yBAAA,GAAAC,yBAAA,oBAAAC,qBAAA,QAAAC,KAAA,OAAAC,gBAAA,CAAAC,OAAA,EAAAN,OAAA,GAAAO,MAAA,MAAAN,yBAAA,QAAAO,SAAA,OAAAH,gBAAA,CAAAC,OAAA,QAAAG,WAAA,EAAAF,MAAA,GAAAG,kBAAA,CAAAN,KAAA,EAAAO,SAAA,EAAAH,SAAA,YAAAD,MAAA,GAAAH,KAAA,CAAAQ,KAAA,OAAAD,SAAA,gBAAAE,2BAAA,CAAAP,OAAA,QAAAC,MAAA;AAAA,SAAAL,0BAAA,eAAAY,OAAA,qBAAAJ,kBAAA,oBAAAA,kBAAA,CAAAK,IAAA,2BAAAC,KAAA,oCAAAC,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAV,kBAAA,CAAAO,OAAA,8CAAAI,CAAA;AAE9C;AACA;AACA;AACA;AAHA,IAIqBC,iBAAiB,GAAAC,OAAA,CAAAjB,OAAA,0BAAAkB,WAAA;EAAA,IAAAC,UAAA,CAAAnB,OAAA,EAAAgB,iBAAA,EAAAE,WAAA;EAAA,IAAAE,MAAA,GAAA3B,YAAA,CAAAuB,iBAAA;EACpC;AACF;AACA;AACA;AACA;EACE,SAAAA,kBAAA,EAAc;IAAA,IAAAK,gBAAA,CAAArB,OAAA,QAAAgB,iBAAA;IAAA,OAAAI,MAAA,CAAAN,IAAA,OACN,UAAU;EAClB;EAAC,IAAAQ,aAAA,CAAAtB,OAAA,EAAAgB,iBAAA;IAAAO,GAAA;IAAAC,KAAA,EAED,SAAAC,IAAIC,OAAO,EAAE;MACX;MACA,IAAI,CAACC,QAAQ,CAACD,OAAO,CAACE,EAAE,CAAC,GAAGF,OAAO;;MAEnC;MACA,OAAO,IAAI,CAACC,QAAQ,CAACD,OAAO,CAACE,EAAE,CAAC;IAClC;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAL,GAAA;IAAAC,KAAA,EAQA,SAAAK,SAAgBN,GAAW,EAAEC,KAAU,EAAE;MACvC,IAAID,GAAG,IAAIC,KAAK,EAAE;QAChB;QACA,OAAO,IAAAM,YAAI,EAAC,IAAI,CAACH,QAAQ,EAAE,UAACD,OAAO;UAAA,OAAKA,OAAO,CAACH,GAAG,CAAC,KAAKC,KAAK;QAAA,EAAC;MACjE;MAEA,OAAO,IAAI;IACb;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAD,GAAA;IAAAC,KAAA,EAOA,SAAAO,uBAA8BC,WAAmB,EAAE;MACjD,IAAIA,WAAW,EAAE;QACf;QACA,OAAO,IAAAF,YAAI;QACT;QACA,IAAI,CAACH,QAAQ,EACb,UAACD,OAAO;UAAA,IAAAO,kBAAA,EAAAC,mBAAA;UAAA,OAAK,EAAAD,kBAAA,GAAAP,OAAO,CAACS,SAAS,cAAAF,kBAAA,uBAAjBA,kBAAA,CAAmBG,GAAG,MAAKJ,WAAW,MAAAE,mBAAA,GAAIR,OAAO,CAACS,SAAS,cAAAD,mBAAA,uBAAjBA,mBAAA,CAAmBG,gBAAgB;QAAA,CAC5F,CAAC;MACH;MAEA,OAAO,IAAI;IACb;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAd,GAAA;IAAAC,KAAA,EAQA,SAAAc,uBAAA,EAAgC;MAC9B;MACA,OAAO,IAAAR,YAAI,EAAC,IAAI,CAACH,QAAQ,EAAE,UAACD,OAAO;QAAA,OAAKA,OAAO,CAACa,eAAe,CAACC,qBAAqB;MAAA,EAAC;IACxF;EAAC;EAAA,OAAAxB,iBAAA;AAAA,EAlE4CyB,mBAAU"}

package/dist/meetings/index.d.ts

@@ -0,0 +1,378 @@
+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;
+    /**
+     * 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<{
+        [x: string]: {
+            udp: import("../reachability").TransportResult;
+            tcp: import("../reachability").TransportResult;
+            xtls: {
+                untested: "true";
+            };
+        } & {
+            isVideoMesh?: boolean;
+        };
+    }>;
+    /**
+     * 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.
+     * @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
+     * @returns {Promise<Meeting>} A new Meeting.
+     * @public
+     * @memberof Meetings
+     */
+    create(destination: string, type?: string, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics): any;
+    /**
+     * @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)
+     * @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 meeting from server
+     * @returns {undefined}
+     * @public
+     * @memberof Meetings
+     */
+    syncMeetings(): any;
+    /**
+     * 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;
+}

package/dist/meetings/index.js

@@ -963,13 +963,14 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
     }
 
     /**
-     * Create a meeting.
+     * Create a meeting or return an existing meeting.
      * @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
+     * @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
      * @returns {Promise<Meeting>} A new Meeting.
      * @public
      * @memberof Meetings
@@ -983,12 +984,18 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
       var infoExtraParams = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
       var correlationId = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : undefined;
       var failOnMissingMeetingInfo = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
+      var callStateForMetrics = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : undefined;
       // TODO: type should be from a dictionary
 
       // Validate meeting information based on the provided destination and
       // type. This must be performed prior to determining if the meeting is
       // found in the collection, as we mutate the destination for hydra person
       // id values.
+      if (correlationId) {
+        callStateForMetrics = _objectSpread(_objectSpread({}, callStateForMetrics || {}), {}, {
+          correlationId: correlationId
+        });
+      }
       return this.meetingInfo.fetchInfoOptions(destination, type)
       // Catch a failure to fetch info options.
       .catch(function (error) {
@@ -1024,7 +1031,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
         // Validate if a meeting was found.
         if (!meeting) {
           // Create a meeting based on the normalized destination and type.
-          return _this10.createMeeting(targetDest, type, useRandomDelayForInfo, infoExtraParams, correlationId, failOnMissingMeetingInfo).then(function (createdMeeting) {
+          return _this10.createMeeting(targetDest, type, useRandomDelayForInfo, infoExtraParams, callStateForMetrics, failOnMissingMeetingInfo).then(function (createdMeeting) {
             // If the meeting was successfully created.
             if (createdMeeting && createdMeeting.on) {
               // Create a destruction event for the meeting.
@@ -1070,6 +1077,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
             return _promise.default.resolve(createdMeeting);
           });
         }
+        meeting.setCallStateForMetrics(callStateForMetrics);
 
         // Return the existing meeting.
         return _promise.default.resolve(meeting);
@@ -1081,7 +1089,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
      * @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 {String} correlationId the optional specified correlationId
+     * @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)
      * @returns {Promise} a new meeting instance complete with meeting info and destination
      * @private
@@ -1094,7 +1102,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
         var type,
           useRandomDelayForInfo,
           infoExtraParams,
-          correlationId,
+          callStateForMetrics,
           failOnMissingMeetingInfo,
           meeting,
           _destination$fullStat,
@@ -1114,7 +1122,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
               type = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : null;
               useRandomDelayForInfo = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : false;
               infoExtraParams = _args3.length > 3 && _args3[3] !== undefined ? _args3[3] : {};
-              correlationId = _args3.length > 4 && _args3[4] !== undefined ? _args3[4] : undefined;
+              callStateForMetrics = _args3.length > 4 && _args3[4] !== undefined ? _args3[4] : undefined;
               failOnMissingMeetingInfo = _args3.length > 5 && _args3[5] !== undefined ? _args3[5] : false;
               meeting = new _meeting.default({
                 // @ts-ignore
@@ -1128,7 +1136,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
                 meetingInfoProvider: this.meetingInfo,
                 destination: destination,
                 destinationType: type,
-                correlationId: correlationId
+                callStateForMetrics: callStateForMetrics
               }, {
                 // @ts-ignore
                 parent: this.webex
@@ -1157,7 +1165,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
               meeting.fetchMeetingInfoTimeoutId = setTimeout(function () {
                 return meeting.fetchMeetingInfo({
                   extraParams: infoExtraParams,
-                  sendCAevents: !!correlationId // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+                  sendCAevents: !!(callStateForMetrics !== null && callStateForMetrics !== void 0 && callStateForMetrics.correlationId) // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
                 });
               }, waitingTime);
               meeting.parseMeetingInfo(undefined, destination);
@@ -1167,7 +1175,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
               _context3.next = 19;
               return meeting.fetchMeetingInfo({
                 extraParams: infoExtraParams,
-                sendCAevents: !!correlationId // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+                sendCAevents: !!(callStateForMetrics !== null && callStateForMetrics !== void 0 && callStateForMetrics.correlationId) // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
               });
             case 19:
               _context3.next = 31;
@@ -1399,6 +1407,19 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
     value: function getLogger() {
       return _loggerProxy.default.get();
     }
+
+    /**
+     * 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
+     */
+  }, {
+    key: "getActiveWebrtcMeeting",
+    value: function getActiveWebrtcMeeting() {
+      return this.meetingCollection.getActiveWebrtcMeeting();
+    }
   }]);
   return Meetings;
 }(_webexCore.WebexPlugin);