Command.Cooldown
WebSocket event schema, payload, and examples
user
object required
display
string
id
string
name
string
role
integer required
Value | Name |
---|---|
0 | Unknown |
1 | Viewer |
2 | Vip |
3 | Moderator |
4 | Broadcaster |
subscribed
boolean required
type
string
id
string
name
string
command
string
cooldownLeft
integer required
globalCooldownLeft
integer required
userCooldownLeft
integer required
message
string
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CommandCooldownEvent",
"type": "object",
"additionalProperties": false,
"properties": {
"user": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/BaseViewer"
}
]
},
"id": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"command": {
"type": [
"null",
"string"
]
},
"cooldownLeft": {
"type": "integer",
"format": "int32"
},
"globalCooldownLeft": {
"type": "integer",
"format": "int32"
},
"userCooldownLeft": {
"type": "integer",
"format": "int32"
},
"message": {
"type": [
"null",
"string"
]
}
},
"definitions": {
"BaseViewer": {
"type": "object",
"additionalProperties": false,
"properties": {
"display": {
"type": [
"null",
"string"
]
},
"id": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"role": {
"$ref": "#/definitions/ViewerRole"
},
"subscribed": {
"type": "boolean"
},
"type": {
"type": [
"null",
"string"
]
}
}
},
"ViewerRole": {
"type": "integer",
"description": "",
"x-enum-names": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enum-varnames": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enumNames": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enum-descriptions": [
null,
null,
null,
null,
null
],
"x-enumDescriptions": [
null,
null,
null,
null,
null
],
"enum": [
0,
1,
2,
3,
4
]
}
}
}
JSON Payload
An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
"command": "dolore labore",
"cooldownLeft": -98019051,
"globalCooldownLeft": -78135720,
"id": "id dolor laboris voluptate laborum",
"message": null,
"name": "incididunt ad Ut culpa",
"user": null,
"userCooldownLeft": -26045190
}
Client Example
Example code showing how to subscribe to this event using the Streamer.bot WebSocket Client
index.js
// Initialize the Streamer.bot WebSocket Client
const client = new StreamerbotClient();
// Subscribe to "Command.Cooldown" events and register a callback
client.on('Command.Cooldown', ({ event, data }) => {
// Code here will run every time the event is received!
console.log('Received event:', event.source, event.type);
console.log('Event data:', data);
});