@webex/jsdoctrinetest 3.0.0-beta.9 → 3.0.0-bnr.2

package/dist/types/@webex/plugin-meetings/src/breakouts/request.d.ts

@@ -0,0 +1,22 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class BreakoutRequest
+ */
+export default class BreakoutRequest extends StatelessWebexPlugin {
+    /**
+     * Broadcast message to all breakout session's participants
+     * @param {String} url
+     * @param {String} message
+     * @param {Object} options
+     * @param {string} groupId
+     * @param {string} sessionId
+     * @returns {Promise}
+     */
+    broadcast({ url, message, options, groupId, sessionId, }: {
+        url: string;
+        message: string;
+        options?: object;
+        groupId: string;
+        sessionId?: string;
+    }): any;
+}

package/dist/types/@webex/plugin-meetings/src/breakouts/utils.d.ts

@@ -0,0 +1 @@
+export declare const getBroadcastRoles: (options: any) => string[];

package/dist/types/@webex/plugin-meetings/src/common/browser-detection.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="lodash" />
+declare const _default: ((agent?: any) => {
+    getOSName: () => any;
+    getOSVersion: () => any;
+    getBrowserName: () => any;
+    getBrowserVersion: () => any;
+    isBrowser: (name: any) => boolean;
+}) & import("lodash").MemoizedFunction;
+export default _default;

package/dist/types/@webex/plugin-meetings/src/common/collection.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @class Collection
+ */
+export default class Collection {
+    namespace: string;
+    propertyName: string;
+    /**
+     * @param {String} property
+     * @memberof Collection
+     */
+    constructor(property: string);
+    /**
+     * @param {String} id ID of the thing stuffed into the collection at id location
+     * @returns {Any} returns whatever is being stuffed into the collection
+     * @public
+     * @memberof Collection
+     */
+    get(id: string): any;
+    /**
+     * @param {String} id the id of the meeting info instance to add to the collection
+     * @param {Any} value the thing to set in the collection
+     * @returns {Any} returns the thing just put in the collection
+     * @public
+     * @memberof Collection
+     */
+    set(id: string, value: any): any;
+    /**
+     * remove the thing at the id
+     * @param {String} id ID of the thing you wish to delete from the collection
+     * @returns {undefined}
+     * @public
+     * @memberof Collection
+     */
+    delete(id: string): void;
+    /**
+     * @returns {Object} returns an object map of things stuffed into the collection
+     * @public
+     * @memberof Collection
+     */
+    getAll(): any;
+    /**
+     * @param {Object} set the replacement object
+     * @returns {Object} returns an object map of things stuffed into the collection
+     * @public
+     * @memberof Collection
+     */
+    setAll(set: object): any;
+}

package/dist/types/@webex/plugin-meetings/src/common/config.d.ts

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

package/dist/types/@webex/plugin-meetings/src/common/errors/captcha-error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify captcha related errors
+ */
+export default class CaptchaError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/intent-to-join.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Extended Error object to signify the intent to join for unclaimed PMR scenarios
+ */
+export default class IntentToJoinError extends Error {
+    code: any;
+    error: any;
+    joinIntentRequired: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/join-meeting.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Extended Error object to signify a join meeting error
+ */
+export default class JoinMeetingError extends Error {
+    code: any;
+    error: any;
+    joinOptions: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {Object} [options]
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(options?: object, message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/media.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for media errors
+ */
+export default class MediaError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/parameter.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class ParameterError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/password-error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify password related errors
+ */
+export default class PasswordError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/permission.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class PermissionError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/reconnection-in-progress.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ *
+ * @export
+ * @class ReconnectInProgress
+ * @extends {Error}
+ */
+export default class ReconnectInProgress extends Error {
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/reconnection.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify the intent to join for unclaimed PMR scenarios
+ */
+export default class ReconnectionError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/stats.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for Stats Errors
+ */
+export default class StatsError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/@webex/plugin-meetings/src/common/errors/webex-errors.d.ts

@@ -0,0 +1,69 @@
+import WebexMeetingsError from './webex-meetings-error';
+/**
+ * Create a {@link WebexMeetingsError} for a given code and message.
+ * @private
+ * @param {number} [code] - Error code
+ * @param {string} [message] - Error message
+ * @returns {WebexMeetingsError}
+ */
+export declare function createMeetingsError(code?: number, message?: string): any;
+/**
+ * @class MeetingNotActiveError
+ * @classdesc Raised whenever Meeting has already ended and user tries to do a action.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30101
+ * @property {string} message - 'Meeting has already Ended or not Active'
+ */
+declare class MeetingNotActiveError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { MeetingNotActiveError };
+/**
+ * @class UserNotJoinedError
+ * @classdesc Raised whenever the user has already left the meeting and user tries to do a action.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30102
+ * @property {string} message - 'User has already left the meeting'
+ */
+declare class UserNotJoinedError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { UserNotJoinedError };
+/**
+ * @class NoMediaEstablishedYetError
+ * @classdesc Raised whenever the user has not established media yet.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30103
+ * @property {string} message - 'User has not established media yet'
+ */
+declare class NoMediaEstablishedYetError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { NoMediaEstablishedYetError };
+/**
+ * @class UserInLobbyError
+ * @classdesc Raised whenever the user is in lobby and not joined yet.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30104
+ * @property {string} message - 'user is still in the lobby or not joined'
+ */
+declare class UserInLobbyError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { UserInLobbyError };
+/**
+ * @class IceGatheringFailed
+ * @classdesc Raised whenever ice gathering fails.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30202
+ * @property {string} message - 'user failed ice gathering check network/firewall'
+ */
+declare class IceGatheringFailed extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { IceGatheringFailed };

package/dist/types/@webex/plugin-meetings/src/common/errors/webex-meetings-error.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @extends Error
+ * @property {number} code - Error code
+ */
+export default class WebexMeetingsError extends Error {
+    code: any;
+    /**
+     * Creates a new {@link WebexMeetingsError}
+     * @param {number} code - Error code
+     * @param {string} [message] - Error message
+     * @param {string} [fileName] - Name of the script file where error was generated
+     * @param {number} [lineNumber] - Line number of the script file where error was generated
+     */
+    constructor(code: number, ...args: any[]);
+    /**
+     * Returns human readable string describing the error.
+     * @returns {string}
+     */
+    toString(): string;
+}

package/dist/types/@webex/plugin-meetings/src/common/events/events-scope.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import ChildEmitter from 'events';
+/**
+ * Events
+ * plugin-meetings local
+ * Used to emit events internally between modules specific to an object
+ */
+export default class EventsScope extends ChildEmitter {
+    /**
+     * Emits and logs an event
+     * @param {*} scope
+     * @param {*} eventName
+     * @param {*} args
+     * @returns {Function}
+     */
+    emit(scope: any, eventName: any, args: any): boolean;
+}

package/dist/types/@webex/plugin-meetings/src/common/events/events.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+/**
+ * Events
+ * plugin-meetings global
+ * Used to emit events internally between modules
+ */
+declare class Events extends EventEmitter {
+    emit(scope: any, eventName: any, args: any): boolean;
+}
+declare const _default: Events;
+export default _default;

package/dist/types/@webex/plugin-meetings/src/common/events/trigger-proxy.d.ts

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

package/dist/types/@webex/plugin-meetings/src/common/events/util.d.ts

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

package/dist/types/@webex/plugin-meetings/src/common/logs/logger-config.d.ts

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

package/dist/types/@webex/plugin-meetings/src/common/logs/logger-proxy.d.ts

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

package/dist/types/@webex/plugin-meetings/src/common/logs/request.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @class LogsRequest
+ */
+export default class LogsRequest {
+    webex: any;
+    /**
+     *
+     * @param {Object} options
+     * @param {Object} options.webex Webex SDK instance
+     * @param {ClientMetrics} metrics
+     */
+    constructor(options: {
+        webex: object;
+    });
+    /**
+     * Uploads logs to the support server
+     *
+     * @param {Object} [options={}]
+     * @param {String} [options.feedbackId=uuid.v4] ID used for tracking
+     * @param {String} [options.locusId]
+     * @param {String} [options.correlationId]
+     * @param {String} [options.callStart] Call Start Time
+     * @param {String} [options.meetingId] webex meeting ID
+     * @returns {Promise.<String>} Feedback ID
+     * @memberof LogsRequest
+     */
+    uploadLogs(options?: {
+        feedbackId?: string;
+        locusId?: string;
+        correlationId?: string;
+        callStart?: string;
+        meetingId?: string;
+    }): Promise<any>;
+}

package/dist/types/@webex/plugin-meetings/src/common/queue.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Simple queue
+ */
+export default class SimpleQueue {
+    queue: any[];
+    /**
+     * @constructs SimpleQueue
+     */
+    constructor();
+    /**
+     * Removes all of the elements from queue.
+     * @returns {undefined}
+     */
+    clear(): void;
+    /**
+     * Inserts the specified element into the queue.
+     * @param {object} item
+     * @returns {undefined}
+     */
+    enqueue(item: object): void;
+    /**
+     * Returns and removes the head of the queue.
+     * Returns null if the queue is empty.
+     * @returns {(object|null)} Queue item or null.
+     */
+    dequeue(): any;
+    /**
+     * Returns the number of items in queue.
+     * @returns {number}
+     */
+    size(): number;
+}

package/dist/types/@webex/plugin-meetings/src/config.d.ts

@@ -0,0 +1,77 @@
+declare const _default: {
+    meetings: {
+        deviceType: any;
+        mediaSettings: {
+            sendAudio: boolean;
+            sendVideo: boolean;
+            receiveAudio: boolean;
+            receiveVideo: boolean;
+            pstn: boolean;
+            sendShare: boolean;
+            receiveShare: boolean;
+        };
+        reconnection: {
+            enabled: boolean;
+            autoRejoin: boolean;
+            detection: boolean;
+            iceReconnectionTimeout: number;
+            maxRejoinAttempts: number;
+        };
+        stats: {
+            enableStatsAnalyzer: boolean;
+            autoDowngradeEnabled: boolean;
+            interval: number;
+            analyzerInterval: number;
+            historyMax: number;
+            videoPacketLossRatioThreshold: number;
+            rttThreshold: number;
+            jitterThreshold: number;
+        };
+        metrics: {
+            clientName: string;
+            clientType: string;
+            subClientType: string;
+            mqaMetricsInterval: number;
+            autoSendMQA: boolean;
+        };
+        logging: {
+            enable: boolean;
+            verboseEvents: boolean;
+        };
+        resolution: {
+            maxWidth: number;
+            maxHeight: number;
+            idealWidth: number;
+            idealHeight: number;
+        };
+        screenResolution: {
+            maxWidth: number;
+            maxHeight: number;
+            idealWidth: number;
+            idealHeight: number;
+        };
+        bandwidth: {
+            audio: number;
+            video: number;
+            startBitrate: number;
+        };
+        screenFrameRate: number;
+        videoShareFrameRate: number;
+        aspectRatio: number;
+        autoUploadLogs: boolean;
+        enableRtx: boolean;
+        receiveTranscription: boolean;
+        enableExtmap: boolean;
+        enableAutomaticLLM: boolean;
+        experimental: {
+            enableMediaNegotiatedEvent: boolean;
+            enableUnifiedMeetings: boolean;
+            enableAdhocMeetings: boolean;
+            enableTurnDiscovery: boolean;
+        };
+        degradationPreferences: {
+            maxMacroblocksLimit: number;
+        };
+    };
+};
+export default _default;