@webex/plugin-meetings 3.7.0 → 3.8.0

package/dist/meeting/request.d.ts

@@ -0,0 +1,295 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
+import { SendReactionOptions, ToggleReactionsOptions } from './request.type';
+import { AnnotationInfo } from '../annotation/annotation.types';
+/**
+ * @class MeetingRequest
+ */
+export default class MeetingRequest extends StatelessWebexPlugin {
+    changeVideoLayoutDebounced: any;
+    meetingRef: WeakRef<any>;
+    locusDeltaRequest: (options: object) => Promise<any>;
+    buildLocusDeltaRequestOptions: (options: object) => Promise<any>;
+    /**
+     * Constructor
+     * @param {Object} attrs
+     * @param {Object} options
+     */
+    constructor(attrs: any, options: any);
+    /**
+     * Returns joinCookie from boundedStorage if present.
+     * @returns {Object} joinCookie
+     */
+    private getJoinCookie;
+    /**
+     * 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
+     * @param {String} options.locale,
+     * @param {Array} options.deviceCapabilities
+     * @param {boolean} options.liveAnnotationSupported
+     * @param {String} options.alias
+     * @returns {Promise}
+     */
+    joinMeeting(options: {
+        sipUri: string;
+        deviceUrl: string;
+        locusUrl: string;
+        locusClusterUrl: 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;
+        reachability: any;
+        breakoutsSupported: boolean;
+        locale?: string;
+        deviceCapabilities?: Array<string>;
+        liveAnnotationSupported: boolean;
+        ipVersion?: IP_VERSION;
+        alias?: string;
+    }): 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;
+    /**
+     * Sends a requests to get the latest locus DTO, it might be a full Locus or a delta, depending on the url provided
+     * @param {Object} options
+     * @param {String} options.locusUrl sync url to get ht elatest locus delta
+     * @returns {Promise}
+     */
+    getLocusDTO(options: {
+        url: 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;
+    /**
+     * Prepares request options to 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 {Object} request options
+     */
+    prepareLeaveMeetingRequestOptions({ locusUrl, selfId, deviceUrl: url, resourceId, correlationId, }: {
+        locusUrl: string;
+        selfId: string;
+        deviceUrl: string;
+        resourceId: string;
+        correlationId: string;
+    }): {
+        method: string;
+        uri: string;
+        body: {
+            device: {
+                deviceType: any;
+                url: string;
+            };
+            usingResource: string;
+            correlationId: string;
+        };
+    };
+    /**
+     * Make a network request to leave a meeting
+     * @param {Object} options
+     * @returns {Promise}
+     */
+    leaveMeeting({ locusUrl, selfId, deviceUrl: url, resourceId, correlationId, }: {
+        locusUrl: string;
+        selfId: string;
+        deviceUrl: string;
+        resourceId: string;
+        correlationId: string;
+    }): Promise<any>;
+    /**
+     * Builds request options to leave a meeting
+     * @param {Object} options
+     * @returns {Object} request options
+     */
+    buildLeaveMeetingRequestOptions(options: any): Promise<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;
+    }): Promise<any>;
+    /**
+     * Makes a network request to lock the meeting
+     * @param {Object} options
+     * @param {Boolean} options.lock Whether it is locked or not
+     * @returns {Promise}
+     */
+    lockMeeting(options: any): Promise<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;
+    }): Promise<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
+     * @param {String} options.shareInstanceId id for current share
+     * @returns {Promise}
+     */
+    changeMeetingFloor(options: {
+        disposition: string;
+        personUrl: string;
+        deviceUrl: string;
+        resourceId: string;
+        uri: string;
+        annotationInfo: AnnotationInfo;
+        shareInstanceId: 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;
+    }): Promise<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;
+        };
+    }): Promise<any>;
+    /**
+     * Make a network request to end meeting for all
+     * @param {Object} options
+     * @param {Url} options.locusUrl
+     * @returns {Promise}
+     */
+    endMeetingForAll({ locusUrl }: {
+        locusUrl: string;
+    }): Promise<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): Promise<any>;
+    getLocusStatusByUrl(locusUrl: string): any;
+}

package/dist/meeting/request.js

@@ -131,17 +131,13 @@ var MeetingRequest = exports.default = /*#__PURE__*/function (_StatelessWebexPlu
      */
     function () {
       var _joinMeeting = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(options) {
-        var asResourceOccupant, inviteeAddress, meetingNumber, permissionToken, deviceUrl, locusUrl, locusClusterUrl, resourceId, correlationId, ensureConversation, moderator, pin, moveToResource, roapMessage, reachability, preferTranscoding, breakoutsSupported, locale, _options$deviceCapabi, deviceCapabilities, liveAnnotationSupported, ipVersion, alias, url, joinCookie, body, clusterUrl;
+        var asResourceOccupant, inviteeAddress, meetingNumber, permissionToken, deviceUrl, locusUrl, locusClusterUrl, resourceId, correlationId, ensureConversation, moderator, pin, moveToResource, roapMessage, reachability, breakoutsSupported, locale, _options$deviceCapabi, deviceCapabilities, liveAnnotationSupported, clientMediaPreferences, alias, url, body, clusterUrl;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
-              asResourceOccupant = options.asResourceOccupant, inviteeAddress = options.inviteeAddress, meetingNumber = options.meetingNumber, permissionToken = options.permissionToken, deviceUrl = options.deviceUrl, locusUrl = options.locusUrl, locusClusterUrl = options.locusClusterUrl, resourceId = options.resourceId, correlationId = options.correlationId, ensureConversation = options.ensureConversation, moderator = options.moderator, pin = options.pin, moveToResource = options.moveToResource, roapMessage = options.roapMessage, reachability = options.reachability, preferTranscoding = options.preferTranscoding, breakoutsSupported = options.breakoutsSupported, locale = options.locale, _options$deviceCapabi = options.deviceCapabilities, deviceCapabilities = _options$deviceCapabi === void 0 ? [] : _options$deviceCapabi, liveAnnotationSupported = options.liveAnnotationSupported, ipVersion = options.ipVersion, alias = options.alias;
+              asResourceOccupant = options.asResourceOccupant, inviteeAddress = options.inviteeAddress, meetingNumber = options.meetingNumber, permissionToken = options.permissionToken, deviceUrl = options.deviceUrl, locusUrl = options.locusUrl, locusClusterUrl = options.locusClusterUrl, resourceId = options.resourceId, correlationId = options.correlationId, ensureConversation = options.ensureConversation, moderator = options.moderator, pin = options.pin, moveToResource = options.moveToResource, roapMessage = options.roapMessage, reachability = options.reachability, breakoutsSupported = options.breakoutsSupported, locale = options.locale, _options$deviceCapabi = options.deviceCapabilities, deviceCapabilities = _options$deviceCapabi === void 0 ? [] : _options$deviceCapabi, liveAnnotationSupported = options.liveAnnotationSupported, clientMediaPreferences = options.clientMediaPreferences, alias = options.alias;
               _loggerProxy.default.logger.info('Meeting:request#joinMeeting --> Joining a meeting', correlationId);
               url = '';
-              _context2.next = 5;
-              return this.getJoinCookie();
-            case 5:
-              joinCookie = _context2.sent;
               body = {
                 asResourceOccupant: asResourceOccupant,
                 device: {
@@ -156,11 +152,7 @@ var MeetingRequest = exports.default = /*#__PURE__*/function (_StatelessWebexPlu
                 allowMultiDevice: true,
                 ensureConversation: ensureConversation || false,
                 supportsNativeLobby: 1,
-                clientMediaPreferences: {
-                  preferTranscoding: preferTranscoding !== null && preferTranscoding !== void 0 ? preferTranscoding : true,
-                  joinCookie: joinCookie,
-                  ipver: ipVersion
-                }
+                clientMediaPreferences: clientMediaPreferences
               };
               if (alias) {
                 body.alias = alias;
@@ -206,44 +198,44 @@ var MeetingRequest = exports.default = /*#__PURE__*/function (_StatelessWebexPlu
                 body.pin = pin;
               }
               if (!locusUrl) {
-                _context2.next = 21;
+                _context2.next = 18;
                 break;
               }
               url = "".concat(locusUrl, "/").concat(_constants.PARTICIPANT);
-              _context2.next = 38;
+              _context2.next = 35;
               break;
-            case 21:
+            case 18:
               if (!(inviteeAddress || meetingNumber)) {
-                _context2.next = 38;
+                _context2.next = 35;
                 break;
               }
-              _context2.prev = 22;
+              _context2.prev = 19;
               if (!locusClusterUrl) {
-                _context2.next = 27;
+                _context2.next = 24;
                 break;
               }
               clusterUrl = "https://".concat(locusClusterUrl, "/locus/api/v1");
-              _context2.next = 30;
+              _context2.next = 27;
               break;
-            case 27:
-              _context2.next = 29;
+            case 24:
+              _context2.next = 26;
               return this.webex.internal.services.waitForCatalog('postauth');
-            case 29:
+            case 26:
               // @ts-ignore
               clusterUrl = this.webex.internal.services.get('locus');
-            case 30:
+            case 27:
               url = "".concat(clusterUrl, "/").concat(_constants.LOCI, "/").concat(_constants.CALL);
               body.invitee = {
                 address: inviteeAddress || "wbxmn:".concat(meetingNumber)
               };
-              _context2.next = 38;
+              _context2.next = 35;
               break;
-            case 34:
-              _context2.prev = 34;
-              _context2.t0 = _context2["catch"](22);
+            case 31:
+              _context2.prev = 31;
+              _context2.t0 = _context2["catch"](19);
               _loggerProxy.default.logger.error("Meeting:request#joinMeeting Error Joining ".concat(inviteeAddress || meetingNumber, " --> ").concat(_context2.t0));
               throw _context2.t0;
-            case 38:
+            case 35:
               // TODO: -- this will be resolved in SDK request
               url = url.concat("?".concat(_constants.ALTERNATE_REDIRECT_TRUE));
               if (resourceId === inviteeAddress) {
@@ -266,11 +258,11 @@ var MeetingRequest = exports.default = /*#__PURE__*/function (_StatelessWebexPlu
                 uri: url,
                 body: body
               }));
-            case 42:
+            case 39:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[22, 34]]);
+        }, _callee2, this, [[19, 31]]);
       }));
       function joinMeeting(_x) {
         return _joinMeeting.apply(this, arguments);
@@ -847,6 +839,36 @@ var MeetingRequest = exports.default = /*#__PURE__*/function (_StatelessWebexPlu
         uri: locusUrl
       });
     }
+
+    /**
+     * 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}
+     */
+  }, {
+    key: "setBrb",
+    value: function setBrb(_ref14) {
+      var enabled = _ref14.enabled,
+        locusUrl = _ref14.locusUrl,
+        deviceUrl = _ref14.deviceUrl,
+        selfId = _ref14.selfId;
+      var uri = "".concat(locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(selfId, "/").concat(_constants.CONTROLS);
+      return this.locusDeltaRequest({
+        method: _constants.HTTP_VERBS.PATCH,
+        uri: uri,
+        body: {
+          brb: {
+            enabled: enabled,
+            deviceUrl: deviceUrl
+          }
+        }
+      });
+    }
   }]);
   return MeetingRequest;
 }(_webexCore.StatelessWebexPlugin);