Package com.github.twitch4j.chat.events.channel

Class RitualEvent

java.lang.Object

com.github.philippheuer.events4j.core.domain.Event

com.github.twitch4j.chat.events.TwitchEvent

com.github.twitch4j.chat.events.AbstractChannelEvent

com.github.twitch4j.chat.events.channel.RitualEvent

All Implemented Interfaces:

com.github.philippheuer.events4j.api.domain.IEvent

@Deprecated
@ScheduledForRemoval(inVersion="2.0.0")
public final class RitualEvent
extends AbstractChannelEvent

Deprecated.

no longer sent by twitch.

Called when a ritual takes place in chat.

Many channels have special rituals to celebrate viewer milestones when they are shared. The rituals notice extends the sharing of these messages to other viewer milestones (initially, a new viewer chatting for the first time).

See Also:

• Shut down announcement

Constructor Summary

Constructors

Constructor	Description
RitualEvent(EventChannel channel, EventUser user, String ritualName)	Deprecated. Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)	Deprecated.
boolean	equals(Object o)	Deprecated.
String	getRitualName()	Deprecated. The name of the ritual this notice is for.
EventUser	getUser()	Deprecated. The user involved in the ritual.
int	hashCode()	Deprecated.
boolean	isNewChatter()	Deprecated.
String	toString()	Deprecated.

Methods inherited from class com.github.twitch4j.chat.events.AbstractChannelEvent

ban, getChannel, timeout, unban

Methods inherited from class com.github.twitch4j.chat.events.TwitchEvent

getTwitchChat

Methods inherited from class com.github.philippheuer.events4j.core.domain.Event

getEventId, getFiredAt, getFiredAtInstant, getServiceMediator, setEventId, setFiredAt, setFiredAtInstant, setServiceMediator

Methods inherited from class java.lang.Object

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

Constructor Details

RitualEvent

public RitualEvent(EventChannel channel,
 EventUser user,
 String ritualName)

Deprecated.

Event Constructor

Parameters:

channel - The channel that this event originates from.

user - The user involved in the ritual.

ritualName - The name of the ritual this notice is for.

Method Details

isNewChatter

public boolean isNewChatter()

Deprecated.

Returns:

whether the ritual corresponds to a new viewer chatting for the first time

getUser

public EventUser getUser()

Deprecated.

The user involved in the ritual.

getRitualName

public String getRitualName()

Deprecated.

The name of the ritual this notice is for.

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class AbstractChannelEvent

canEqual

protected boolean canEqual(Object other)

Deprecated.

Overrides:

canEqual in class AbstractChannelEvent

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class AbstractChannelEvent

toString

public String toString()

Deprecated.

Overrides:

toString in class AbstractChannelEvent