Package com.github.twitch4j.helix.domain

Class BanUserInput.BanUserInputBuilder

java.lang.Object

com.github.twitch4j.helix.domain.BanUserInput.BanUserInputBuilder

Enclosing class:

BanUserInput

public static class BanUserInput.BanUserInputBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
BanUserInput	build()
BanUserInput.BanUserInputBuilder	duration(@Nullable Integer duration)	Specify for a timeout, otherwise leave null for a ban.
BanUserInput.BanUserInputBuilder	reason(String reason)	The reason the user is being banned or put in a timeout.
String	toString()
BanUserInput.BanUserInputBuilder	userId(String userId)	The ID of the user to ban or put in a timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

userId

public BanUserInput.BanUserInputBuilder userId(String userId)

The ID of the user to ban or put in a timeout.

Returns:

this.

reason

public BanUserInput.BanUserInputBuilder reason(String reason)

The reason the user is being banned or put in a timeout. The text is user defined and limited to a maximum of 500 characters.

Returns:

this.

duration

public BanUserInput.BanUserInputBuilder duration(@Nullable
 @Nullable Integer duration)

Specify for a timeout, otherwise leave null for a ban.

To ban a user indefinitely, don’t include this field. To put a user in a timeout, include this field and specify the timeout period, in seconds.

The minimum timeout is 1 second and the maximum is 1,209,600 seconds (2 weeks).

To end a user’s timeout early, set this field to 1, or send an Unban user request.

Returns:

this.

build

public BanUserInput build()

toString

public String toString()

Overrides:

toString in class Object