@webex/plugin-meetings 3.7.0 → 3.8.0

package/dist/types/meeting/index.d.ts

@@ -19,6 +19,7 @@ import InMeetingActions from './in-meeting-actions';
 import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
 import { LocusMediaRequest } from './locusMediaRequest';
+import { BrbState } from './brbState';
 export type CaptionData = {
     id: string;
     isFinal: boolean;
@@ -83,6 +84,7 @@ export declare enum ScreenShareFloorStatus {
 }
 type FetchMeetingInfoParams = {
     password?: string;
+    registrationId?: string;
     captchaCode?: string;
     extraParams?: Record<string, any>;
     sendCAevents?: boolean;
@@ -449,6 +451,8 @@ export default class Meeting extends StatelessWebexPlugin {
     turnServerUsed: boolean;
     areVoiceaEventsSetup: boolean;
     isMoveToInProgress: boolean;
+    registrationIdStatus: string;
+    brbState: BrbState;
     voiceaListenerCallbacks: object;
     private addMediaData;
     private sendSlotManager;
@@ -460,6 +464,8 @@ export default class Meeting extends StatelessWebexPlugin {
     private iceCandidateErrors;
     private iceCandidatesCount;
     private rtcMetrics?;
+    private uploadLogsTimer?;
+    private logUploadIntervalIndex;
     /**
      * @param {Object} attrs
      * @param {Object} options
@@ -576,6 +582,25 @@ export default class Meeting extends StatelessWebexPlugin {
         requiredCaptcha: any;
         failureReason: string;
     }>;
+    /**
+     * Checks if the supplied registrationId is correct. It returns a promise with information whether the
+     * registrationId and captcha code were correct or not.
+     * @param {String | undefined} registrationId - can be undefined if only captcha was required
+     * @param {String | undefined} captchaCode - can be undefined if captcha was not required by the server
+     * @param {Boolean} sendCAevents - whether Call Analyzer events should be sent when fetching meeting information
+     * @public
+     * @memberof Meeting
+     * @returns {Promise<{isRegistrationIdValid: boolean, requiredCaptcha: boolean, failureReason: MEETING_INFO_FAILURE_REASON}>}
+     */
+    verifyRegistrationId(registrationId: string, captchaCode: string, sendCAevents?: boolean): Promise<{
+        isRegistrationIdValid: boolean;
+        requiredCaptcha: any;
+        failureReason: string;
+    } | {
+        isRegistrationIdValid: boolean;
+        requiredCaptcha: any;
+        failureReason: string;
+    }>;
     /**
      * Refreshes the captcha. As a result the meeting will have new captcha id, image and audio.
      * If the refresh operation fails, meeting remains with the old captcha properties.
@@ -804,6 +829,7 @@ export default class Meeting extends StatelessWebexPlugin {
         emailAddress: string;
         email: string;
         phoneNumber: string;
+        roles: Array<string>;
     }, alertIfActive?: boolean): any;
     /**
      * Cancel an outgoing phone call invitation made during a meeting
@@ -834,6 +860,14 @@ export default class Meeting extends StatelessWebexPlugin {
         authorizingLocusUrl: string;
         mainLocusUrl: string;
     }): any;
+    /**
+     * Manages be right back status updates for the current participant.
+     *
+     * @param {boolean} enabled - Indicates whether the user enabled brb or not.
+     * @returns {Promise<void>} resolves when the brb status is updated or does nothing if not in a multistream meeting.
+     * @throws {Error} - Throws an error if the request fails.
+     */
+    beRightBack(enabled: boolean): Promise<void>;
     /**
      * Remove the member from the meeting, boot them
      * @param {String} memberId
@@ -961,6 +995,23 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     uploadLogs(options?: object): void;
+    /**
+     * sets the timer for periodic log upload
+     * @returns {void}
+     */
+    private setLogUploadTimer;
+    /**
+     * Starts a periodic upload of logs
+     *
+     * @returns {undefined}
+     */
+    startPeriodicLogUpload(): void;
+    /**
+     * Stops the periodic upload of logs
+     *
+     * @returns {undefined}
+     */
+    stopPeriodicLogUpload(): void;
     /**
      * Removes remote audio, video and share streams from class instance's mediaProperties
      * @returns {undefined}
@@ -1026,11 +1077,12 @@ export default class Meeting extends StatelessWebexPlugin {
      * Close the peer connections and remove them from the class.
      * Cleanup any media connection related things.
      *
+     * @param {boolean} resetMuteStates whether to also reset the audio/video mute state information
      * @returns {Promise}
      * @public
      * @memberof Meeting
      */
-    closePeerConnections(): Promise<void>;
+    closePeerConnections(resetMuteStates?: boolean): Promise<void>;
     /**
      * Unsets the peer connections on the class
      * warning DO NOT CALL WITHOUT CLOSING PEER CONNECTIONS FIRST
@@ -1095,7 +1147,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @param {Object} options - options to join with media
      * @param {JoinOptions} [options.joinOptions] - see #join()
      * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
-     * @returns {Promise} -- {join: see join(), media: see addMedia()}
+     * @returns {Promise} -- {join: see join(), media: see addMedia(), multistreamEnabled: flag to indicate if we managed to join in multistream mode}
      * @public
      * @memberof Meeting
      * @example
@@ -1244,7 +1296,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @public
      * @memberof Meeting
      */
-    moveTo(resourceId: string): any;
+    moveTo(resourceId: string): Promise<void>;
     /**
      * Moves the call from the specified resourceId, back to computer
      * @param {String} resourceId
@@ -1252,7 +1304,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @public
      * @memberof Meeting
      */
-    moveFrom(resourceId: string): any;
+    moveFrom(resourceId: string): Promise<any>;
     /**
      * Handles ROAP_FAILURE event from the webrtc media connection
      *
@@ -1317,16 +1369,6 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {void}
      */
     private createStatsAnalyzer;
-    /**
-     * Handles device logging
-     *
-     * @private
-     * @static
-     * @param {boolean} isAudioEnabled
-     * @param {boolean} isVideoEnabled
-     * @returns {Promise<void>}
-     */
-    private static handleDeviceLogging;
     /**
      * Returns a promise. This promise is created once the local sdp offer has been successfully created and is resolved
      * once the remote sdp answer has been received.
@@ -1392,6 +1434,14 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Promise<void>}
      */
     private cleanUpOnAddMediaFailure;
+    /**
+     * Cleans up stats analyzer, peer connection and other things before
+     * we can create a new transcoded media connection
+     *
+     * @private
+     * @returns {Promise<void>}
+     */
+    private downgradeFromMultistreamToTranscoded;
     /**
      * Sends stats report, closes peer connection and cleans up any media connection
      * related things before trying to establish media connection again with turn server

package/dist/types/meeting/locusMediaRequest.d.ts

@@ -1,5 +1,5 @@
 import { WebexPlugin } from '@webex/webex-core';
-import { IP_VERSION } from '../constants';
+import { ClientMediaPreferences } from '../reachability/reachability.types';
 export type MediaRequestType = 'RoapMessage' | 'LocalMute';
 export type RequestResult = any;
 export type RoapRequest = {
@@ -8,9 +8,8 @@ export type RoapRequest = {
     mediaId: string;
     roapMessage: any;
     reachability: any;
+    clientMediaPreferences: ClientMediaPreferences;
     sequence?: any;
-    joinCookie: any;
-    ipVersion?: IP_VERSION;
 };
 export type LocalMuteRequest = {
     type: 'LocalMute';
@@ -74,4 +73,8 @@ export declare class LocusMediaRequest extends WebexPlugin {
     send(request: Request): Promise<RequestResult>;
     /** Returns true if a confluence on the server is already created */
     isConfluenceCreated(): boolean;
+    /**
+     * This method needs to be called when we downgrade from multistream to transcoded connection.
+     */
+    downgradeFromMultistreamToTranscoded(): void;
 }

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

@@ -1,7 +1,7 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
-import { IP_VERSION } from '../constants';
-import { SendReactionOptions, ToggleReactionsOptions } from './request.type';
+import { SendReactionOptions, BrbOptions, ToggleReactionsOptions } from './request.type';
 import { AnnotationInfo } from '../annotation/annotation.types';
+import { ClientMediaPreferences } from '../reachability/reachability.types';
 /**
  * @class MeetingRequest
  */
@@ -63,8 +63,8 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         locale?: string;
         deviceCapabilities?: Array<string>;
         liveAnnotationSupported: boolean;
-        ipVersion?: IP_VERSION;
         alias?: string;
+        clientMediaPreferences: ClientMediaPreferences;
     }): Promise<any>;
     /**
      * Send a request to refresh the captcha
@@ -292,4 +292,15 @@ export default class MeetingRequest extends StatelessWebexPlugin {
      */
     toggleReactions({ enable, locusUrl, requestingParticipantId }: ToggleReactionsOptions): Promise<any>;
     getLocusStatusByUrl(locusUrl: string): any;
+    /**
+     * Sends a request to set be right back status.
+     *
+     * @param {Object} options - The options for brb request.
+     * @param {boolean} options.enabled - Whether brb status is enabled.
+     * @param {string} options.locusUrl - The URL of the locus.
+     * @param {string} options.deviceUrl - The URL of the device.
+     * @param {string} options.selfId - The ID of the participant.
+     * @returns {Promise}
+     */
+    setBrb({ enabled, locusUrl, deviceUrl, selfId }: BrbOptions): Promise<any>;
 }

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

@@ -9,3 +9,9 @@ export type ToggleReactionsOptions = {
     locusUrl: string;
     requestingParticipantId: string;
 };
+export type BrbOptions = {
+    enabled: boolean;
+    locusUrl: string;
+    deviceUrl: string;
+    selfId: string;
+};

package/dist/types/meeting/util.d.ts

@@ -14,7 +14,7 @@ declare const MeetingUtil: {
      * @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;
+    joinMeeting: (meeting: any, options: any) => Promise<any>;
     cleanUp: (meeting: any) => any;
     disconnectPhoneAudio: (meeting: any, phoneUrl: any) => any;
     /**
@@ -30,7 +30,7 @@ declare const MeetingUtil: {
     isUserInIdleState: (locusInfo: any) => boolean;
     isUserInJoinedState: (locusInfo: any) => boolean;
     isMediaEstablished: (currentMediaStatus: any) => any;
-    joinMeetingOptions: (meeting: any, options?: any) => any;
+    joinMeetingOptions: (meeting: any, options?: any) => Promise<any>;
     /**
      * Returns request options for leaving a meeting.
      * @param {any} meeting
@@ -54,6 +54,7 @@ declare const MeetingUtil: {
     canUserLowerSomeoneElsesHand: (displayHints: any) => any;
     bothLeaveAndEndMeetingAvailable: (displayHints: any) => any;
     canManageBreakout: (displayHints: any) => any;
+    canStartBreakout: (displayHints: any) => boolean;
     canBroadcastMessageToBreakout: (displayHints: any, policies?: {}) => boolean;
     isSuppressBreakoutSupport: (displayHints: any) => any;
     canAdmitLobbyToBreakout: (displayHints: any) => boolean;
@@ -63,7 +64,6 @@ declare const MeetingUtil: {
     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;

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

@@ -52,6 +52,7 @@ export declare class MeetingInfoV2PolicyError extends Error {
 export declare class MeetingInfoV2CaptchaError extends Error {
     captchaInfo: any;
     isPasswordRequired: any;
+    isRegistrationIdRequired: any;
     sdkMessage: any;
     wbxAppApiCode: any;
     body: any;
@@ -65,9 +66,26 @@ export declare class MeetingInfoV2CaptchaError extends Error {
     constructor(wbxAppApiErrorCode?: number, captchaInfo?: object, message?: string);
 }
 /**
- * Error preventing join because of a webinar registration error
+ * Error preventing join because of a webinar have some error
  */
-export declare class MeetingInfoV2WebinarRegistrationError extends Error {
+export declare class MeetingInfoV2JoinWebinarError 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 preventing join because of a forbidden error
+ */
+export declare class MeetingInfoV2JoinForbiddenError extends Error {
     meetingInfo: any;
     sdkMessage: any;
     wbxAppApiCode: any;
@@ -107,11 +125,17 @@ export default class MeetingInfoV2 {
      */
     handlePolicyError: (err: any) => void;
     /**
-     * Raises a handleWebinarRegistrationError for webinar registration error codes
+     * Raises a handleJoinWebinarError for join webinar error codes
+     * @param {any} err the error from the request
+     * @returns {void}
+     */
+    handleJoinWebinarError: (err: any) => void;
+    /**
+     * Raises a handleForbiddenError for join meeting forbidden error
      * @param {any} err the error from the request
      * @returns {void}
      */
-    handleWebinarRegistrationError: (err: any) => void;
+    handleForbiddenError: (err: any) => void;
     /**
      * Creates adhoc space meetings for a space by fetching the conversation infomation
      * @param {String} conversationUrl conversationUrl to start adhoc meeting on
@@ -133,6 +157,7 @@ export default class MeetingInfoV2 {
      * @param {String} locusId
      * @param {Object} extraParams
      * @param {Object} options
+     * @param {String} registrationId
      * @returns {Promise} returns a meeting info object
      * @public
      * @memberof MeetingInfo
@@ -143,5 +168,5 @@ export default class MeetingInfoV2 {
     }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
         meetingId?: string;
         sendCAevents?: boolean;
-    }): Promise<any>;
+    }, registrationId?: string): Promise<any>;
 }

package/dist/types/meetings/index.d.ts

@@ -8,7 +8,7 @@ import 'webrtc-adapter';
 import { DESTINATION_TYPE } from '../constants';
 import { CallStateForMetrics } from '../meeting';
 import Reachability from '../reachability';
-import { INoiseReductionEffect, IVirtualBackgroundEffect } from './meetings.types';
+import { INoiseReductionEffect, IVirtualBackgroundEffect, MeetingRegistrationStatus } from './meetings.types';
 /**
  * Meetings Ready Event
  * Emitted when the meetings instance on webex is ready
@@ -71,6 +71,9 @@ export type BasicMeetingInformation = {
     };
     meetingInfo: any;
     sessionCorrelationId: string;
+    roles: string[];
+    getCurUserType: () => string | null;
+    callStateForMetrics: CallStateForMetrics;
 };
 /**
  * Maintain a cache of meetings and sync with services.
@@ -91,6 +94,7 @@ export default class Meetings extends WebexPlugin {
     mediaHelpers: any;
     breakoutLocusForHandleLater: any;
     namespace: string;
+    registrationStatus: MeetingRegistrationStatus;
     /**
      * Initializes the Meetings Plugin
      * @constructor
@@ -175,6 +179,13 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     private onReady;
+    /**
+     * API to change log upload interval. Setting the factor to 0 will disable periodic log uploads.
+     *
+     * @param {number} factor new factor value
+     * @returns {void}
+     */
+    private _setLogUploadIntervalMultiplicationFactor;
     /**
      * API to toggle unified meetings
      * @param {Boolean} changeState
@@ -216,6 +227,13 @@ export default class Meetings extends WebexPlugin {
      * @returns {undefined}
      */
     private _toggleIpv6BackendNativeSupport;
+    /**
+     * Executes a registration step and updates the registration status.
+     * @param {Function} step - The registration step to execute.
+     * @param {string} stepName - The name of the registration step.
+     * @returns {Promise} A promise that resolves when the step is completed.
+     */
+    executeRegistrationStep(step: () => Promise<any>, stepName: string): Promise<void>;
     /**
      * Explicitly sets up the meetings plugin by registering
      * the device, connecting to mercury, and listening for locus events.
@@ -290,7 +308,7 @@ export default class Meetings extends WebexPlugin {
      * @public
      * @memberof Meetings
      */
-    startReachability(trigger?: string): Promise<import("../reachability").ReachabilityResults>;
+    startReachability(trigger?: string): Promise<import("../reachability/reachability.types").ReachabilityResults>;
     /**
      * Get geoHint for info for meetings
      * @returns {Promise}

package/dist/types/meetings/meetings.types.d.ts

@@ -11,3 +11,11 @@ export declare const MEETING_KEY: {
     readonly CORRELATION_ID: "correlationId";
 };
 export type MEETING_KEY = Enum<typeof MEETING_KEY>;
+export type MeetingRegistrationStatus = {
+    fetchWebexSite: boolean;
+    getGeoHint: boolean;
+    startReachability: boolean;
+    deviceRegister: boolean;
+    mercuryConnect: boolean;
+    checkH264Support: boolean;
+};

package/dist/types/member/index.d.ts

@@ -21,6 +21,7 @@ export default class Member {
     isRecording: any;
     isRemovable: any;
     isSelf: any;
+    isBrb: boolean;
     isUser: any;
     isVideoMuted: any;
     roles: IExternalRoles;

package/dist/types/member/types.d.ts

@@ -19,6 +19,13 @@ export type ParticipantWithRoles = {
         };
     };
 };
+export type ParticipantWithBrb = {
+    controls: {
+        brb?: {
+            enabled: boolean;
+        };
+    };
+};
 export declare enum MediaStatus {
     RECVONLY = "RECVONLY",
     SENDONLY = "SENDONLY",

package/dist/types/members/util.d.ts

@@ -26,6 +26,7 @@ declare const MembersUtil: {
      */
     getAddMemberBody: (options: any) => {
         invitees: {
+            roles?: any;
             address: any;
         }[];
         alertIfActive: any;
@@ -54,6 +55,7 @@ declare const MembersUtil: {
         uri: any;
         body: {
             invitees: {
+                roles?: any;
                 address: any;
             }[];
             alertIfActive: any;

package/dist/types/metrics/constants.d.ts

@@ -67,6 +67,11 @@ declare const BEHAVIORAL_METRICS: {
     ROAP_HTTP_RESPONSE_MISSING: string;
     TURN_DISCOVERY_REQUIRES_OK: string;
     REACHABILITY_COMPLETED: string;
-    WEBINAR_REGISTRATION_ERROR: string;
+    JOIN_WEBINAR_ERROR: string;
+    GUEST_ENTERED_LOBBY: string;
+    GUEST_EXITED_LOBBY: string;
+    VERIFY_REGISTRATION_ID_SUCCESS: string;
+    VERIFY_REGISTRATION_ID_ERROR: string;
+    JOIN_FORBIDDEN_ERROR: string;
 };
 export { BEHAVIORAL_METRICS as default };

package/dist/types/multistream/sendSlotManager.d.ts

@@ -1,4 +1,4 @@
-import { SendSlot, MediaType, LocalStream, MultistreamRoapMediaConnection, NamedMediaGroup } from '@webex/internal-media-core';
+import { SendSlot, MediaType, LocalStream, MultistreamRoapMediaConnection, NamedMediaGroup, StreamState } from '@webex/internal-media-core';
 export default class SendSlotManager {
     private readonly slots;
     private readonly LoggerProxy;
@@ -25,6 +25,13 @@ export default class SendSlotManager {
      * @returns {void}
      */
     setNamedMediaGroups(mediaType: MediaType, namedMediaGroups: NamedMediaGroup[]): void;
+    /**
+     * Sets the source state override for the given media type.
+     * @param {MediaType} mediaType - The type of media (must be MediaType.VideoMain to apply source state changes).
+     * @param {StreamState | null} state - The state to set or null to clear the override value.
+     * @returns {void}
+     */
+    setSourceStateOverride(mediaType: MediaType, state: StreamState | null): void;
     /**
      * This method publishes the given stream to the sendSlot for the given mediaType
      * @param {MediaType} mediaType MediaType of the sendSlot to which a stream needs to be published (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)

package/dist/types/reachability/clusterReachability.d.ts

@@ -1,16 +1,7 @@
 import { ClusterNode } from './request';
 import EventsScope from '../common/events/events-scope';
 import { Enum } from '../constants';
-export type TransportResult = {
-    result: 'reachable' | 'unreachable' | 'untested';
-    latencyInMilliseconds?: number;
-    clientMediaIPs?: string[];
-};
-export type ClusterReachabilityResult = {
-    udp: TransportResult;
-    tcp: TransportResult;
-    xtls: TransportResult;
-};
+import { ClusterReachabilityResult } from './reachability.types';
 export type ResultEventData = {
     protocol: 'udp' | 'tcp' | 'xtls';
     result: 'reachable' | 'unreachable' | 'untested';