ChatInvocation
in package
FinalYes
Somebody typing a command in a connector's own chat, as far as the {@see ChatDispatcher} needs to know.
The connector fills this in from its own message type — it is the only code that knows where a Twitch badge or a Telegram admin list lives — and the dispatcher does everything else identically for every network.
Tags
Table of Contents
Properties
- $access : Access
- $invokerId : string
- $invokerName : string
- $message : object|null
- $room : string
- $roomId : string|null
Methods
- __construct() : mixed
Properties
$access read-only
public
Access
$access
$invokerId read-only
public
string
$invokerId
$invokerName read-only
public
string
$invokerName
$message read-only
public
object|null
$message
= null
$room read-only
public
string
$room
$roomId read-only
public
string|null
$roomId
Methods
__construct()
public
__construct(string $room, string|null $roomId, string $invokerName, string $invokerId, Access $access[, object|null $message = null ]) : mixed
Parameters
- $room : string
-
The room it was typed in, as Links keys it.
- $roomId : string|null
-
The network's own id for that room, when it differs.
- $invokerName : string
-
A display name, for addressing a reply.
- $invokerId : string
-
The network's id for the person — what cooldowns key on.
- $access : Access
-
Their rung on the one ladder, read off the network's idea of rank.
- $message : object|null = null
-
The originating message, for an action that needs it.