@webex/plugin-rooms 2.59.3-next.1 → 2.59.4

package/dist/rooms.js

@@ -30,53 +30,53 @@ function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
 var debug = require('debug')('rooms');
 
-/**
- * @typedef {Object} RoomObject
- * @property {string} id - (server generated) Unique identifier for the room
- * @property {string} title - The display name for the room. All room members
- * will see the title so make it something good
- * @property {string} teamId - (optional) The ID of the team to which the room
- * belongs
- * @property {isoDate} created - (server generated) The date and time that the
- * room was created
+/**
+ * @typedef {Object} RoomObject
+ * @property {string} id - (server generated) Unique identifier for the room
+ * @property {string} title - The display name for the room. All room members
+ * will see the title so make it something good
+ * @property {string} teamId - (optional) The ID of the team to which the room
+ * belongs
+ * @property {isoDate} created - (server generated) The date and time that the
+ * room was created
  */
 
-/**
- * Rooms are virtual meeting places for getting stuff done. This resource
- * represents the room itself. Check out the {@link Memberships} API to learn
- * how to add and remove people from rooms and the {@link Messages} API for
- * posting and managing content.
- * @class
- * @name Rooms
+/**
+ * Rooms are virtual meeting places for getting stuff done. This resource
+ * represents the room itself. Check out the {@link Memberships} API to learn
+ * how to add and remove people from rooms and the {@link Messages} API for
+ * posting and managing content.
+ * @class
+ * @name Rooms
  */
 var Rooms = _webexCore.WebexPlugin.extend({
-  /**
-   * Register to listen for incoming rooms events
-   * This is an alternate approach to registering for rooms webhooks.
-   * The events passed to any registered handlers will be similar to the webhook JSON,
-   * but will omit webhook specific fields such as name, secret, url, etc.
-   * To utilize the `listen()` method, the authorization token used
-   * will need to have `spark:all` and `spark:kms` scopes enabled.
-   * Note that by configuring your application to enable or disable `spark:all`
-   * via its configuration page will also enable or disable `spark:kms`.
-   * See the <a href="https://webex.github.io/webex-js-sdk/samples/browser-socket/">Sample App</a>
-   * for more details.
-   * @instance
-   * @memberof Rooms
-   * @returns {Promise}
-   * @example
-   * webex.rooms.listen()
-   *   .then(() => {
-   *     console.log('listening to room events');
-   *     webex.rooms.on('created', (event) => console.log(`Got a room:created event:\n${event}`);
-   *     webex.rooms.on('updated', (event) => console.log(`Got a room:updated event:\n${event}`);
-   *   })
-   *   .catch((e) => console.error(`Unable to register for room events: ${e}`));
-   * // Some app logic...
-   * // WHen it is time to cleanup
-   * webex.rooms.stopListening();
-   * webex.rooms.off('created');
-   * webex.rooms.off('updated');
+  /**
+   * Register to listen for incoming rooms events
+   * This is an alternate approach to registering for rooms webhooks.
+   * The events passed to any registered handlers will be similar to the webhook JSON,
+   * but will omit webhook specific fields such as name, secret, url, etc.
+   * To utilize the `listen()` method, the authorization token used
+   * will need to have `spark:all` and `spark:kms` scopes enabled.
+   * Note that by configuring your application to enable or disable `spark:all`
+   * via its configuration page will also enable or disable `spark:kms`.
+   * See the <a href="https://webex.github.io/webex-js-sdk/samples/browser-socket/">Sample App</a>
+   * for more details.
+   * @instance
+   * @memberof Rooms
+   * @returns {Promise}
+   * @example
+   * webex.rooms.listen()
+   *   .then(() => {
+   *     console.log('listening to room events');
+   *     webex.rooms.on('created', (event) => console.log(`Got a room:created event:\n${event}`);
+   *     webex.rooms.on('updated', (event) => console.log(`Got a room:updated event:\n${event}`);
+   *   })
+   *   .catch((e) => console.error(`Unable to register for room events: ${e}`));
+   * // Some app logic...
+   * // WHen it is time to cleanup
+   * webex.rooms.stopListening();
+   * webex.rooms.off('created');
+   * webex.rooms.off('updated');
    */
   listen: function listen() {
     var _this = this;
@@ -89,25 +89,25 @@ var Rooms = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /**
-   * Creates a new room. The authenticated user is automatically added as a
-   * member of the room. See the {@link Memberships} API to learn how to add
-   * more people to the room.
-   * @instance
-   * @memberof Rooms
-   * @param {RoomObject} room
-   * @returns {Promise<RoomObject>}
-   * @example
-   * webex.rooms.create({title: 'Create Room Example'})
-   *   .then(function(room) {
-   *     var assert = require('assert')
-   *     assert(typeof room.created === 'string');
-   *     assert(typeof room.id === 'string');
-   *     assert(room.title === 'Create Room Example');
-   *     console.log(room.title);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Creates a new room. The authenticated user is automatically added as a
+   * member of the room. See the {@link Memberships} API to learn how to add
+   * more people to the room.
+   * @instance
+   * @memberof Rooms
+   * @param {RoomObject} room
+   * @returns {Promise<RoomObject>}
+   * @example
+   * webex.rooms.create({title: 'Create Room Example'})
+   *   .then(function(room) {
+   *     var assert = require('assert')
+   *     assert(typeof room.created === 'string');
+   *     assert(typeof room.id === 'string');
+   *     assert(room.title === 'Create Room Example');
+   *     console.log(room.title);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   create: function create(room) {
     return this.request({
@@ -119,26 +119,26 @@ var Rooms = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Returns a single room.
-   * @instance
-   * @memberof Rooms
-   * @param {RoomObject|string} room
-   * @param {Object} options
-   * @returns {Promise<RoomObject>}
-   * @example
-   * var room;
-   * webex.rooms.create({title: 'Get Room Example'})
-   *   .then(function(r) {
-   *     room = r
-   *     return webex.rooms.get(room.id)
-   *   })
-   *   .then(function(r) {
-   *     var assert = require('assert');
-   *     assert.deepEqual(r, room);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Returns a single room.
+   * @instance
+   * @memberof Rooms
+   * @param {RoomObject|string} room
+   * @param {Object} options
+   * @returns {Promise<RoomObject>}
+   * @example
+   * var room;
+   * webex.rooms.create({title: 'Get Room Example'})
+   *   .then(function(r) {
+   *     room = r
+   *     return webex.rooms.get(room.id)
+   *   })
+   *   .then(function(r) {
+   *     var assert = require('assert');
+   *     assert.deepEqual(r, room);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   get: function get(room, options) {
     var id = room.id || room;
@@ -150,37 +150,37 @@ var Rooms = _webexCore.WebexPlugin.extend({
       return res.body.items || res.body;
     });
   },
-  /**
-   * Returns a list of rooms. In most cases the results will only contain rooms
-   * that the authenticated user is a member of.
-   * @instance
-   * @memberof Rooms
-   * @param {Object} options
-   * @param {Object} options.max Limit the maximum number of rooms in the
-   * response.
-   * @returns {Promise<Page<RoomObject>>}
-   * @example
-   * var createdRooms;
-   * Promise.all([
-   *   webex.rooms.create({title: 'List Rooms Example 1'}),
-   *   webex.rooms.create({title: 'List Rooms Example 2'}),
-   *   webex.rooms.create({title: 'List Rooms Example 3'})
-   * ])
-   *   .then(function(r) {
-   *     createdRooms = r;
-   *     return webex.rooms.list({max: 3})
-   *       .then(function(rooms) {
-   *         var assert = require('assert');
-   *         assert(rooms.length === 3);
-   *         for (var i = 0; i < rooms.items.length; i+= 1) {
-   *           assert(createdRooms.filter(function(room) {
-   *             return room.id === rooms.items[i].id;
-   *           }).length === 1);
-   *         }
-   *         return 'success';
-   *       });
-   *   });
-   *   // => success
+  /**
+   * Returns a list of rooms. In most cases the results will only contain rooms
+   * that the authenticated user is a member of.
+   * @instance
+   * @memberof Rooms
+   * @param {Object} options
+   * @param {Object} options.max Limit the maximum number of rooms in the
+   * response.
+   * @returns {Promise<Page<RoomObject>>}
+   * @example
+   * var createdRooms;
+   * Promise.all([
+   *   webex.rooms.create({title: 'List Rooms Example 1'}),
+   *   webex.rooms.create({title: 'List Rooms Example 2'}),
+   *   webex.rooms.create({title: 'List Rooms Example 3'})
+   * ])
+   *   .then(function(r) {
+   *     createdRooms = r;
+   *     return webex.rooms.list({max: 3})
+   *       .then(function(rooms) {
+   *         var assert = require('assert');
+   *         assert(rooms.length === 3);
+   *         for (var i = 0; i < rooms.items.length; i+= 1) {
+   *           assert(createdRooms.filter(function(room) {
+   *             return room.id === rooms.items[i].id;
+   *           }).length === 1);
+   *         }
+   *         return 'success';
+   *       });
+   *   });
+   *   // => success
    */
   list: function list(options) {
     var _this2 = this;
@@ -192,49 +192,49 @@ var Rooms = _webexCore.WebexPlugin.extend({
       return new _webexCore.Page(res, _this2.webex);
     });
   },
-  /**
-   * Returns a list of rooms with details about the data of the last
-   * activity in the room, and the date of the users last presences in
-   * the room. The list is sorted with this with most recent activity first
-   *
-   * For rooms where lastActivityDate > lastSeenDate the space
-   * can be considered to be "unread"
-   *
-   * This differs from the rooms.list() function in the following ways:
-   *  -- when called with no parameters it returns an array of all
-   *     spaces, up to 1000, that the user is a member of
-   *  -- pagination is not supported. ALL rooms are returned which
-   *     can result in a large payload
-   *  -- For users with hundreds of spaces, this API can take some time to
-   *     to return, for this reason it supports an optional maxRecent parameter.
-   *     If set this will return only the specified number of spaces with activity
-   *     in the last two weeks.  Recommended value is 30.  Max supported is 100.
-   *  -- only "id", "type", "lastActivityDate", and "lastSeenDate" are
-   *     guaranteed to be available for each room in the list
-   *  -- "title" is usually returned, but not guaranteed
-   *
-   * In general this function should be used only when the client needs to
-   * access read status info, for example on startup.
-   * After startup, clients should track message and membership:seen events
-   * to maintain read status client side.
-   *
-   * Since this API can take some time to return up to 1000 spaces, it is
-   * recommended that custom clients call this first with the maxRecent parameter
-   * set to 30, so that they can display some of the more recents spaces.  Calling
-   * this API a second time with no parameters will return all the spaces.
-   *
-   * Not all spaces may be returned, for example when users in more than 1000
-   * spaces, or when a new spaces is added after this function is called,
-   * but before it returns. Custom clients should be prepared to gracefully
-   * handle cases where an event occurs in a space not returned by this call,
-   * by querying rooms.getWithReadStatus() with the id of the room in question
-   *
-   * This function may be deprecated when this info is provided in the membership
-   * objects returned in the list function.
-   * @instance
-   * @param {int} maxRecent
-   * @memberof Rooms
-   * @returns {Promise<RoomInfoObjectList>}
+  /**
+   * Returns a list of rooms with details about the data of the last
+   * activity in the room, and the date of the users last presences in
+   * the room. The list is sorted with this with most recent activity first
+   *
+   * For rooms where lastActivityDate > lastSeenDate the space
+   * can be considered to be "unread"
+   *
+   * This differs from the rooms.list() function in the following ways:
+   *  -- when called with no parameters it returns an array of all
+   *     spaces, up to 1000, that the user is a member of
+   *  -- pagination is not supported. ALL rooms are returned which
+   *     can result in a large payload
+   *  -- For users with hundreds of spaces, this API can take some time to
+   *     to return, for this reason it supports an optional maxRecent parameter.
+   *     If set this will return only the specified number of spaces with activity
+   *     in the last two weeks.  Recommended value is 30.  Max supported is 100.
+   *  -- only "id", "type", "lastActivityDate", and "lastSeenDate" are
+   *     guaranteed to be available for each room in the list
+   *  -- "title" is usually returned, but not guaranteed
+   *
+   * In general this function should be used only when the client needs to
+   * access read status info, for example on startup.
+   * After startup, clients should track message and membership:seen events
+   * to maintain read status client side.
+   *
+   * Since this API can take some time to return up to 1000 spaces, it is
+   * recommended that custom clients call this first with the maxRecent parameter
+   * set to 30, so that they can display some of the more recents spaces.  Calling
+   * this API a second time with no parameters will return all the spaces.
+   *
+   * Not all spaces may be returned, for example when users in more than 1000
+   * spaces, or when a new spaces is added after this function is called,
+   * but before it returns. Custom clients should be prepared to gracefully
+   * handle cases where an event occurs in a space not returned by this call,
+   * by querying rooms.getWithReadStatus() with the id of the room in question
+   *
+   * This function may be deprecated when this info is provided in the membership
+   * objects returned in the list function.
+   * @instance
+   * @param {int} maxRecent
+   * @memberof Rooms
+   * @returns {Promise<RoomInfoObjectList>}
    */
   listWithReadStatus: function listWithReadStatus() {
     var _arguments = arguments,
@@ -279,36 +279,36 @@ var Rooms = _webexCore.WebexPlugin.extend({
       }, _callee);
     }))();
   },
-  /**
-   * Returns a single room object with details about the data of the last
-   * activity in the room, and the date of the users last presence in
-   * the room.
-   *
-   * For rooms where lastActivityDate > lastSeenDate the room
-   * can be considered to be "unread"
-   *
-   * This differs from the rooms.get() function in the following ways:
-   *  -- it takes a single roomId parameter to fetch
-   *  -- no other options are considered
-   *  -- only "id", "type", "lastActivityDate", and "lastSeenDate" are
-   *     guaranteed to be available in the return object
-   *  -- "title" is usually returned, but not guaranteed
-   *
-   * In general clients should use the listWithReadStatus() method on startup
-   * to get the initial roomStatus and then update their client side copy by
-   * responding to message, membership and room events.
-     * This function allows a custom client to be "nimble" if it is responding
-   * to an event with a roomId that was not in the original fetch.  The
-   * anticipated behavior is that getWithReadStats is called "just in time",
-   * with the resulting room object being added to the list of cached room
-   * objects on the client side.
-   *
-   * This function may be deprecated when this info is provided in the room
-   * object returned in the get function.
-   * @instance
-   * @memberof Rooms
-   * @param {string} roomId
-   * @returns {Promise<RoomInfoObject>}
+  /**
+   * Returns a single room object with details about the data of the last
+   * activity in the room, and the date of the users last presence in
+   * the room.
+   *
+   * For rooms where lastActivityDate > lastSeenDate the room
+   * can be considered to be "unread"
+   *
+   * This differs from the rooms.get() function in the following ways:
+   *  -- it takes a single roomId parameter to fetch
+   *  -- no other options are considered
+   *  -- only "id", "type", "lastActivityDate", and "lastSeenDate" are
+   *     guaranteed to be available in the return object
+   *  -- "title" is usually returned, but not guaranteed
+   *
+   * In general clients should use the listWithReadStatus() method on startup
+   * to get the initial roomStatus and then update their client side copy by
+   * responding to message, membership and room events.
+    * This function allows a custom client to be "nimble" if it is responding
+   * to an event with a roomId that was not in the original fetch.  The
+   * anticipated behavior is that getWithReadStats is called "just in time",
+   * with the resulting room object being added to the list of cached room
+   * objects on the client side.
+   *
+   * This function may be deprecated when this info is provided in the room
+   * object returned in the get function.
+   * @instance
+   * @memberof Rooms
+   * @param {string} roomId
+   * @returns {Promise<RoomInfoObject>}
    */
   getWithReadStatus: function getWithReadStatus(roomId) {
     var _this4 = this;
@@ -326,32 +326,32 @@ var Rooms = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /**
-   * Deletes a single room.
-   * @instance
-   * @memberof Rooms
-   * @param {RoomObject|string} room
-   * @returns {Promise}
-   * @example
-   * var room;
-   * webex.rooms.create({title: 'Remove Room Example'})
-   *  .then(function(r) {
-   *    room = r;
-   *    return webex.rooms.remove(room.id);
-   *  })
-   *  .then(function() {
-   *    return webex.rooms.get(room.id);
-   *  })
-   *  .then(function() {
-   *    var assert = require('assert');
-   *    assert(false, 'the previous get should have failed');
-   *  })
-   *  .catch(function(reason) {
-   *    var assert = require('assert');
-   *    assert.equal(reason.statusCode, 404);
-   *    return 'success'
-   *  });
-   *  // => success
+  /**
+   * Deletes a single room.
+   * @instance
+   * @memberof Rooms
+   * @param {RoomObject|string} room
+   * @returns {Promise}
+   * @example
+   * var room;
+   * webex.rooms.create({title: 'Remove Room Example'})
+   *  .then(function(r) {
+   *    room = r;
+   *    return webex.rooms.remove(room.id);
+   *  })
+   *  .then(function() {
+   *    return webex.rooms.get(room.id);
+   *  })
+   *  .then(function() {
+   *    var assert = require('assert');
+   *    assert(false, 'the previous get should have failed');
+   *  })
+   *  .catch(function(reason) {
+   *    var assert = require('assert');
+   *    assert.equal(reason.statusCode, 404);
+   *    return 'success'
+   *  });
+   *  // => success
    */
   remove: function remove(room) {
     var id = room.id || room;
@@ -368,29 +368,29 @@ var Rooms = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Used to update a single room's properties.
-   * @instance
-   * @memberof Rooms
-   * @param {RoomObject} room
-   * @returns {Promise<RoomObject>}
-   * @example
-   * var room;
-   * webex.rooms.update({title: 'Update Room Example'})
-   *   .then(function(r) {
-   *     room = r;
-   *     room.title = 'Update Room Example (Updated Title)';
-   *     return webex.rooms.update(room);
-   *   })
-   *   .then(function() {
-   *     return webex.rooms.get(room.id);
-   *   })
-   *   .then(function(room) {
-   *    var assert = require('assert');
-   *     assert.equal(room.title, 'Update Room Example (Updated Title)');
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Used to update a single room's properties.
+   * @instance
+   * @memberof Rooms
+   * @param {RoomObject} room
+   * @returns {Promise<RoomObject>}
+   * @example
+   * var room;
+   * webex.rooms.update({title: 'Update Room Example'})
+   *   .then(function(r) {
+   *     room = r;
+   *     room.title = 'Update Room Example (Updated Title)';
+   *     return webex.rooms.update(room);
+   *   })
+   *   .then(function() {
+   *     return webex.rooms.get(room.id);
+   *   })
+   *   .then(function(room) {
+   *    var assert = require('assert');
+   *     assert.equal(room.title, 'Update Room Example (Updated Title)');
+   *     return 'success';
+   *   });
+   *   // => success
    */
   update: function update(room) {
     var id = room.id;
@@ -403,14 +403,14 @@ var Rooms = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * This function is called when an internal membership events fires,
-   * if the user registered for these events with the listen() function.
-   * External users of the SDK should not call this function
-   * @private
-   * @memberof Rooms
-   * @param {Object} event
-   * @returns {void}
+  /**
+   * This function is called when an internal membership events fires,
+   * if the user registered for these events with the listen() function.
+   * External users of the SDK should not call this function
+   * @private
+   * @memberof Rooms
+   * @param {Object} event
+   * @returns {void}
    */
   onWebexApiEvent: function onWebexApiEvent(event) {
     var activity = event.data.activity;
@@ -438,16 +438,16 @@ var Rooms = _webexCore.WebexPlugin.extend({
         break;
     }
   },
-  /**
-   * Constructs the data object for an event on the rooms resource,
-   * adhering to Hydra's Webhook data structure.
-   * External users of the SDK should not call this function
-   * @private
-   * @memberof Rooms
-   * @param {Object} webex sdk instance
-   * @param {Object} activity from mercury
-   * @param {Object} event type of "webhook" event
-   * @returns {Object} constructed event
+  /**
+   * Constructs the data object for an event on the rooms resource,
+   * adhering to Hydra's Webhook data structure.
+   * External users of the SDK should not call this function
+   * @private
+   * @memberof Rooms
+   * @param {Object} webex sdk instance
+   * @param {Object} activity from mercury
+   * @param {Object} event type of "webhook" event
+   * @returns {Object} constructed event
    */
   getRoomEvent: function getRoomEvent(webex, activity, event) {
     try {
@@ -490,24 +490,24 @@ var Rooms = _webexCore.WebexPlugin.extend({
       return null;
     }
   },
-  version: "2.59.0"
+  version: "2.59.4"
 });
 var _default = Rooms;
-/**
- * Helper method to build a roomInfo object from a conversation object
- * @param {Object} webex sdk object
- * @param {Conversation~ConversationObject} conversation
- * @returns {Promise<RoomInfoObject>}
+/**
+ * Helper method to build a roomInfo object from a conversation object
+ * @param {Object} webex sdk object
+ * @param {Conversation~ConversationObject} conversation
+ * @returns {Promise<RoomInfoObject>}
  */
 exports.default = _default;
 function buildRoomInfo(_x, _x2) {
   return _buildRoomInfo.apply(this, arguments);
 }
-/**
- * Helper method to build a list of roomInfo object from conversation list
- * @param {Object} webex sdk object
- * @param {Conversation~ConversationObjectList} conversations
- * @returns {Promise<RoomInfoList>}
+/**
+ * Helper method to build a list of roomInfo object from conversation list
+ * @param {Object} webex sdk object
+ * @param {Conversation~ConversationObjectList} conversations
+ * @returns {Promise<RoomInfoList>}
  */
 function _buildRoomInfo() {
   _buildRoomInfo = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(webex, conversation) {