timeoutUser

Times out a user in a channel.

version(TwitchSupport && WithTwitchPlugin)

timeoutUser

(

TwitchPlugin plugin

,

const string channelName

,

const ulong userID

,

const uint durationSeconds

,

const string reason = string.init

,

const string caller = __FUNCTION__

)

Parameters

plugin TwitchPlugin: The current TwitchPlugin.
channelName string: Name of channel to timeout a user in.
userID ulong: Twitch ID of user to timeout.
durationSeconds uint: Duration of timeout in seconds.
reason string: Timeout reason.
caller string: Name of the calling function.

Return Value

Type: auto

A Voldemort struct with information about the timeout action.

Throws

HTTPQueryException on 409 Conflict, when the user is already in the process of being timed out.

See Also

https://dev.twitch.tv/docs/api/reference/#create-a-banned-event