timeoutUser

Times out a user in a channel.

version(TwitchSupport && WithTwitchPlugin)

package

timeoutUser

(

TwitchPlugin plugin

,

const string channelName

,

const ulong userID

,

const uint durationSeconds

,

const string reason = string.init

,

const string caller = __FUNCTION__

,

const bool recursing = false

)

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.
recursing bool: Whether or not this function is recursing into itself.

Return Value

Type: auto

A Voldemort struct with information about the timeout action.

Throws

UnexpectedJSONException on unexpected JSON received. ErrorJSONException if the response contained an error object.

See Also

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