chat-service/lib/ExecInfo.js

'use strict';

/**
 * Command execution context, it is available for {@link
 * rpc.clientRequests} hooks.
 *
 * @see chat-service.hooks.CommandsHooks
 * @memberof chat-service
 * @interface
 */

var _classCallCheck2 = require('babel-runtime/helpers/classCallCheck');

var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

var ExecInfo =
/**
 * Service instance.
 * @name chat-service.ExecInfo#server
 * @type ChatService
 */

/**
 * User name.
 * @name chat-service.ExecInfo#userName
 * @type string|null
 */

/**
 * Socket id.
 * @name chat-service.ExecInfo#id
 * @type string|null
 */

/**
 * Bypass permissions.
 * @name chat-service.ExecInfo#bypassPermissions
 * @type boolean
 * @default false
 * @see chat-service.ServiceAPI#execUserCommand
 */

/**
 * If command is executed from a server side.
 * @name chat-service.ExecInfo#isLocalCall
 * @type boolean
 * @default false
 * @see chat-service.ServiceAPI#execUserCommand
 */

/**
 * Don't call command hooks if `true`.
 * @name chat-service.ExecInfo#bypassHooks
 * @type boolean
 * @default false
 * @see chat-service.ServiceAPI#execUserCommand
 */

/**
 * Command's error.
 * @name chat-service.ExecInfo#error
 * @type Error|null
 * @default null
 */

/**
 * Command's results.
 * @name chat-service.ExecInfo#results
 * @type {Array<Object>}
 * @default null
 */

/**
 * Command's arguments.
 * @name chat-service.ExecInfo#args
 * @type {Array<Object>}
 * @default []
 */

/**
 * Additional arguments, passed after command arguments. Can be used
 * as additional hooks parameters.
 * @name chat-service.ExecInfo#restArgs
 * @type {Array<Object>}
 * @default []
 */

/**
 * Custom data set by hooks.
 * @name chat-service.ExecInfo#data
 * @type {Object}
 * @default {}
 */

function ExecInfo() {
  (0, _classCallCheck3.default)(this, ExecInfo);

  this.args = [];
  this.bypassHooks = false;
  this.bypassPermissions = null;
  this.data = {};
  this.error = null;
  this.id = null;
  this.isLocalCall = false;
  this.restArgs = [];
  this.results = null;
  this.server = null;
  this.userName = null;
};

module.exports = ExecInfo;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9FeGVjSW5mby5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7QUFFQTs7Ozs7Ozs7Ozs7Ozs7O0lBUU0sUTtBQUNKOzs7Ozs7QUFNQTs7Ozs7O0FBTUE7Ozs7OztBQU1BOzs7Ozs7OztBQVFBOzs7Ozs7OztBQVFBOzs7Ozs7OztBQVFBOzs7Ozs7O0FBT0E7Ozs7Ozs7QUFPQTs7Ozs7OztBQU9BOzs7Ozs7OztBQVFBOzs7Ozs7O0FBT0Esb0JBQWU7QUFBQTs7QUFDYixPQUFLLElBQUwsR0FBWSxFQUFaO0FBQ0EsT0FBSyxXQUFMLEdBQW1CLEtBQW5CO0FBQ0EsT0FBSyxpQkFBTCxHQUF5QixJQUF6QjtBQUNBLE9BQUssSUFBTCxHQUFZLEVBQVo7QUFDQSxPQUFLLEtBQUwsR0FBYSxJQUFiO0FBQ0EsT0FBSyxFQUFMLEdBQVUsSUFBVjtBQUNBLE9BQUssV0FBTCxHQUFtQixLQUFuQjtBQUNBLE9BQUssUUFBTCxHQUFnQixFQUFoQjtBQUNBLE9BQUssT0FBTCxHQUFlLElBQWY7QUFDQSxPQUFLLE1BQUwsR0FBYyxJQUFkO0FBQ0EsT0FBSyxRQUFMLEdBQWdCLElBQWhCO0FBQ0QsQzs7QUFJSCxPQUFPLE9BQVAsR0FBaUIsUUFBakIiLCJmaWxlIjoiRXhlY0luZm8uanMiLCJzb3VyY2VzQ29udGVudCI6WyIndXNlIHN0cmljdCdcblxuLyoqXG4gKiBDb21tYW5kIGV4ZWN1dGlvbiBjb250ZXh0LCBpdCBpcyBhdmFpbGFibGUgZm9yIHtAbGlua1xuICogcnBjLmNsaWVudFJlcXVlc3RzfSBob29rcy5cbiAqXG4gKiBAc2VlIGNoYXQtc2VydmljZS5ob29rcy5Db21tYW5kc0hvb2tzXG4gKiBAbWVtYmVyb2YgY2hhdC1zZXJ2aWNlXG4gKiBAaW50ZXJmYWNlXG4gKi9cbmNsYXNzIEV4ZWNJbmZvIHtcbiAgLyoqXG4gICAqIFNlcnZpY2UgaW5zdGFuY2UuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNzZXJ2ZXJcbiAgICogQHR5cGUgQ2hhdFNlcnZpY2VcbiAgICovXG5cbiAgLyoqXG4gICAqIFVzZXIgbmFtZS5cbiAgICogQG5hbWUgY2hhdC1zZXJ2aWNlLkV4ZWNJbmZvI3VzZXJOYW1lXG4gICAqIEB0eXBlIHN0cmluZ3xudWxsXG4gICAqL1xuXG4gIC8qKlxuICAgKiBTb2NrZXQgaWQuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNpZFxuICAgKiBAdHlwZSBzdHJpbmd8bnVsbFxuICAgKi9cblxuICAvKipcbiAgICogQnlwYXNzIHBlcm1pc3Npb25zLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jYnlwYXNzUGVybWlzc2lvbnNcbiAgICogQHR5cGUgYm9vbGVhblxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKiBAc2VlIGNoYXQtc2VydmljZS5TZXJ2aWNlQVBJI2V4ZWNVc2VyQ29tbWFuZFxuICAgKi9cblxuICAvKipcbiAgICogSWYgY29tbWFuZCBpcyBleGVjdXRlZCBmcm9tIGEgc2VydmVyIHNpZGUuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNpc0xvY2FsQ2FsbFxuICAgKiBAdHlwZSBib29sZWFuXG4gICAqIEBkZWZhdWx0IGZhbHNlXG4gICAqIEBzZWUgY2hhdC1zZXJ2aWNlLlNlcnZpY2VBUEkjZXhlY1VzZXJDb21tYW5kXG4gICAqL1xuXG4gIC8qKlxuICAgKiBEb24ndCBjYWxsIGNvbW1hbmQgaG9va3MgaWYgYHRydWVgLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jYnlwYXNzSG9va3NcbiAgICogQHR5cGUgYm9vbGVhblxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKiBAc2VlIGNoYXQtc2VydmljZS5TZXJ2aWNlQVBJI2V4ZWNVc2VyQ29tbWFuZFxuICAgKi9cblxuICAvKipcbiAgICogQ29tbWFuZCdzIGVycm9yLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jZXJyb3JcbiAgICogQHR5cGUgRXJyb3J8bnVsbFxuICAgKiBAZGVmYXVsdCBudWxsXG4gICAqL1xuXG4gIC8qKlxuICAgKiBDb21tYW5kJ3MgcmVzdWx0cy5cbiAgICogQG5hbWUgY2hhdC1zZXJ2aWNlLkV4ZWNJbmZvI3Jlc3VsdHNcbiAgICogQHR5cGUge0FycmF5PE9iamVjdD59XG4gICAqIEBkZWZhdWx0IG51bGxcbiAgICovXG5cbiAgLyoqXG4gICAqIENvbW1hbmQncyBhcmd1bWVudHMuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNhcmdzXG4gICAqIEB0eXBlIHtBcnJheTxPYmplY3Q+fVxuICAgKiBAZGVmYXVsdCBbXVxuICAgKi9cblxuICAvKipcbiAgICogQWRkaXRpb25hbCBhcmd1bWVudHMsIHBhc3NlZCBhZnRlciBjb21tYW5kIGFyZ3VtZW50cy4gQ2FuIGJlIHVzZWRcbiAgICogYXMgYWRkaXRpb25hbCBob29rcyBwYXJhbWV0ZXJzLlxuICAgKiBAbmFtZSBjaGF0LXNlcnZpY2UuRXhlY0luZm8jcmVzdEFyZ3NcbiAgICogQHR5cGUge0FycmF5PE9iamVjdD59XG4gICAqIEBkZWZhdWx0IFtdXG4gICAqL1xuXG4gIC8qKlxuICAgKiBDdXN0b20gZGF0YSBzZXQgYnkgaG9va3MuXG4gICAqIEBuYW1lIGNoYXQtc2VydmljZS5FeGVjSW5mbyNkYXRhXG4gICAqIEB0eXBlIHtPYmplY3R9XG4gICAqIEBkZWZhdWx0IHt9XG4gICAqL1xuXG4gIGNvbnN0cnVjdG9yICgpIHtcbiAgICB0aGlzLmFyZ3MgPSBbXVxuICAgIHRoaXMuYnlwYXNzSG9va3MgPSBmYWxzZVxuICAgIHRoaXMuYnlwYXNzUGVybWlzc2lvbnMgPSBudWxsXG4gICAgdGhpcy5kYXRhID0ge31cbiAgICB0aGlzLmVycm9yID0gbnVsbFxuICAgIHRoaXMuaWQgPSBudWxsXG4gICAgdGhpcy5pc0xvY2FsQ2FsbCA9IGZhbHNlXG4gICAgdGhpcy5yZXN0QXJncyA9IFtdXG4gICAgdGhpcy5yZXN1bHRzID0gbnVsbFxuICAgIHRoaXMuc2VydmVyID0gbnVsbFxuICAgIHRoaXMudXNlck5hbWUgPSBudWxsXG4gIH1cblxufVxuXG5tb2R1bGUuZXhwb3J0cyA9IEV4ZWNJbmZvXG4iXX0=