@webex/jsdoctrinetest 3.0.0-bnr.5 → 3.0.0

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

@@ -1,297 +0,0 @@
-import '@webex/internal-plugin-mercury';
-import '@webex/internal-plugin-conversation';
-import { WebexPlugin } from '@webex/webex-core';
-import 'webrtc-adapter';
-/**
- * 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: any;
-    registered: any;
-    request: any;
-    geoHintInfo: any;
-    meetingInfo: any;
-    namespace: string;
-    /**
-     * Initializes the Meetings Plugin
-     * @constructor
-     * @public
-     * @memberof Meetings
-     */
-    constructor(...args: 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 enable or disable TURN discovery
-     * @param {Boolean} enable
-     * @private
-     * @memberof Meetings
-     * @returns {undefined}
-     */
-    private _toggleTurnDiscovery;
-    /**
-     * 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;
-    /**
-     * 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?: {
-        callStart?: string;
-        feedbackId?: string;
-        locusId?: string;
-        correlationId?: string;
-        meetingId?: string;
-        userId?: string;
-        orgId?: string;
-    }): any;
-    /**
-     * initializes the reachability instance for Meetings
-     * @returns {undefined}
-     * @public
-     * @memberof Meetings
-     */
-    setReachability(): void;
-    /**
-     * gets the reachability instance for Meetings
-     * @returns {Reachability}
-     * @public
-     * @memberof Meetings
-     */
-    getReachability(): any;
-    /**
-     * initializes and starts gathering reachability for Meetings
-     * @returns {Promise}
-     * @public
-     * @memberof Meetings
-     */
-    startReachability(): any;
-    /**
-     * 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.
-     * @param {string} destination - sipURL, spaceId, 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
-     * @returns {Promise<Meeting>} A new Meeting.
-     * @public
-     * @memberof Meetings
-     */
-    create(destination: string, type?: string, useRandomDelayForInfo?: boolean): 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
-     * @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;
-    /**
-     * 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;
-}

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

@@ -1,27 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-/**
- * @class MeetingRequest
- */
-export default class MeetingRequest extends StatelessWebexPlugin {
-    /**
-     *  get all the active meetings for the user
-     * @returns {Array} return locus array
-     */
-    getActiveMeetings(): any;
-    /**
-     *  fetch geoHit for the user
-     * @returns {Promise<object>} geoHintInfo
-     */
-    fetchGeoHint(): any;
-    /**
-     * get user meeting preference information
-     * @returns {Promise<object>} getMeetingPreferences
-     */
-    getMeetingPreferences(): any;
-    /**
-     *  Fetches indivdual locus rather then getting all at once
-     * @param {object} responseBody determine the locus and fetch them if a remoteUrl is given
-     * @returns {Promise}  returns locusObject array
-     */
-    determineRedirections(responseBody: any): Promise<any>;
-}

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

@@ -1,18 +0,0 @@
-/**
- * Meetings Media Codec Missing Event
- * Emitted when H.264 codec is not
- * found in the browser.
- * @event media:codec:missing
- * @instance
- * @memberof MeetingsUtil
- */
-/**
- * Meetings Media Codec Loaded Event
- * Emitted when H.264 codec has been
- * loaded in the browser.
- * @event media:codec:loaded
- * @instance
- * @memberof MeetingsUtil
- */
-declare const MeetingsUtil: any;
-export default MeetingsUtil;

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

@@ -1,146 +0,0 @@
-/**
- * @class Member
- */
-export default class Member {
-    associatedUser: any;
-    id: any;
-    isAudioMuted: any;
-    isContentSharing: any;
-    isDevice: any;
-    isGuest: any;
-    isHandRaised: any;
-    isHost: any;
-    isInLobby: any;
-    isInMeeting: any;
-    isModerator: any;
-    isModeratorAssignmentProhibited: any;
-    isMutable: any;
-    isNotAdmitted: any;
-    isRecording: any;
-    isRemovable: any;
-    isSelf: any;
-    isUser: any;
-    isVideoMuted: any;
-    name: any;
-    participant: any;
-    status: any;
-    supportsBreakouts: boolean;
-    type: any;
-    namespace: string;
-    /**
-     * @param {Object} participant - the locus participant
-     * @param {Object} [options] - constructor params
-     * @param {String} options.selfId
-     * @param {String} options.hostId
-     * @param {String} options.contentSharingId
-     * @param {String} options.type
-     * @returns {Member}
-     * @memberof Member
-     */
-    constructor(participant: object, options?: {
-        selfId: string;
-        hostId: string;
-        contentSharingId: string;
-        type: string;
-    } | any);
-    /**
-     * set all the participant values extracted directly from locus participant
-     * @param {Object} participant the locus participant object
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processParticipant;
-    /**
-     * Use the members options and participant values to set on the member
-     * @param {Object} participant the locus participant object
-     * @param {Object} options the passed in options, what was set on members
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processParticipantOptions;
-    /**
-     * processes what already exists on the member to determine other info about the member
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processMember;
-    /**
-     * set the status on member object
-     * @param {Object} participant the locus participant object
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processStatus;
-    /**
-     * set the isContentSharing on member
-     * @param {Boolean} flag
-     * @returns {undefined}
-     * @public
-     * @memberof Member
-     */
-    setIsContentSharing(flag: boolean): void;
-    /**
-     * set the isHost on member
-     * @param {Boolean} flag
-     * @returns {undefined}
-     * @public
-     * @memberof Member
-     */
-    setIsHost(flag: boolean): void;
-    /**
-     * set the isSelf on member
-     * @param {Boolean} flag
-     * @returns {undefined}
-     * @public
-     * @memberof Member
-     */
-    setIsSelf(flag: boolean): void;
-    /**
-     * determine if this member is content sharing
-     * @param {Object} participant
-     * @param {String} sharingId
-     * @returns {undefined}
-     * @public
-     * @memberof Member
-     */
-    processIsContentSharing(participant: object, sharingId: string): void;
-    /**
-     * Determine if this member is recording
-     * @param {Object} participant
-     * @param {String} recordingId
-     * @returns {undefined}
-     * @public
-     * @memberof Member
-     */
-    processIsRecording(participant: object, recordingId: string): void;
-    /**
-     * determine if this member is the self
-     * @param {Object} participant
-     * @param {String} selfId
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processIsSelf;
-    /**
-     * determine if this member is the host
-     * @param {Object} participant
-     * @param {String} hostId
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processIsHost;
-    /**
-     * set the type for the member, could be MEETING or CALL
-     * @param {String} type
-     * @returns {undefined}
-     * @private
-     * @memberof Member
-     */
-    private processType;
-}

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

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

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

@@ -1,24 +0,0 @@
-/**
- * @class MembersCollection
- */
-export default class MembersCollection {
-    members: any;
-    namespace: string;
-    /**
-     * @param {Object} locus
-     * @memberof Members
-     */
-    constructor();
-    set(id: any, member: any): void;
-    setAll(members: any): void;
-    /**
-     * @param {String} id
-     * @returns {Member}
-     */
-    get(id: string): any;
-    /**
-     * @returns {Object} returns an object map of Member instances
-     * @memberof MembersCollection
-     */
-    getAll(): any;
-}