Timeout User
Timeout a Kick user
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.
Variables
The following variables will be populated after executing this sub-action:
| Description | ||
|---|---|---|
timedOutUser | string | display name of the timed out user Example: GenericUser |
timedOutUserId | string | ID of the timed out user Example: 12345678 |
timedOutUserName | string | login name of the timed out user Example: genericuser |
timedOutUserType | string | platform of the timed out user Example: kick |
timeoutResult | bool | indicator whether the timeout has been successful or not Example: True/False |
C# Usage
Times out the selected Kick user for the selected duration
1.0.0
public bool KickTimeoutUser(string username, int duration, string reason, bool bot = false)