@webex/plugin-meetings 3.7.0 → 3.8.0

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

@@ -0,0 +1,322 @@
+import EventsScope from '../common/events/events-scope';
+/**
+ * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
+ * @export
+ * @private
+ * @class LocusInfo
+ */
+export default class LocusInfo extends EventsScope {
+    compareAndUpdateFlags: any;
+    emitChange: any;
+    locusParser: any;
+    meetingId: any;
+    parsedLocus: any;
+    updateMeeting: any;
+    webex: any;
+    aclUrl: any;
+    baseSequence: any;
+    created: any;
+    deltaParticipants: any;
+    identities: any;
+    membership: any;
+    participants: any;
+    participantsUrl: any;
+    replaces: any;
+    scheduledMeeting: any;
+    sequence: any;
+    controls: any;
+    conversationUrl: any;
+    embeddedApps: any;
+    fullState: any;
+    host: any;
+    info: any;
+    roles: any;
+    mediaShares: any;
+    replace: any;
+    url: any;
+    services: any;
+    mainSessionLocusCache: any;
+    /**
+     * Constructor
+     * @param {function} updateMeeting callback to update the meeting object from an object
+     * @param {object} webex
+     * @param {string} meetingId
+     * @returns {undefined}
+     */
+    constructor(updateMeeting: any, webex: any, meetingId: any);
+    /**
+     * Does a Locus sync. It tries to get the latest delta DTO or if it can't, it falls back to getting the full Locus DTO.
+     *
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     */
+    private doLocusSync;
+    /**
+     * Apply locus delta data to meeting
+     * @param {string} action Locus delta action
+     * @param {Locus} locus
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     */
+    applyLocusDeltaData(action: string, locus: any, meeting: any): void;
+    /**
+     * Adds locus delta to parser's queue
+     * and registers a function handler
+     * to recieve parsed actions from queue.
+     * @param {Locus} locus
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     */
+    handleLocusDelta(locus: any, meeting: any): void;
+    /**
+     * @param {Locus} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    init(locus?: any): void;
+    /**
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    initialSetup(locus: object): void;
+    /**
+     * @param {Meeting} meeting
+     * @param {Object} data
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    parse(meeting: any, data: any): void;
+    /**
+     * @param {String} scope
+     * @param {String} eventName
+     * @param {Array} args
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    emitScoped(scope?: any, eventName?: string, args?: any): boolean;
+    /**
+     * updates the locus with full locus object
+     * @param {object} locus locus object
+     * @param {string} eventType particulat locus event
+     * @returns {object} null
+     * @memberof LocusInfo
+     */
+    onFullLocus(locus: any, eventType?: string): void;
+    /**
+     * @param {String} eventType
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    handleOneOnOneEvent(eventType: string): void;
+    /**
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    onDeltaLocus(locus: any): void;
+    /**
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateLocusInfo(locus: any): void;
+    /**
+     * @param {Array} participants
+     * @param {Object} self
+     * @returns {Array}
+     * @memberof LocusInfo
+     */
+    getLocusPartner(participants: Array<any>, self: any): any;
+    /**
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    isMeetingActive(): void;
+    /**
+     * checks if the host permissions have changed while in the meeting
+     * This would be the case if your role as host or moderator has been updated
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    compareAndUpdate(): void;
+    /**
+     * compared the self object to check if the user has host permissions
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    compareSelfAndHost(): void;
+    /**
+     * Update the deltaParticipants property of this object based on a list of
+     * provided participants.
+     *
+     * @param {Array} [participants] - The participants to update against.
+     * @returns {void}
+     */
+    updateParticipantDeltas(participants?: Array<any>): void;
+    /**
+     * update meeting's members
+     * @param {Object} participants new participants object
+     * @param {Boolean} isReplace is replace the whole members
+     * @returns {Array} updatedParticipants
+     * @memberof LocusInfo
+     */
+    updateParticipants(participants: object, isReplace?: boolean): void;
+    /**
+     * @param {Object} controls
+     * @param {Object} self
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateControls(controls: object, self: object): void;
+    /**
+     * @param {String} conversationUrl
+     * @param {Object} info
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateConversationUrl(conversationUrl: string, info: any): void;
+    /**
+     * @param {Object} created
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateCreated(created: object): void;
+    /**
+     * @param {Object} services
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateServices(services: Record<'breakout' | 'record', {
+        url: string;
+    }>): void;
+    /**
+     * @param {Object} fullState
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateFullState(fullState: object): void;
+    /**
+     * handles when the locus.host is updated
+     * @param {Object} host the locus.host property
+     * @returns {undefined}
+     * @memberof LocusInfo
+     * emits internal event locus_info_update_host
+     */
+    updateHostInfo(host: object): void;
+    /**
+     * @param {Object} info
+     * @param {Object} self
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMeetingInfo(info: object, self?: object): void;
+    /**
+     * @param {Object} embeddedApps
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateEmbeddedApps(embeddedApps: object): void;
+    /**
+     * handles when the locus.mediaShares is updated
+     * @param {Object} mediaShares the locus.mediaShares property
+     * @returns {undefined}
+     * @memberof LocusInfo
+     * emits internal event locus_info_update_media_shares
+     */
+    updateMediaShares(mediaShares: object): void;
+    /**
+     * @param {String} participantsUrl
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateParticipantsUrl(participantsUrl: string): void;
+    /**
+     * @param {Object} replace
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateReplace(replace: object): void;
+    /**
+     * handles when the locus.self is updated
+     * @param {Object} self the locus.mediaShares property
+     * @param {Array} participants the locus.participants property
+     * @returns {undefined}
+     * @memberof LocusInfo
+     * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
+     */
+    updateSelf(self: any, participants: Array<any>): void;
+    /**
+     * handles when the locus.url is updated
+     * @param {String} url
+     * @returns {undefined}
+     * emits internal event locus_info_update_url
+     */
+    updateLocusUrl(url: string): void;
+    /**
+     * @param {String} aclUrl
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateAclUrl(aclUrl: string): void;
+    /**
+     * @param {Number} baseSequence
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateBasequence(baseSequence: number): void;
+    /**
+     * @param {Number} sequence
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateSequence(sequence: number): void;
+    /**
+     * @param {Object} membership
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMemberShip(membership: object): void;
+    /**
+     * @param {Array} identities
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateIdentifiers(identities: Array<any>): void;
+    /**
+     * check the locus is main session's one or not, if is main session's, update main session cache
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateLocusCache(locus: any): void;
+    /**
+     * if return from breakout to main session, need to use cached main session DTO since locus won't send the full locus (participants)
+     * if join breakout from main session, main session is not active for the attendee and remove main session locus cache
+     * @param {Object} newLocus
+     * @returns {Object}
+     * @memberof LocusInfo
+     */
+    getTheLocusToUpdate(newLocus: any): any;
+    /**
+     * merge participants by participant id
+     * @param {Array} participants
+     * @param {Array} sourceParticipants
+     * @returns {Array} merged participants
+     * @memberof LocusInfo
+     */
+    mergeParticipants(participants: any, sourceParticipants: any): any;
+    /**
+     * need cache main sessions' participants since locus will not send the full list when cohost/host leave breakout
+     * @param {Object} mainLocus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMainSessionLocusCache(mainLocus: any): void;
+    /**
+     * clear main session cache
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    clearMainSessionLocusCache(): void;
+}

package/dist/locus-info/index.js

@@ -485,7 +485,7 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "isMeetingActive",
     value: function isMeetingActive() {
-      if (this.parsedLocus.fullState.type === _constants._CALL_ || this.parsedLocus.fullState.type === _constants._SIP_BRIDGE_) {
+      if (this.parsedLocus.fullState.type === _constants._CALL_ || this.parsedLocus.fullState.type === _constants._SIP_BRIDGE_ || this.parsedLocus.fullState.type === _constants._SPACE_SHARE_) {
         // @ts-ignore
         var partner = this.getLocusPartner(this.participants, this.self);
         this.updateMeeting({
@@ -1151,6 +1151,7 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
     /**
      * handles when the locus.mediaShares is updated
      * @param {Object} mediaShares the locus.mediaShares property
+     * @param {boolean} forceUpdate force to update the mediaShares
      * @returns {undefined}
      * @memberof LocusInfo
      * emits internal event locus_info_update_media_shares
@@ -1158,7 +1159,8 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "updateMediaShares",
     value: function updateMediaShares(mediaShares) {
-      if (mediaShares && !(0, _lodash.isEqual)(this.mediaShares, mediaShares)) {
+      var forceUpdate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+      if (mediaShares && (!(0, _lodash.isEqual)(this.mediaShares, mediaShares) || forceUpdate)) {
         var parsedMediaShares = _mediaSharesUtils.default.getMediaShares(this.mediaShares, mediaShares);
         this.updateMeeting(parsedMediaShares.current);
         this.parsedLocus.mediaShares = parsedMediaShares.current;
@@ -1168,7 +1170,8 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
           function: 'updateMediaShares'
         }, _constants.EVENTS.LOCUS_INFO_UPDATE_MEDIA_SHARES, {
           current: parsedMediaShares.current,
-          previous: parsedMediaShares.previous
+          previous: parsedMediaShares.previous,
+          forceUpdate: forceUpdate
         });
       }
     }
@@ -1248,6 +1251,14 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
             breakoutSessions: parsedSelves.current.breakoutSessions
           });
         }
+        if (parsedSelves.updates.brbChanged) {
+          this.emitScoped({
+            file: 'locus-info',
+            function: 'updateSelf'
+          }, _constants.LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED, {
+            brb: parsedSelves.current.brb
+          });
+        }
         if (parsedSelves.updates.interpretationChanged) {
           this.emitScoped({
             file: 'locus-info',