Source: models/rooms/remote.js

  1. "use strict";
  3. /**
  4.  * Create a remote room.
  5.  * @constructor
  6.  * @param {string} identifier The ID for this room
  7.  * @param {Object=} data The key-value data object to assign to this room.
  8.  */
  9. function RemoteRoom(identifier, data) {
  10.     this.roomId = identifier;
  11.     this.data = data || {};
  12. }
  14. /**
  15.  * Get the room ID.
  16.  * @return {string} The room ID
  17.  */
  18. RemoteRoom.prototype.getId = function() {
  19.     return this.roomId;
  20. };
  22. /**
  23.  * Serialize all the data about this room, excluding the room ID.
  24.  * @return {Object} The serialised data
  25.  */
  26. RemoteRoom.prototype.serialize = function() {
  27.     return this.data;
  28. };
  30. /**
  31.  * Get the data value for the given key.
  32.  * @param {string} key An arbitrary bridge-specific key.
  33.  * @return {*} Stored data for this key. May be undefined.
  34.  */
  35. RemoteRoom.prototype.get = function(key) {
  36.     return this.data[key];
  37. };
  39. /**
  40.  * Set an arbitrary bridge-specific data value for this room.
  41.  * @param {string} key The key to store the data value under.
  42.  * @param {*} val The data value. This value should be serializable via
  43.  * <code>JSON.stringify(data)</code>.
  44.  */
  45. RemoteRoom.prototype.set = function(key, val) {
  46.     this.data[key] = val;
  47. };
  49. /** The RemoteRoom class. */
  50. module.exports = RemoteRoom;