@webex/plugin-messages 2.59.2 → 2.59.3-next.1

package/dist/messages.js

@@ -27,36 +27,36 @@ var getRoomType = function getRoomType(roomTags) {
   return roomTags.includes(_common.SDK_EVENT.INTERNAL.ACTIVITY_TAG.ONE_ON_ONE) ? _common.SDK_EVENT.EXTERNAL.SPACE_TYPE.DIRECT : _common.SDK_EVENT.EXTERNAL.SPACE_TYPE.GROUP;
 };
 
-/**
- * @typedef {Object} MessageObject
- * @property {string} id - (server generated) Unique identifier for the message
- * @property {string} personId - The ID for the author of the message
- * @property {email} personEmail - The email for the author of the message
- * @property {string} roomId - The ID for the room of the message
- * @property {string} text - The message posted to the room in plain text
- * @property {string} markdown - The message posted to the room in markdown
- * @property {Array<string>} files - The source URL(s) for the message attachment(s).
- * See the {@link https://developer.webex.com/docs/api/basics#message-attachments|Message Attachments}
- * Guide for a list of supported media types.
- * @property {isoDate} created - (server generated) The date and time that the message was created
+/**
+ * @typedef {Object} MessageObject
+ * @property {string} id - (server generated) Unique identifier for the message
+ * @property {string} personId - The ID for the author of the message
+ * @property {email} personEmail - The email for the author of the message
+ * @property {string} roomId - The ID for the room of the message
+ * @property {string} text - The message posted to the room in plain text
+ * @property {string} markdown - The message posted to the room in markdown
+ * @property {Array<string>} files - The source URL(s) for the message attachment(s).
+ * See the {@link https://developer.webex.com/docs/api/basics#message-attachments|Message Attachments}
+ * Guide for a list of supported media types.
+ * @property {isoDate} created - (server generated) The date and time that the message was created
  */
 
-/**
- * Messages are how people communicate in rooms. Each message timestamped and
- * represented in Webex as a distinct block of content. Messages can contain
- * plain text and a single file attachment. See the
- * {@link https://developer.webex.com/docs/api/basics#message-attachments|Message Attachments} Guide
- * for a list of supported media types.
- * @class
+/**
+ * Messages are how people communicate in rooms. Each message timestamped and
+ * represented in Webex as a distinct block of content. Messages can contain
+ * plain text and a single file attachment. See the
+ * {@link https://developer.webex.com/docs/api/basics#message-attachments|Message Attachments} Guide
+ * for a list of supported media types.
+ * @class
  */
 var Messages = _webexCore.WebexPlugin.extend({
-  /**
-   * Initializer used to generate Messages
-   * as a plugin wrapped around the provided arguments.
-   * @private
-   * @see WebexPlugin.initialize
-   * @param  {...any} args
-   * @returns {undefined}
+  /**
+   * Initializer used to generate Messages
+   * as a plugin wrapped around the provided arguments.
+   * @private
+   * @see WebexPlugin.initialize
+   * @param  {...any} args
+   * @returns {undefined}
    */
   initialize: function initialize() {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
@@ -64,38 +64,38 @@ var Messages = _webexCore.WebexPlugin.extend({
     }
     (0, _apply.default)(_webexCore.WebexPlugin.prototype.initialize, this, args);
   },
-  /**
-   * Register to listen for incoming messages events
-   * This is an alternate approach to registering for messages 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.
-   * The messages.listen() event objects can also include additional fields not
-   * available in the webhook's JSON payload: `text`, `markdown`, and `files`.
-   * These fields are available when their details are included in the web socket's
-   * `activity` object. Retrieving other fields, such as the `html` field,
-   * will require a manual request to get the corresponding message object.
-   * 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 Messages
-   * @returns {Promise}
-   * @example
-   * webex.messages.listen()
-   *   .then(() => {
-   *     console.log('listening to message events');
-   *     webex.messages.on('created', (event) => console.log(`Got a message:created event:\n${event}`));
-   *     webex.messages.on('deleted', (event) => console.log(`Got a message:deleted event:\n${event}`));
-   *   })
-   *   .catch((e) => console.error(`Unable to register for message events: ${e}`));
-   * // Some app logic...
-   * // When it is time to cleanup
-   * webex.messages.stopListening();
-   * webex.messages.off('created');
-   * webex.messages.off('deleted');
+  /**
+   * Register to listen for incoming messages events
+   * This is an alternate approach to registering for messages 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.
+   * The messages.listen() event objects can also include additional fields not
+   * available in the webhook's JSON payload: `text`, `markdown`, and `files`.
+   * These fields are available when their details are included in the web socket's
+   * `activity` object. Retrieving other fields, such as the `html` field,
+   * will require a manual request to get the corresponding message object.
+   * 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 Messages
+   * @returns {Promise}
+   * @example
+   * webex.messages.listen()
+   *   .then(() => {
+   *     console.log('listening to message events');
+   *     webex.messages.on('created', (event) => console.log(`Got a message:created event:\n${event}`));
+   *     webex.messages.on('deleted', (event) => console.log(`Got a message:deleted event:\n${event}`));
+   *   })
+   *   .catch((e) => console.error(`Unable to register for message events: ${e}`));
+   * // Some app logic...
+   * // When it is time to cleanup
+   * webex.messages.stopListening();
+   * webex.messages.off('created');
+   * webex.messages.off('deleted');
    */
   listen: function listen() {
     var _this = this;
@@ -111,30 +111,30 @@ var Messages = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /**
-   * Post a new message and/or media content into a room.
-   * @instance
-   * @memberof Messages
-   * @param {MessageObject} message
-   * @returns {Promise<MessageObject>}
-   * @example
-   * webex.rooms.create({title: 'Create Message Example'})
-   *   .then(function(room) {
-   *     return webex.messages.create({
-   *       text: 'Howdy!',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(message) {
-   *     var assert = require('assert');
-   *     assert(message.id);
-   *     assert(message.personId);
-   *     assert(message.personEmail);
-   *     assert(message.roomId);
-   *     assert(message.created);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Post a new message and/or media content into a room.
+   * @instance
+   * @memberof Messages
+   * @param {MessageObject} message
+   * @returns {Promise<MessageObject>}
+   * @example
+   * webex.rooms.create({title: 'Create Message Example'})
+   *   .then(function(room) {
+   *     return webex.messages.create({
+   *       text: 'Howdy!',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(message) {
+   *     var assert = require('assert');
+   *     assert(message.id);
+   *     assert(message.personId);
+   *     assert(message.personEmail);
+   *     assert(message.roomId);
+   *     assert(message.created);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   create: function create(message) {
     var key = 'body';
@@ -157,39 +157,39 @@ var Messages = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Put an updated message and/or media content into a room instead of existing message.
-   * @instance
-   * @memberof Messages
-   * @param {MessageObject} message
-   * @param {MessageObject} altMessage
-   * @returns {Promise<MessageObject>}
-   * @example
-   * webex.rooms.create({title: 'Create Message Example'})
-   *   .then(function(room) {
-   *     return webex.messages.create({
-   *       text: 'Howdy!',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     message = m;
-   *     return webex.messages.update(message,{markdown:`**What up**`});
-   *   })
-   *   .then(function(m) {
-   *     message = m;
-   *     return webex.messages.update(message.id,{roomId:message.roomId,text:'Howdy!'});
-   *   })
-   *   .then(function(message) {
-   *     var assert = require('assert');
-   *     assert(message.id);
-   *     assert(message.personId);
-   *     assert(message.personEmail);
-   *     assert(message.roomId);
-   *     assert(message.created);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Put an updated message and/or media content into a room instead of existing message.
+   * @instance
+   * @memberof Messages
+   * @param {MessageObject} message
+   * @param {MessageObject} altMessage
+   * @returns {Promise<MessageObject>}
+   * @example
+   * webex.rooms.create({title: 'Create Message Example'})
+   *   .then(function(room) {
+   *     return webex.messages.create({
+   *       text: 'Howdy!',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     message = m;
+   *     return webex.messages.update(message,{markdown:`**What up**`});
+   *   })
+   *   .then(function(m) {
+   *     message = m;
+   *     return webex.messages.update(message.id,{roomId:message.roomId,text:'Howdy!'});
+   *   })
+   *   .then(function(message) {
+   *     var assert = require('assert');
+   *     assert(message.id);
+   *     assert(message.personId);
+   *     assert(message.personEmail);
+   *     assert(message.roomId);
+   *     assert(message.created);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   update: function update(message, altMessage) {
     var id = message.id || message;
@@ -207,9 +207,9 @@ var Messages = _webexCore.WebexPlugin.extend({
     if (!altMessage.roomId && !message.roomId) {
       this.logger.error('Error: RoomID is mandatory for message update call in one of the parameter, message or altMessage');
     } else {
-      /* if altMessage doesnt contain RoomId use roomId from message object. 
-      I dont understand why RESTAPI call has RoomId Mandatory in body something webex Developers to clarity. 
-      In my opinion messageId provided in REST URL call should be enough to get roomID at serverside
+      /* if altMessage doesnt contain RoomId use roomId from message object. 
+      I dont understand why RESTAPI call has RoomId Mandatory in body something webex Developers to clarity. 
+      In my opinion messageId provided in REST URL call should be enough to get roomID at serverside
       */
       altMessage.roomId = altMessage.roomId ? altMessage.roomId : message.roomId;
       var options = (0, _defineProperty2.default)({
@@ -223,31 +223,31 @@ var Messages = _webexCore.WebexPlugin.extend({
     }
     return null;
   },
-  /**
-   * Returns a single message.
-   * @instance
-   * @memberof Messages
-   * @param {RoomObject|string} message
-   * @returns {Promise<MessageObject>}
-   * @example
-   * var message;
-   * webex.rooms.create({title: 'Get Message Example'})
-   *   .then(function(room) {
-   *     return webex.messages.create({
-   *       text: 'Howdy!',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     message = m;
-   *     return webex.messages.get(message.id);
-   *   })
-   *   .then(function(message2) {
-   *     var assert = require('assert');
-   *     assert.deepEqual(message2, message);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Returns a single message.
+   * @instance
+   * @memberof Messages
+   * @param {RoomObject|string} message
+   * @returns {Promise<MessageObject>}
+   * @example
+   * var message;
+   * webex.rooms.create({title: 'Get Message Example'})
+   *   .then(function(room) {
+   *     return webex.messages.create({
+   *       text: 'Howdy!',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     message = m;
+   *     return webex.messages.get(message.id);
+   *   })
+   *   .then(function(message2) {
+   *     var assert = require('assert');
+   *     assert.deepEqual(message2, message);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   get: function get(message) {
     var id = message.id || message;
@@ -258,44 +258,44 @@ var Messages = _webexCore.WebexPlugin.extend({
       return res.body.items || res.body;
     });
   },
-  /**
-   * Returns a list of messages. In most cases the results will only contain
-   * messages posted in rooms that the authenticated user is a member of.
-   * @instance
-   * @memberof Messages
-   * @param {Object} options
-   * @param {string} options.roomId
-   * @param {number} options.max
-   * @returns {Promise<Page<MessageObject>>}
-   * @example
-   * var message1, message2, room;
-   * webex.rooms.create({title: 'List Messages Example'})
-   *   .then(function(r) {
-   *     room = r;
-   *     return webex.messages.create({
-   *       text: 'Howdy!',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     message1 = m;
-   *     return webex.messages.create({
-   *       text: 'How are you?',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     message2 = m;
-   *     return webex.messages.list({roomId: room.id});
-   *   })
-   *   .then(function(messages) {
-   *     var assert = require('assert');
-   *     assert.equal(messages.length, 2);
-   *     assert.equal(messages.items[0].id, message2.id);
-   *     assert.equal(messages.items[1].id, message1.id);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Returns a list of messages. In most cases the results will only contain
+   * messages posted in rooms that the authenticated user is a member of.
+   * @instance
+   * @memberof Messages
+   * @param {Object} options
+   * @param {string} options.roomId
+   * @param {number} options.max
+   * @returns {Promise<Page<MessageObject>>}
+   * @example
+   * var message1, message2, room;
+   * webex.rooms.create({title: 'List Messages Example'})
+   *   .then(function(r) {
+   *     room = r;
+   *     return webex.messages.create({
+   *       text: 'Howdy!',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     message1 = m;
+   *     return webex.messages.create({
+   *       text: 'How are you?',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     message2 = m;
+   *     return webex.messages.list({roomId: room.id});
+   *   })
+   *   .then(function(messages) {
+   *     var assert = require('assert');
+   *     assert.equal(messages.length, 2);
+   *     assert.equal(messages.items[0].id, message2.id);
+   *     assert.equal(messages.items[1].id, message1.id);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   list: function list(options) {
     var _this2 = this;
@@ -307,45 +307,45 @@ var Messages = _webexCore.WebexPlugin.extend({
       return new _webexCore.Page(res, _this2.webex);
     });
   },
-  /**
-   * Deletes a single message. Deleting a message will notify all members of the
-   * room that the authenticated user deleted the message. Generally, users can
-   * only delete their own messages except for the case of Moderated Rooms and
-   * Org Administrators.
-   * @instance
-   * @memberof Messages
-   * @param {MessageObject|uuid} message
-   * @returns {Promise}}
-   * @example
-   * var message1, room;
-   * webex.rooms.create({title: 'Messages Example'})
-   *   .then(function(r) {
-   *     room = r;
-   *     return webex.messages.create({
-   *       text: 'Howdy!',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     message1 = m;
-   *     return webex.messages.create({
-   *       text: 'How are you?',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function() {
-   *     return webex.messages.remove(message1);
-   *   })
-   *   .then(function() {
-   *     return webex.messages.list({roomId: room.id});
-   *   })
-   *   .then(function(messages) {
-   *     var assert = require('assert');
-   *     assert.equal(messages.items.length, 1);
-   *     assert(messages.items[0].id !== message1.id);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Deletes a single message. Deleting a message will notify all members of the
+   * room that the authenticated user deleted the message. Generally, users can
+   * only delete their own messages except for the case of Moderated Rooms and
+   * Org Administrators.
+   * @instance
+   * @memberof Messages
+   * @param {MessageObject|uuid} message
+   * @returns {Promise}}
+   * @example
+   * var message1, room;
+   * webex.rooms.create({title: 'Messages Example'})
+   *   .then(function(r) {
+   *     room = r;
+   *     return webex.messages.create({
+   *       text: 'Howdy!',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     message1 = m;
+   *     return webex.messages.create({
+   *       text: 'How are you?',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function() {
+   *     return webex.messages.remove(message1);
+   *   })
+   *   .then(function() {
+   *     return webex.messages.list({roomId: room.id});
+   *   })
+   *   .then(function(messages) {
+   *     var assert = require('assert');
+   *     assert.equal(messages.items.length, 1);
+   *     assert(messages.items[0].id !== message1.id);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   remove: function remove(message) {
     var id = message.id || message;
@@ -362,12 +362,12 @@ var Messages = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Curry the 'trigger' method
-   * @private
-   * @memberof Messages
-   * @param {string} type the type of event to fire
-   * @returns {function} takes event and triggers it
+  /**
+   * Curry the 'trigger' method
+   * @private
+   * @memberof Messages
+   * @param {string} type the type of event to fire
+   * @returns {function} takes event and triggers it
    */
   fire: function fire(type) {
     var _this3 = this;
@@ -375,16 +375,16 @@ var Messages = _webexCore.WebexPlugin.extend({
       return _this3.trigger(type, event);
     };
   },
-  /**
-   * 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 Messages
-   * @param {Object} event
-   * @param {Object} event.data contains the data of the event
-   * @param {Object} event.data.activity the activity that triggered the 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 Messages
+   * @param {Object} event
+   * @param {Object} event.data contains the data of the event
+   * @param {Object} event.data.activity the activity that triggered the event
+   * @returns {void}
    */
   onWebexApiEvent: function onWebexApiEvent(_ref) {
     var activity = _ref.data.activity;
@@ -394,15 +394,15 @@ var Messages = _webexCore.WebexPlugin.extend({
     }
     this.getMessageEvent(activity, type).then(this.fire(type));
   },
-  /**
-   * Constructs the data object for an event on the messages resource,
-   * adhering to Hydra's Webhook data structure messages.
-   * External users of the SDK should not call this function
-   * @private
-   * @memberof Messages
-   * @param {Object} activity from mercury
-   * @param {String} type the type of event
-   * @returns {Object} constructed event
+  /**
+   * Constructs the data object for an event on the messages resource,
+   * adhering to Hydra's Webhook data structure messages.
+   * External users of the SDK should not call this function
+   * @private
+   * @memberof Messages
+   * @param {Object} activity from mercury
+   * @param {String} type the type of event
+   * @returns {Object} constructed event
    */
   getMessageEvent: function getMessageEvent(activity, type) {
     var id = activity.id,
@@ -439,7 +439,7 @@ var Messages = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  version: "2.59.2"
+  version: "2.59.0"
 });
 var _default = Messages;
 exports.default = _default;