Package com.github.twitch4j.eventsub.events

Class ChannelBanEvent

java.lang.Object

com.github.twitch4j.eventsub.events.EventSubEvent

com.github.twitch4j.eventsub.events.EventSubUserChannelEvent

com.github.twitch4j.eventsub.events.EventSubModerationEvent

com.github.twitch4j.eventsub.events.ChannelBanEvent

All Implemented Interfaces:

ModeratorEvent

public class ChannelBanEvent
extends EventSubModerationEvent

Constructor Summary

Constructors

Constructor	Description
ChannelBanEvent()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Instant	getBannedAt()	The UTC date and time (in RFC3339 format) of when the user was banned or put in a timeout.
@Nullable Instant	getEndsAt()	Will be null if permanent ban.
String	getReason()	The reason behind the ban.
int	hashCode()
Boolean	isPermanent()	Indicates whether the ban is permanent (true) or a timeout (false).
String	toString()

Methods inherited from class com.github.twitch4j.eventsub.events.EventSubModerationEvent

getModeratorUserId, getModeratorUserLogin, getModeratorUserName

Methods inherited from class com.github.twitch4j.eventsub.events.EventSubUserChannelEvent

getBroadcasterUserId, getBroadcasterUserLogin, getBroadcasterUserName, getUserId, getUserLogin, getUserName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChannelBanEvent

public ChannelBanEvent()

Method Details

getReason

public String getReason()

The reason behind the ban.

getBannedAt

public Instant getBannedAt()

The UTC date and time (in RFC3339 format) of when the user was banned or put in a timeout.

getEndsAt

@Nullable
public @Nullable Instant getEndsAt()

Will be null if permanent ban. If it is a timeout, this field shows when the timeout will end.

isPermanent

public Boolean isPermanent()

Indicates whether the ban is permanent (true) or a timeout (false). If true, getEndsAt() will be null.

toString

public String toString()

Overrides:

toString in class EventSubModerationEvent

equals

public boolean equals(Object o)

Overrides:

equals in class EventSubModerationEvent

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class EventSubModerationEvent

hashCode

public int hashCode()

Overrides:

hashCode in class EventSubModerationEvent