Timeout User
Timeout a user
Preview
Moderators
Timing out a moderator will automatically reassign their moderator status once the timeout period ends. Editors will not receive their editior rights back.
This only applies to the subaction.
The C# method does not reassign their moderator status. You'll need to implement your own logic in C# to handle this.
Timing out a moderator will automatically reassign their moderator status once the timeout period ends. Editors will not receive their editior rights back.
This only applies to the subaction.
The C# method does not reassign their moderator status. You'll need to implement your own logic in C# to handle this.
Parameters
User Loginrequired
String
Can be a user name or a variable like %userName%
Durationrequired
Int
Timeout duration in seconds. 0 is a permanent ban.
Reason
String
Reason for the timeout
Variables
The following variables will be populated after executing this sub-action:
| Description | ||
|---|---|---|
timedOutUser | string | display name of the timed out user Example: PewDiePie |
timedOutUserId | string | ID of the timed out user Example: 12345678 |
timedOutUserName | string | login name of the timed out user Example: pewdiepie |
timedOutUserType | string | platform of the timed out user Example: twitch |
timeoutResult | bool | indicator whether the timeout has been successful or not Example: True/False |
C# Usage
public bool TwitchTimeoutUser(string username, int duration, string reason, bool bot = false)