CommandsHooks

chat-service.hooks. CommandsHooks

Commands hooks full list, they are available for all rpc.clientRequests. There are just two types of command hooks, for a concise description see beforeHook and afterHook.

Type Definitions

directAddToListAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

directAddToListBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

directGetAccessListAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

directGetAccessListBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

directGetWhitelistModeAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

directGetWhitelistModeBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

directMessageAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

directMessageBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

directRemoveFromListAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

directRemoveFromListBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

directSetWhitelistModeAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

directSetWhitelistModeBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

listOwnSocketsAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

listOwnSocketsBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomAddToListAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomAddToListBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomCreateAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomCreateBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomDeleteAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomDeleteBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomGetAccessListAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomGetAccessListBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomGetOwnerAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomGetOwnerBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomGetWhitelistModeAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomGetWhitelistModeBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomHistoryGetAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomHistoryGetBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomHistoryInfoAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomHistoryInfoBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomJoinAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomJoinBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomLeaveAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomLeaveBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomMessageAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomMessageBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomNotificationsInfoAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomNotificationsInfoBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomRecentHistoryAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomRecentHistoryBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomRemoveFromListAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomRemoveFromListBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomSetWhitelistModeAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomSetWhitelistModeBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

roomUserSeenAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

roomUserSeenBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>

systemMessageAfter(execInfo, cbopt) → {Promise.<(Array|undefined)>}

After hooks are available for all rpc.clientRequests and are executed after Chat Service standard handlers, but before returning results to the command issuer. Note that after hooks will run unconditionally after a Chat Service handler, both when a normal result is return and an error occurred. Use execInfo to get errors or results.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to return unchanged command results to the command issuer. Rejections or a resolved array will override command results.

Type
Promise.<(Array|undefined)>

systemMessageBefore(execInfo, cbopt) → {Promise.<(Array|undefined)>}

Before hooks are available for all rpc.clientRequests and are executed after a command arguments validation, but before Chat Service standard handler.

Parameters:
Name Type Attributes Description
execInfo chat-service.ExecInfo

Command execution details.

cb callback <optional>

Optional callback.

Returns:

Resolves without a data to continue a command execution. Rejections or a resolved array will stop further execution, and return results to the command issuer.

Type
Promise.<(Array|undefined)>