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

Class RaidEvent

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.RaidEvent

All Implemented Interfaces:

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

public final class RaidEvent
extends AbstractChannelEvent
implements MirrorableEvent

This event gets called when a user receives a raid.

This event is not called when a user receives a host that is not part of a raid.

Constructor Summary

Constructors

Constructor	Description
RaidEvent(IRCMessageEvent event, EventChannel channel, EventUser raider, Integer viewers)	Inbound Raid Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
IRCMessageEvent	getMessageEvent()	Raw Message Event
EventUser	getRaider()	Event User who initiated the raid
Integer	getViewers()	Number of viewers in the raid
int	hashCode()
String	toString()

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

Methods inherited from interface com.github.twitch4j.chat.events.channel.MirrorableEvent

getSourceBadgeInfo, getSourceBadges, getSourceChannelId, getSourceMessageId, getSourceNoticeType, isMirrored

Constructor Details

RaidEvent

@Internal
public RaidEvent(IRCMessageEvent event,
 EventChannel channel,
 EventUser raider,
 Integer viewers)

Inbound Raid Event Constructor

Parameters:

event - Raw Message Event

channel - ChatChannel receiving the raid

raider - User who is sending the raid

viewers - number of viewers from the raid

Method Details

getMessageEvent

public IRCMessageEvent getMessageEvent()

Raw Message Event

Specified by:

getMessageEvent in interface MirrorableEvent

Returns:

the raw message event

getRaider

public EventUser getRaider()

Event User who initiated the raid

getViewers

public Integer getViewers()

Number of viewers in the raid

toString

public String toString()

Overrides:

toString in class AbstractChannelEvent

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractChannelEvent

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractChannelEvent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractChannelEvent