Source: models/events/event.js

  1. /*
  2. Copyright 2019 The Matrix.org Foundation C.I.C.
  4. Licensed under the Apache License, Version 2.0 (the "License");
  5. you may not use this file except in compliance with the License.
  6. You may obtain a copy of the License at
  7.     http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. */
  16. /**
  17.  * Create a store event.
  18.  * @constructor
  19.  * @param {string} roomId The matrix room ID
  20.  * @param {string} eventId The matrix event ID
  21.  * @param {string} remoteRoomId The remote room ID
  22.  * @param {string} remoteEventId The remote event ID
  23.  * @param {any} extras Any extra data that may be included with the event.
  24.  */
  25. function StoredEvent(roomId, eventId, remoteRoomId, remoteEventId, extras) {
  26.     this.roomId = roomId;
  27.     this.eventId = eventId;
  28.     this.remoteRoomId = remoteRoomId;
  29.     this.remoteEventId = remoteEventId;
  30.     this._extras = extras || {};
  31. }
  33. /**
  34.  * Get the unique ID.
  35.  * @return {string} A unique ID
  36.  */
  37. StoredEvent.prototype.getId = function() {
  38.     return this.eventId + this.remoteEventId;
  39. };
  41. /**
  42.  * Get the matrix room ID.
  43.  * @return {string} The room ID
  44.  */
  45. StoredEvent.prototype.getMatrixRoomId = function() {
  46.     return this.roomId;
  47. };
  49. /**
  50.  * Get the matrix event ID.
  51.  * @return {string} The event ID
  52.  */
  53. StoredEvent.prototype.getMatrixEventId = function() {
  54.     return this.eventId;
  55. };
  57. /**
  58.  * Get the remote room ID.
  59.  * @return {string} The remote room ID
  60.  */
  61. StoredEvent.prototype.getRemoteRoomId = function() {
  62.     return this.remoteRoomId;
  63. };
  65. /**
  66.  * Get the remote event ID.
  67.  * @return {string} The remote event ID
  68.  */
  69. StoredEvent.prototype.getRemoteEventId = function() {
  70.     return this.remoteEventId;
  71. };
  73. /**
  74.  * Get the data value for the given key.
  75.  * @param {string} key An arbitrary bridge-specific key.
  76.  * @return {*} Stored data for this key. May be undefined.
  77.  */
  78. StoredEvent.prototype.get = function(key) {
  79.     return this._extras[key];
  80. };
  82. /**
  83.  * Set an arbitrary bridge-specific data value for this event. This will be serailized
  84.  * under an 'extras' key.
  85.  * @param {string} key The key to store the data value under.
  86.  * @param {*} val The data value. This value should be serializable via
  87.  * <code>JSON.stringify(data)</code>.
  88.  */
  89. StoredEvent.prototype.set = function(key, val) {
  90.     this._extras[key] = val;
  91. };
  93. /**
  94.  * Serialize data about this event into a JSON object.
  95.  * @return {Object} The serialised data
  96.  */
  97. StoredEvent.prototype.serialize = function() {
  98.     return {
  99.         id: this.getId(),
  100.         matrix: {
  101.             roomId: this.roomId,
  102.             eventId: this.eventId,
  103.         },
  104.         remote: {
  105.             roomId: this.remoteRoomId,
  106.             eventId: this.remoteEventId,
  107.         },
  108.         extras: this._extras,
  109.     };
  110. };
  112. /**
  113.  * Set data about this event from a serialized data object.
  114.  * @param {Object} data The serialized data
  115.  */
  116. StoredEvent.deserialize = function(data) {
  117.     return new StoredEvent(
  118.         data.matrix.roomId,
  119.         data.matrix.eventId,
  120.         data.remote.roomId,
  121.         data.remote.eventId,
  122.         data.extras
  123.     );
  124. };
  126. module.exports = StoredEvent;