Source: models/rooms/matrix.js

  1. "use strict";
  3. /**
  4.  * Create a matrix room.
  5.  * @constructor
  6.  * @param {string} roomId The room ID
  7.  */
  8. function MatrixRoom(roomId, data) {
  9.     this.roomId = roomId;
  10.     this._extras = {};
  11.     if (data) {
  12.         this.deserialize(data);
  13.     }
  14. }
  16. /**
  17.  * Get the room ID.
  18.  * @return {string} The room ID
  19.  */
  20. MatrixRoom.prototype.getId = function() {
  21.     return this.roomId;
  22. };
  24. /**
  25.  * Get the data value for the given key.
  26.  * @param {string} key An arbitrary bridge-specific key.
  27.  * @return {*} Stored data for this key. May be undefined.
  28.  */
  29. MatrixRoom.prototype.get = function(key) {
  30.     return this._extras[key];
  31. };
  33. /**
  34.  * Set an arbitrary bridge-specific data value for this room. This will be serailized
  35.  * under an 'extras' key.
  36.  * @param {string} key The key to store the data value under.
  37.  * @param {*} val The data value. This value should be serializable via
  38.  * <code>JSON.stringify(data)</code>.
  39.  */
  40. MatrixRoom.prototype.set = function(key, val) {
  41.     this._extras[key] = val;
  42. };
  44. /**
  45.  * Serialize data about this room into a JSON object.
  46.  * @return {Object} The serialised data
  47.  */
  48. MatrixRoom.prototype.serialize = function() {
  49.     return {
  50.         name: this.name,
  51.         topic: this.topic,
  52.         extras: this._extras
  53.     };
  54. };
  56. /**
  57.  * Set data about this room from a serialized data object.
  58.  * @param {Object} data The serialized data
  59.  */
  60. MatrixRoom.prototype.deserialize = function(data) {
  61.     this.name = data.name;
  62.     this.topic = data.topic;
  63.     this._extras = data.extras;
  64. };
  66. /** The MatrixRoom class. */
  67. module.exports = MatrixRoom;