@webex/jsdoctrinetest 3.0.0-bnr.5 → 3.0.0-next.2

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

@@ -1,108 +0,0 @@
-export declare const createMuteState: (type: any, meeting: any, mediaDirection: any) => MuteState;
-/** The purpose of this class is to manage the local and remote mute state and make sure that the server state always matches
-   the last requested state by the client.
-
-   More info about Locus muting API: https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html#
-*/
-declare class MuteState {
-    pendingPromiseReject: any;
-    pendingPromiseResolve: any;
-    state: any;
-    type: any;
-    /**
-     * Constructor
-     *
-     * @param {String} type - audio or video
-     * @param {Object} meeting - the meeting object (used for reading current remote mute status)
-     */
-    constructor(type: string, meeting: any);
-    /**
-     * Handles mute/unmute request from the client/user. Returns a promise that's resolved once the server update is completed or
-     * at the point that this request becomese superseded by another client request.
-     *
-     * The client doesn't have to wait for the returned promise to resolve before calling handleClientRequest() again. If
-     * handleClientRequest() is called again before the previous one resolved, the MuteState class will make sure that eventually
-     * the server state will match the last requested state from the client.
-     *
-     * @public
-     * @memberof MuteState
-     * @param {Object} [meeting] the meeting object
-     * @param {Boolean} [mute] true for muting, false for unmuting request
-     * @returns {Promise}
-     */
-    handleClientRequest(meeting?: object, mute?: boolean): Promise<unknown>;
-    /**
-     * Applies the current mute state to the local track (by enabling or disabling it accordingly)
-     *
-     * @public
-     * @param {Object} [meeting] the meeting object
-     * @memberof MuteState
-     * @returns {void}
-     */
-    applyClientStateLocally(meeting?: any): void;
-    /**
-     * Updates the server local and remote mute values so that they match the current client desired state.
-     *
-     * @private
-     * @param {Object} [meeting] the meeting object
-     * @memberof MuteState
-     * @returns {void}
-     */
-    private applyClientStateToServer;
-    /**
-     * Sets the local mute value in the server
-     *
-     * @private
-     * @param {Object} [meeting] the meeting object
-     * @memberof MuteState
-     * @returns {Promise}
-     */
-    private sendLocalMuteRequestToServer;
-    /**
-     * Sets the remote mute value in the server
-     *
-     * @private
-     * @param {Object} [meeting] the meeting object
-     * @memberof MuteState
-     * @returns {Promise}
-     */
-    private sendRemoteMuteRequestToServer;
-    /**
-     * This method should be called whenever the server remote mute state is changed
-     *
-     * @public
-     * @memberof MuteState
-     * @param {Boolean} [muted] true if user is remotely muted, false otherwise
-     * @param {Boolean} [unmuteAllowed] indicates if user is allowed to unmute self (false when "hard mute" feature is used)
-     * @returns {undefined}
-     */
-    handleServerRemoteMuteUpdate(muted?: boolean, unmuteAllowed?: boolean): void;
-    /**
-     * This method should be called whenever we receive from the server a requirement to locally unmute
-     *
-     * @public
-     * @memberof MuteState
-     * @param {Object} [meeting] the meeting object
-     * @returns {undefined}
-     */
-    handleServerLocalUnmuteRequired(meeting?: object): void;
-    /**
-     * Returns true if the user is locally or remotely muted
-     *
-     * @public
-     * @memberof MuteState
-     * @returns {Boolean}
-     */
-    isMuted(): any;
-    /**
-     * Returns true if the user is muted as a result of the client request (and not remotely muted)
-     *
-     * @public
-     * @memberof MuteState
-     * @returns {Boolean}
-     */
-    isSelf(): boolean;
-    get muted(): any;
-    get self(): boolean;
-}
-export {};

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

@@ -1,261 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-import { SendReactionOptions, ToggleReactionsOptions } from './request.type';
-/**
- * @class MeetingRequest
- */
-export default class MeetingRequest extends StatelessWebexPlugin {
-    changeVideoLayoutDebounced: any;
-    constructor(attrs: any, options: any);
-    /**
-     * Make a network request to join a meeting
-     * @param {Object} options
-     * @param {String} options.sipUri
-     * @param {String} options.deviceUrl
-     * @param {String} options.locusUrl
-     * @param {String} options.resourceId,
-     * @param {String} options.correlationId
-     * @param {boolean} options.ensureConversation
-     * @param {boolean} options.moderator
-     * @param {boolean} options.pin
-     * @param {boolean} options.moveToResource
-     * @param {Object} options.roapMessage
-     * @param {boolean} options.breakoutsSupported
-     * @returns {Promise}
-     */
-    joinMeeting(options: {
-        sipUri: string;
-        deviceUrl: string;
-        locusUrl: string;
-        resourceId: string;
-        correlationId: string;
-        ensureConversation: boolean;
-        moderator: boolean;
-        pin: boolean;
-        moveToResource: boolean;
-        roapMessage: any;
-        asResourceOccupant: any;
-        inviteeAddress: any;
-        meetingNumber: any;
-        permissionToken: any;
-        preferTranscoding: any;
-        breakoutsSupported: boolean;
-    }): Promise<any>;
-    /**
-     * Send a request to refresh the captcha
-     * @param {Object} options
-     * @param {String} options.captchaRefreshUrl
-     * @param {String} options.captchaId
-     * @returns {Promise}
-     * @private
-     */
-    private refreshCaptcha;
-    /**
-     * Make a network request to add a dial in device
-     * @param {Object} options
-     * @param {String} options.correlationId
-     * @param {String} options.locusUrl url for the meeting
-     * @param {String} options.dialInUrl identifier for the to-be provisioned device
-     * @param {String} options.clientUrl identifier for the web device
-     * @returns {Promise}
-     * @private
-     */
-    private dialIn;
-    /**
-     * Make a network request to add a dial out device
-     * @param {Object} options
-     * @param {String} options.correlationId
-     * @param {String} options.locusUrl url for the meeting
-     * @param {String} options.dialOutUrl identifier for the to-be provisioned device
-     * @param {String} options.phoneNumber phone number to dial out to
-     * @param {String} options.clientUrl identifier for the web device
-     * @returns {Promise}
-     * @private
-     */
-    private dialOut;
-    /**
-     * Syns the missed delta event
-     * @param {Object} options
-     * @param {boolean} options.desync flag to get partial or whole locus object
-     * @param {String} options.syncUrl sync url to get ht elatest locus delta
-     * @returns {Promise}
-     */
-    syncMeeting(options: {
-        desync: boolean;
-        syncUrl: string;
-    }): any;
-    /**
-     * Request to get the complete locus object
-     * @param {Object} options
-     * @param {boolean} options.desync flag to get partial or whole locus object
-     * @param {String} options.locusUrl sync url to get ht elatest locus delta
-     * @returns {Promise}
-     */
-    getFullLocus(options: {
-        desync: boolean;
-        locusUrl: string;
-    }): any;
-    /**
-     * Make a network request to make a provisioned phone leave the meeting
-     * @param {Object} options
-     * @param {String} options.locusUrl
-     * @param {String} options.phoneUrl
-     * @param {String} options.correlationId
-     * @param {String} options.selfId
-     * @returns {Promise}
-     * @private
-     */
-    private disconnectPhoneAudio;
-    /**
-     * Make a network request to leave a meeting
-     * @param {Object} options
-     * @param {Url} options.locusUrl
-     * @param {String} options.selfId
-     * @param {Url} options.deviceUrl
-     * @param {String} options.resourceId,
-     * @param {String} options.correlationId
-     * @returns {Promise}
-     */
-    leaveMeeting({ locusUrl, selfId, deviceUrl: url, resourceId, correlationId, }: {
-        locusUrl: string;
-        selfId: string;
-        deviceUrl: string;
-        resourceId: string;
-        correlationId: string;
-    }): any;
-    /**
-     * Make a network request to acknowledge a meeting
-     * @param {Object} options
-     * @param {String} options.locusUrl
-     * @param {String} options.deviceUrl
-     * @param {String} options.correlationId
-     * @returns {Promise}
-     */
-    acknowledgeMeeting(options: {
-        locusUrl: string;
-        deviceUrl: string;
-        correlationId: string;
-    }): any;
-    lockMeeting(options: any): any;
-    /**
-     * Make a network request to decline a meeting
-     * @param {Object} options
-     * @param {String} options.locusUrl
-     * @param {String} options.deviceUrl
-     * @param {String} options.reason
-     * @returns {Promise}
-     */
-    declineMeeting(options: {
-        locusUrl: string;
-        deviceUrl: string;
-        reason: string;
-    }): any;
-    /**
-     * Toggle remote audio and/or video
-     * @param {Object} options options for toggling
-     * @param {String} options.selfId Locus self id??
-     * @param {String} options.locusUrl Locus url
-     * @param {String} options.deviceUrl Url of a device
-     * @param {String} options.resourceId Populated if you are paired to a device
-     * @param {String} options.localMedias local sdps
-     * @param {Boolean} options.preferTranscoding false for multistream (Homer), true for transcoded media (Edonus)
-     * @returns {Promise}
-     */
-    remoteAudioVideoToggle(options: {
-        selfId: string;
-        locusUrl: string;
-        deviceUrl: string;
-        resourceId: string;
-        localMedias: string;
-    } | any): any;
-    /**
-     * change the content floor grant
-     * @param {Object} options options for floor grant
-     * @param {String} options.disposition floor action (granted/released)
-     * @param {String} options.personUrl personUrl who is requesting floor
-     * @param {String} options.deviceUrl Url of a device
-     * @param {String} options.resourceId Populated if you are paired to a device
-     * @param {String} options.uri floor grant uri
-     * @returns {Promise}
-     */
-    changeMeetingFloor(options: {
-        disposition: string;
-        personUrl: string;
-        deviceUrl: string;
-        resourceId: string;
-        uri: string;
-    } | any): any;
-    /**
-     * Sends a request to the DTMF endpoint to send tones
-     * @param {Object} options
-     * @param {String} options.locusUrl
-     * @param {String} options.deviceUrl
-     * @param {String} options.tones a string of one or more DTMF tones to send
-     * @returns {Promise}
-     */
-    sendDTMF({ locusUrl, deviceUrl, tones }: {
-        locusUrl: string;
-        deviceUrl: string;
-        tones: string;
-    }): any;
-    /**
-     * Sends a request to the controls endpoint to set the video layout
-     * @param {Object} options
-     * @param {String} options.locusUrl
-     * @param {String} options.deviceUrl
-     * @param {String} options.layoutType a layout type that should be available in meeting constants {@link #layout_types}
-     * @param {Object} options.main preferred dimensions for the remote main video stream
-     * @param {Number} options.main.width preferred width of main video stream
-     * @param {Number} options.main.height preferred height of main video stream
-     * @param {Object} options.content preferred dimensions for the remote content share stream
-     * @param {Number} options.content.width preferred width of content share stream
-     * @param {Number} options.content.height preferred height of content share stream
-     * @returns {Promise}
-     */
-    changeVideoLayout({ locusUrl, deviceUrl, layoutType, main, content, }: {
-        locusUrl: string;
-        deviceUrl: string;
-        layoutType: string;
-        main: {
-            width: number;
-            height: number;
-        };
-        content: {
-            width: number;
-            height: number;
-        };
-    }): any;
-    /**
-     * Make a network request to end meeting for all
-     * @param {Object} options
-     * @param {Url} options.locusUrl
-     * @returns {Promise}
-     */
-    endMeetingForAll({ locusUrl }: {
-        locusUrl: string;
-    }): any;
-    /**
-     * Send a locus keepAlive (used in lobby)
-     * @param {Object} options
-     * @param {Url} options.keepAliveUrl
-     * @returns {Promise}
-     */
-    keepAlive({ keepAliveUrl }: {
-        keepAliveUrl: string;
-    }): any;
-    /**
-     * Make a network request to send a reaction.
-     * @param {Object} options
-     * @param {Url} options.reactionChannelUrl
-     * @param {Reaction} options.reaction
-     * @param {string} options.senderID
-     * @returns {Promise}
-     */
-    sendReaction({ reactionChannelUrl, reaction, participantId }: SendReactionOptions): any;
-    /**
-     * Make a network request to enable or disable reactions.
-     * @param {boolean} options.enable - determines if we need to enable or disable.
-     * @param {locusUrl} options.locusUrl
-     * @returns {Promise}
-     */
-    toggleReactions({ enable, locusUrl, requestingParticipantId }: ToggleReactionsOptions): any;
-}

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

@@ -1,11 +0,0 @@
-import { Reaction } from '../reactions/reactions.type';
-export type SendReactionOptions = {
-    reactionChannelUrl: string;
-    reaction: Reaction;
-    participantId: string;
-};
-export type ToggleReactionsOptions = {
-    enable: boolean;
-    locusUrl: string;
-    requestingParticipantId: string;
-};

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

@@ -1,9 +0,0 @@
-declare const MeetingStateMachine: {
-    /**
-     * Initializes the StateMachine for the meeting
-     * @param {Meeting} meetingRef A reference to a meeting instance
-     * @returns {StateMachine}
-     */
-    create(meetingRef: any): any;
-};
-export default MeetingStateMachine;

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

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

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

@@ -1,20 +0,0 @@
-import Collection from '../common/collection';
-/**
- * @class MeetingInfoCollection
- */
-export default class MeetingInfoCollection extends Collection {
-    namespace: string;
-    /**
-     * @memberof MeetingInfoCollection
-     * @constructor
-     * @public
-     */
-    constructor();
-    /**
-     * @param {String} id ID of the meeting info you wish to retreive
-     * @returns {MeetingInfo} returns a meeting info instance
-     * @public
-     * @memberof MeetingInfoCollection
-     */
-    get(id: string): any;
-}

package/dist/types/@webex/plugin-meetings/src/meeting-info/index.d.ts

@@ -1,57 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-/**
- * @class MeetingInfo
- */
-export default class MeetingInfo {
-    meetingInfoCollection: any;
-    meetingInfoRequest: any;
-    webex: any;
-    /**
-     *
-     * @param {WebexSDK} webex
-     */
-    constructor(webex: any);
-    /**
-     * @param {string} id
-     * @returns {object}
-     * @public
-     * @memberof MeetingInfo
-     */
-    getMeetingInfo(id: string): any;
-    /**
-     * @param {string} id
-     * @param {object} info
-     * @returns {null}
-     * @public
-     * @memberof MeetingInfo
-     */
-    setMeetingInfo(id: string, info: object): void;
-    /**
-     * Helper to make the actual MeetingInfo request and set the meetingInfo if successful, else reject
-     * @param {Object} options
-     * @returns {Promise}
-     * @private
-     * @memberof MeetingInfo
-     */
-    private requestFetchInfo;
-    /**
-     * Helper to generate the options for the MeetingInfo request
-     * @param {String} destination
-     * @param {String} type
-     * @returns {Promise}
-     * @private
-     * @memberof MeetingInfo
-     */
-    private fetchInfoOptions;
-    /**
-     * Fetches meeting info from the server
-     * @param {String} destination one of many different types of destinations to look up info for
-     * @param {String} [type] to match up with the destination value
-     * @returns {Promise} returns a meeting info object
-     * @public
-     * @memberof MeetingInfo
-     */
-    fetchMeetingInfo(destination: string, type?: string): any;
-}

package/dist/types/@webex/plugin-meetings/src/meeting-info/meeting-info-v2.d.ts

@@ -1,93 +0,0 @@
-/**
- * Error to indicate that wbxappapi requires a password
- */
-export declare class MeetingInfoV2PasswordError 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 generating a adhoc space meeting
- */
-export declare class MeetingInfoV2AdhocMeetingError extends Error {
-    sdkMessage: any;
-    wbxAppApiCode: any;
-    /**
-     *
-     * @constructor
-     * @param {Number} [wbxAppApiErrorCode]
-     * @param {String} [message]
-     */
-    constructor(wbxAppApiErrorCode?: number, message?: string);
-}
-/**
- * Error to indicate that preferred webex site not present to start adhoc meeting
- */
-export declare class MeetingInfoV2CaptchaError extends Error {
-    captchaInfo: any;
-    isPasswordRequired: any;
-    sdkMessage: any;
-    wbxAppApiCode: any;
-    body: any;
-    /**
-     *
-     * @constructor
-     * @param {Number} [wbxAppApiErrorCode]
-     * @param {Object} [captchaInfo]
-     * @param {String} [message]
-     */
-    constructor(wbxAppApiErrorCode?: number, captchaInfo?: object, message?: string);
-}
-/**
- * @class MeetingInfo
- */
-export default class MeetingInfoV2 {
-    webex: any;
-    /**
-     *
-     * @param {WebexSDK} webex
-     */
-    constructor(webex: any);
-    /**
-     * converts hydra id into conversation url and persons Id
-     * @param {String} destination one of many different types of destinations to look up info for
-     * @param {String} [type] to match up with the destination value
-     * @returns {Promise} destination and type
-     * @public
-     * @memberof MeetingInfo
-     */
-    fetchInfoOptions(destination: string, type?: string): any;
-    /**
-     * Creates adhoc space meetings for a space by fetching the conversation infomation
-     * @param {String} conversationUrl conversationUrl to start adhoc meeting on
-     * @returns {Promise} returns a meeting info object
-     * @public
-     * @memberof MeetingInfo
-     */
-    createAdhocSpaceMeeting(conversationUrl: string): Promise<any>;
-    /**
-     * Fetches meeting info from the server
-     * @param {String} destination one of many different types of destinations to look up info for
-     * @param {String} [type] to match up with the destination value
-     * @param {String} password
-     * @param {Object} captchaInfo
-     * @param {String} captchaInfo.code
-     * @param {String} captchaInfo.id
-     * @returns {Promise} returns a meeting info object
-     * @public
-     * @memberof MeetingInfo
-     */
-    fetchMeetingInfo(destination: string, type?: string, password?: string, captchaInfo?: {
-        code: string;
-        id: string;
-    }): Promise<any>;
-}

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

@@ -1,22 +0,0 @@
-/**
- * @class MeetingInfoRequest
- */
-export default class MeetingInfoRequest {
-    webex: any;
-    /**
-     * Meeting Info Request Constructor
-     * @param {WebexSDK} webex
-     */
-    constructor(webex: any);
-    /**
-     *
-     * @param {Object} options with format of {type: String, desintation: String}
-     * where type is PERSONAL_ROOM, SIP_URI, CONVERSATION_URL, and destination is userId, sipUri, conversationUrl respectively
-     * type can also be specified as an option and be of the list SIP_URI,MEETING_ID,LOCUS_ID,PERSONAL_ROOM,MEETING_LINK,ONE_ON_ONE,MEDIA_SIP_URI,CONVERSATION_URL,TEMP_SIP_URI
-     * with the desination matching
-     * @returns {Promise} returns a promise that resolves/rejects the result of the request
-     * @throws {Error} if the options are not valid and complete
-     * @memberof MeetingInfoRequest
-     */
-    fetchMeetingInfo(options: any): any;
-}

package/dist/types/@webex/plugin-meetings/src/meeting-info/util.d.ts

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

package/dist/types/@webex/plugin-meetings/src/meeting-info/utilv2.d.ts

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

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

@@ -1,23 +0,0 @@
-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;
-}