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
public final class RitualEvent
extends AbstractChannelEvent
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).

  • Constructor Summary

    Constructors
    Constructor Description
    RitualEvent​(com.github.twitch4j.common.events.domain.EventChannel channel, com.github.twitch4j.common.events.domain.EventUser user, java.lang.String ritualName)
    Event Constructor

  • Method Summary

    Modifier and Type Method Description
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.lang.String getRitualName()
    The name of the ritual this notice is for.
    com.github.twitch4j.common.events.domain.EventUser getUser()
    The user involved in the ritual.
    int hashCode()  
    boolean isNewChatter()  
    java.lang.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

  • Constructor Details

    • RitualEvent

      public RitualEvent​(com.github.twitch4j.common.events.domain.EventChannel channel, com.github.twitch4j.common.events.domain.EventUser user, java.lang.String ritualName)
      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()
      Returns:
      whether the ritual corresponds to a new viewer chatting for the first time

    • getUser

      public com.github.twitch4j.common.events.domain.EventUser getUser()
      The user involved in the ritual.

    • getRitualName

      public java.lang.String getRitualName()
      The name of the ritual this notice is for.

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class AbstractChannelEvent

    • canEqual

      protected boolean canEqual​(java.lang.Object other)
      Overrides:
      canEqual in class AbstractChannelEvent

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractChannelEvent

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class AbstractChannelEvent