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

Class PayForwardEvent

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.PayForwardEvent
All Implemented Interfaces:
com.github.philippheuer.events4j.api.domain.IEvent
@Unofficial
public final class PayForwardEvent
extends AbstractChannelEvent
Calls when a user pays forward a gift.

  • Constructor Summary

    Constructors
    Constructor Description
    PayForwardEvent​(com.github.twitch4j.common.events.domain.EventChannel channel, com.github.twitch4j.common.events.domain.EventUser user, com.github.twitch4j.common.events.domain.EventUser priorGifter, com.github.twitch4j.common.events.domain.EventUser recipient)
    Event Constructor

  • Method Summary

    Modifier and Type Method Description
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    com.github.twitch4j.common.events.domain.EventUser getPriorGifter()
    The previous user that gifted to this one, if not anonymous.
    com.github.twitch4j.common.events.domain.EventUser getRecipient()
    The user that is receiving this gift, if it is not for the community at-large.
    com.github.twitch4j.common.events.domain.EventUser getUser()
    The user that is paying forward their gift.
    int hashCode()  
    boolean isCommunityPayForward()  
    java.lang.String toString()  
    boolean wasPriorGifterAnonymous()  

    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

    • PayForwardEvent

      public PayForwardEvent​(com.github.twitch4j.common.events.domain.EventChannel channel, com.github.twitch4j.common.events.domain.EventUser user, com.github.twitch4j.common.events.domain.EventUser priorGifter, com.github.twitch4j.common.events.domain.EventUser recipient)
      Event Constructor
      Parameters:
      channel - The channel that this event originates from.
      user - The user that is paying forward their gift.
      priorGifter - The previous user that gifted to this one, if not anonymous.
      recipient - The user that is receiving this gift, if it is not for the community at-large.

  • Method Details

    • wasPriorGifterAnonymous

      public boolean wasPriorGifterAnonymous()

    • isCommunityPayForward

      public boolean isCommunityPayForward()

    • getUser

      public com.github.twitch4j.common.events.domain.EventUser getUser()
      The user that is paying forward their gift.

    • getPriorGifter

      public com.github.twitch4j.common.events.domain.EventUser getPriorGifter()
      The previous user that gifted to this one, if not anonymous.

    • getRecipient

      public com.github.twitch4j.common.events.domain.EventUser getRecipient()
      The user that is receiving this gift, if it is not for the community at-large.

    • 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