@webex/plugin-meetings 3.1.0 → 3.2.0

package/dist/types/meeting/voicea-meeting.d.ts

@@ -0,0 +1,17 @@
+import { type MeetingTranscriptPayload } from '@webex/internal-plugin-voicea';
+export declare const getSpeaker: (members: any, csis?: any[]) => unknown;
+export declare const getSpeakerFromProxyOrStore: ({ csisKey, meetingMembers, transcriptData }: {
+    csisKey: any;
+    meetingMembers: any;
+    transcriptData: any;
+}) => {
+    speaker: {
+        speakerId: string;
+        name: string;
+    };
+    needsCaching: boolean;
+};
+export declare const processNewCaptions: ({ data, meeting, }: {
+    data: MeetingTranscriptPayload;
+    meeting: any;
+}) => void;

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

@@ -0,0 +1,20 @@
+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/meeting-info/index.d.ts

@@ -0,0 +1,69 @@
+/*!
+ * 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
+     * @param {String} [password] meeting password
+     * @param {Object} [captchaInfo] captcha code and id
+     * @param {String} [installedOrgID]
+     * @param {String} [locusId]
+     * @param {Object} [extraParams]
+     * @param {Boolean} [options] meeting Id and whether Call Analyzer events should be sent
+     * @returns {Promise} returns a meeting info object
+     * @public
+     * @memberof MeetingInfo
+     */
+    fetchMeetingInfo(destination: string, type?: string, password?: string, captchaInfo?: {
+        code: string;
+        id: string;
+    }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
+        meetingId?: string;
+        sendCAevents?: boolean;
+    }): Promise<any>;
+}

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

@@ -0,0 +1,123 @@
+/**
+ * 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 preventing join because of a meeting policy
+ */
+export declare class MeetingInfoV2PolicyError extends Error {
+    meetingInfo: object;
+    sdkMessage: string;
+    wbxAppApiCode: number;
+    /**
+     *
+     * @constructor
+     * @param {Number} [wbxAppApiErrorCode]
+     * @param {Object} [meetingInfo]
+     * @param {String} [message]
+     */
+    constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, 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): Promise<any>;
+    /**
+     * Raises a MeetingInfoV2PolicyError for policy error codes
+     * @param {any} err the error from the request
+     * @returns {void}
+     */
+    handlePolicyError: (err: any) => void;
+    /**
+     * Creates adhoc space meetings for a space by fetching the conversation infomation
+     * @param {String} conversationUrl conversationUrl to start adhoc meeting on
+     * @param {String} installedOrgID org ID of user's machine
+     * @returns {Promise} returns a meeting info object
+     * @public
+     * @memberof MeetingInfo
+     */
+    createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: 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
+     * @param {String} installedOrgID org ID of user's machine
+     * @param {String} locusId
+     * @param {Object} extraParams
+     * @param {Object} options
+     * @returns {Promise} returns a meeting info object
+     * @public
+     * @memberof MeetingInfo
+     */
+    fetchMeetingInfo(destination: string, type?: string, password?: string, captchaInfo?: {
+        code: string;
+        id: string;
+    }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
+        meetingId?: string;
+        sendCAevents?: boolean;
+    }): Promise<any>;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * @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/meeting-info/util.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+import url from 'url';
+/**
+ * @class MeetingInfoUtil
+ */
+export default class MeetingInfoUtil {
+    static extractDestination(destination: any, type: any): any;
+    static getParsedUrl(link: any): false | url.UrlWithStringQuery;
+    /**
+     * Helper function to check if a string matches a known meeting link pattern
+     * @param {String} value  string to parse and see if it matches a meeting link
+     * @returns {Boolean}
+     */
+    static isMeetingLink(value: string): any;
+    static isConversationUrl(value: any, webex: any): any;
+    static convertLinkToSip(value: any): string;
+    static isSipUri(sipString: any): RegExpExecArray;
+    static isPhoneNumber(phoneNumber: any): boolean;
+    static getHydraId(destination: any): {
+        room: boolean;
+        destination: any;
+        cluster: any;
+        people?: undefined;
+    } | {
+        people: boolean;
+        destination: any;
+        cluster: any;
+        room?: undefined;
+    } | {
+        room?: undefined;
+        destination?: undefined;
+        cluster?: undefined;
+        people?: undefined;
+    };
+    static getSipUriFromHydraPersonId(destination: any, webex: any): any;
+    static generateOptions(from: any): Promise<any>;
+    /**
+     * Helper function to build up a correct locus url depending on the value passed
+     * @param {String} type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
+     * @param {Object} value ?? value.value
+     * @returns {Object} returns an object with {resource, method}
+     */
+    static getResourceUrl(type: string, value: any): {
+        uri: any;
+        resource: string;
+        method: string;
+    };
+    static getRequestParams(resourceOptions: any, type: any, value: any, api: any): any;
+}

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

@@ -0,0 +1,65 @@
+/// <reference types="node" />
+import url from 'url';
+/**
+ * @class MeetingInfoUtil
+ */
+export default class MeetingInfoUtil {
+    static meetingInfoError: string;
+    static getParsedUrl(link: any): false | url.UrlWithStringQuery;
+    /**
+     * Helper function to check if a string matches a known meeting link pattern
+     * @param {String} value  string to parse and see if it matches a meeting link
+     * @returns {Boolean}
+     */
+    static isMeetingLink(value: string): any;
+    static isConversationUrl(value: any, webex: any): any;
+    static isSipUri(sipString: any): RegExpExecArray;
+    static isPhoneNumber(phoneNumber: any): boolean;
+    static getHydraId(destination: any): {
+        room: boolean;
+        destination: any;
+        cluster: any;
+        people?: undefined;
+    } | {
+        people: boolean;
+        destination: any;
+        cluster: any;
+        room?: undefined;
+    } | {
+        room?: undefined;
+        destination?: undefined;
+        cluster?: undefined;
+        people?: undefined;
+    };
+    static getSipUriFromHydraPersonId(destination: any, webex: any): any;
+    static getDestinationType(from: any): Promise<any>;
+    /**
+     * Helper function to build up a correct locus url depending on the value passed
+     * @param {Object} options type and value to fetch meeting info
+     * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
+     * @param {String} options.installedOrgID org ID of user's machine
+     * @param {Object} options.destination ?? value.value
+     * @returns {Object} returns an object with {resource, method}
+     */
+    static getRequestBody(options: {
+        type: string;
+        destination: object;
+    } | any): any;
+    /**
+     * Helper function to parse the webex site/host from a URI string.
+     * @param {String} uri string (e.g. '10019857020@convergedats.webex.com')
+     * @returns {String} the site/host part of the URI string (e.g. 'convergedats.webex.com')
+     */
+    static getWebexSite(uri: string): string;
+    /**
+     * Helper function to return the direct URI for fetching meeting info (to avoid a redirect).
+     * @param {Object} options type and value to fetch meeting info
+     * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
+     * @param {Object} options.destination ?? value.value
+     * @returns {String} returns a URI string or null of there is no direct URI
+     */
+    static getDirectMeetingInfoURI(options: {
+        type: string;
+        destination: any;
+    }): string;
+}

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

@@ -0,0 +1,40 @@
+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;
+    /**
+     * get a specific meeting searching for key
+     * @param {String} breakoutUrl
+     * @returns {Meeting} if found, else returns null
+     * @public
+     * @memberof MeetingCollection
+     */
+    getActiveBreakoutLocus(breakoutUrl: string): any;
+    /**
+     * Gets the meeting that has a webrtc media connection
+     * NOTE: this function assumes there is no more than 1 such meeting
+     *
+     * @returns {Meeting} first meeting found, else undefined
+     * @public
+     * @memberof MeetingCollection
+     */
+    getActiveWebrtcMeeting(): any;
+}