/
message.js
74 lines (66 loc) · 1.83 KB
/
message.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/**
* Copyright (c) 2017 - present, Botfuel (https://www.botfuel.io).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const ValidObject = require('./valid-object');
/**
* An abstract message.
*/
class Message extends ValidObject {
/**
* @constructor
* @param type - the message type
* @param sender - the message sender, the bot or the user
* @param value - the message value
* @param {Object} [options] - the message options
*/
constructor(type, sender, value, options = {}) {
super();
this.type = type;
this.sender = sender;
this.value = value;
this.options = options;
}
/**
* Converts a message to json and adds to it the bot and user ids.
* @param userId - the user id
* @returns {Object} - the json message
*/
toJson(userId) {
const messageJson = {
type: this.type,
sender: this.sender,
user: userId,
payload: {
value: this.valueAsJson(),
},
};
if (Object.keys(this.options).length > 0) {
messageJson.payload.options = this.options;
}
return messageJson;
}
/**
* Returns the value as json.
* @returns {*} - the json value
*/
valueAsJson() {
return this.value;
}
validate() {
this.validateString(this.type, this.type);
this.validateString(this.type, this.sender);
}
}
module.exports = Message;