1 | ;
|
2 |
|
3 | /**
|
4 | * Command execution context, it is available for {@link
|
5 | * rpc.clientRequests} hooks.
|
6 | *
|
7 | * @see chat-service.hooks.CommandsHooks
|
8 | * @memberof chat-service
|
9 | * @interface
|
10 | */
|
11 |
|
12 | var _classCallCheck2 = require('babel-runtime/helpers/classCallCheck');
|
13 |
|
14 | var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);
|
15 |
|
16 | function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
17 |
|
18 | var ExecInfo =
|
19 | /**
|
20 | * Service instance.
|
21 | * @name chat-service.ExecInfo#server
|
22 | * @type ChatService
|
23 | */
|
24 |
|
25 | /**
|
26 | * User name.
|
27 | * @name chat-service.ExecInfo#userName
|
28 | * @type string|null
|
29 | */
|
30 |
|
31 | /**
|
32 | * Socket id.
|
33 | * @name chat-service.ExecInfo#id
|
34 | * @type string|null
|
35 | */
|
36 |
|
37 | /**
|
38 | * Bypass permissions.
|
39 | * @name chat-service.ExecInfo#bypassPermissions
|
40 | * @type boolean
|
41 | * @default false
|
42 | * @see chat-service.ServiceAPI#execUserCommand
|
43 | */
|
44 |
|
45 | /**
|
46 | * If command is executed from a server side.
|
47 | * @name chat-service.ExecInfo#isLocalCall
|
48 | * @type boolean
|
49 | * @default false
|
50 | * @see chat-service.ServiceAPI#execUserCommand
|
51 | */
|
52 |
|
53 | /**
|
54 | * Don't call command hooks if `true`.
|
55 | * @name chat-service.ExecInfo#bypassHooks
|
56 | * @type boolean
|
57 | * @default false
|
58 | * @see chat-service.ServiceAPI#execUserCommand
|
59 | */
|
60 |
|
61 | /**
|
62 | * Command's error.
|
63 | * @name chat-service.ExecInfo#error
|
64 | * @type Error|null
|
65 | * @default null
|
66 | */
|
67 |
|
68 | /**
|
69 | * Command's results.
|
70 | * @name chat-service.ExecInfo#results
|
71 | * @type {Array<Object>}
|
72 | * @default null
|
73 | */
|
74 |
|
75 | /**
|
76 | * Command's arguments.
|
77 | * @name chat-service.ExecInfo#args
|
78 | * @type {Array<Object>}
|
79 | * @default []
|
80 | */
|
81 |
|
82 | /**
|
83 | * Additional arguments, passed after command arguments. Can be used
|
84 | * as additional hooks parameters.
|
85 | * @name chat-service.ExecInfo#restArgs
|
86 | * @type {Array<Object>}
|
87 | * @default []
|
88 | */
|
89 |
|
90 | /**
|
91 | * Custom data set by hooks.
|
92 | * @name chat-service.ExecInfo#data
|
93 | * @type {Object}
|
94 | * @default {}
|
95 | */
|
96 |
|
97 | function ExecInfo() {
|
98 | (0, _classCallCheck3.default)(this, ExecInfo);
|
99 |
|
100 | this.args = [];
|
101 | this.bypassHooks = false;
|
102 | this.bypassPermissions = null;
|
103 | this.data = {};
|
104 | this.error = null;
|
105 | this.id = null;
|
106 | this.isLocalCall = false;
|
107 | this.restArgs = [];
|
108 | this.results = null;
|
109 | this.server = null;
|
110 | this.userName = null;
|
111 | };
|
112 |
|
113 | module.exports = ExecInfo;
|
114 | //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9FeGVjSW5mby5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7QUFFQTs7Ozs7Ozs7Ozs7Ozs7O0lBUU0sUTtBQUNKOzs7Ozs7QUFNQTs7Ozs7O0FBTUE7Ozs7OztBQU1BOzs7Ozs7OztBQVFBOzs7Ozs7OztBQVFBOzs7Ozs7OztBQVFBOzs7Ozs7O0FBT0E7Ozs7Ozs7QUFPQTs7Ozs7OztBQU9BOzs7Ozs7OztBQVFBOzs7Ozs7O0FBT0Esb0JBQWU7QUFBQTs7QUFDYixPQUFLLElBQUwsR0FBWSxFQUFaO0FBQ0EsT0FBSyxXQUFMLEdBQW1CLEtBQW5CO0FBQ0EsT0FBSyxpQkFBTCxHQUF5QixJQUF6QjtBQUNBLE9BQUssSUFBTCxHQUFZLEVBQVo7QUFDQSxPQUFLLEtBQUwsR0FBYSxJQUFiO0FBQ0EsT0FBSyxFQUFMLEdBQVUsSUFBVjtBQUNBLE9BQUssV0FBTCxHQUFtQixLQUFuQjtBQUNBLE9BQUssUUFBTCxHQUFnQixFQUFoQjtBQUNBLE9BQUssT0FBTCxHQUFlLElBQWY7QUFDQSxPQUFLLE1BQUwsR0FBYyxJQUFkO0FBQ0EsT0FBSyxRQUFMLEdBQWdCLElBQWhCO0FBQ0QsQzs7QUFJSCxPQUFPLE9BQVAsR0FBaUIsUUFBakIiLCJmaWxlIjoiRXhlY0luZm8uanMiLCJzb3VyY2VzQ29udGVudCI6WyIndXNlIHN0cmljdCdcblxuLyoqXG4gKiBDb21tYW5kIGV4ZWN1dGlvbiBjb250ZXh0LCBpdCBpcyBhdmFpbGFibGUgZm9yIHtAbGlua1xuICogcnBjLmNsaWVudFJlcXVlc3RzfSBob29rcy5cbiAqXG4gKiBAc2VlIGNoYXQtc2VydmljZS5ob29rcy5Db21tYW5kc0hvb2tzXG4gKiBAbWVtYmVyb2YgY2hhdC1zZXJ2aWNlXG4gKiBAaW50ZXJmYWNlXG4gKi9cbmNsYXNzIEV4ZWNJbmZvIHtcbiAgLyoqXG4gICAqIFNlcnZpY2UgaW5zdGFuY2UuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNzZXJ2ZXJcbiAgICogQHR5cGUgQ2hhdFNlcnZpY2VcbiAgICovXG5cbiAgLyoqXG4gICAqIFVzZXIgbmFtZS5cbiAgICogQG5hbWUgY2hhdC1zZXJ2aWNlLkV4ZWNJbmZvI3VzZXJOYW1lXG4gICAqIEB0eXBlIHN0cmluZ3xudWxsXG4gICAqL1xuXG4gIC8qKlxuICAgKiBTb2NrZXQgaWQuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNpZFxuICAgKiBAdHlwZSBzdHJpbmd8bnVsbFxuICAgKi9cblxuICAvKipcbiAgICogQnlwYXNzIHBlcm1pc3Npb25zLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jYnlwYXNzUGVybWlzc2lvbnNcbiAgICogQHR5cGUgYm9vbGVhblxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKiBAc2VlIGNoYXQtc2VydmljZS5TZXJ2aWNlQVBJI2V4ZWNVc2VyQ29tbWFuZFxuICAgKi9cblxuICAvKipcbiAgICogSWYgY29tbWFuZCBpcyBleGVjdXRlZCBmcm9tIGEgc2VydmVyIHNpZGUuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNpc0xvY2FsQ2FsbFxuICAgKiBAdHlwZSBib29sZWFuXG4gICAqIEBkZWZhdWx0IGZhbHNlXG4gICAqIEBzZWUgY2hhdC1zZXJ2aWNlLlNlcnZpY2VBUEkjZXhlY1VzZXJDb21tYW5kXG4gICAqL1xuXG4gIC8qKlxuICAgKiBEb24ndCBjYWxsIGNvbW1hbmQgaG9va3MgaWYgYHRydWVgLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jYnlwYXNzSG9va3NcbiAgICogQHR5cGUgYm9vbGVhblxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKiBAc2VlIGNoYXQtc2VydmljZS5TZXJ2aWNlQVBJI2V4ZWNVc2VyQ29tbWFuZFxuICAgKi9cblxuICAvKipcbiAgICogQ29tbWFuZCdzIGVycm9yLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jZXJyb3JcbiAgICogQHR5cGUgRXJyb3J8bnVsbFxuICAgKiBAZGVmYXVsdCBudWxsXG4gICAqL1xuXG4gIC8qKlxuICAgKiBDb21tYW5kJ3MgcmVzdWx0cy5cbiAgICogQG5hbWUgY2hhdC1zZXJ2aWNlLkV4ZWNJbmZvI3Jlc3VsdHNcbiAgICogQHR5cGUge0FycmF5PE9iamVjdD59XG4gICAqIEBkZWZhdWx0IG51bGxcbiAgICovXG5cbiAgLyoqXG4gICAqIENvbW1hbmQncyBhcmd1bWVudHMuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNhcmdzXG4gICAqIEB0eXBlIHtBcnJheTxPYmplY3Q+fVxuICAgKiBAZGVmYXVsdCBbXVxuICAgKi9cblxuICAvKipcbiAgICogQWRkaXRpb25hbCBhcmd1bWVudHMsIHBhc3NlZCBhZnRlciBjb21tYW5kIGFyZ3VtZW50cy4gQ2FuIGJlIHVzZWRcbiAgICogYXMgYWRkaXRpb25hbCBob29rcyBwYXJhbWV0ZXJzLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jcmVzdEFyZ3NcbiAgICogQHR5cGUge0FycmF5PE9iamVjdD59XG4gICAqIEBkZWZhdWx0IFtdXG4gICAqL1xuXG4gIC8qKlxuICAgKiBDdXN0b20gZGF0YSBzZXQgYnkgaG9va3MuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNkYXRhXG4gICAqIEB0eXBlIHtPYmplY3R9XG4gICAqIEBkZWZhdWx0IHt9XG4gICAqL1xuXG4gIGNvbnN0cnVjdG9yICgpIHtcbiAgICB0aGlzLmFyZ3MgPSBbXVxuICAgIHRoaXMuYnlwYXNzSG9va3MgPSBmYWxzZVxuICAgIHRoaXMuYnlwYXNzUGVybWlzc2lvbnMgPSBudWxsXG4gICAgdGhpcy5kYXRhID0ge31cbiAgICB0aGlzLmVycm9yID0gbnVsbFxuICAgIHRoaXMuaWQgPSBudWxsXG4gICAgdGhpcy5pc0xvY2FsQ2FsbCA9IGZhbHNlXG4gICAgdGhpcy5yZXN0QXJncyA9IFtdXG4gICAgdGhpcy5yZXN1bHRzID0gbnVsbFxuICAgIHRoaXMuc2VydmVyID0gbnVsbFxuICAgIHRoaXMudXNlck5hbWUgPSBudWxsXG4gIH1cblxufVxuXG5tb2R1bGUuZXhwb3J0cyA9IEV4ZWNJbmZvXG4iXX0= |
\ | No newline at end of file |