Package com.github.twitch4j.helix.domain

Class HypeTrainEvent.EventData

java.lang.Object
com.github.twitch4j.helix.domain.HypeTrainEvent.EventData
Enclosing class:
HypeTrainEvent
public static class HypeTrainEvent.EventData
extends java.lang.Object

  • Constructor Summary

    Constructors
    Constructor Description
    EventData()  

  • Method Summary

    Modifier and Type Method Description
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    @NonNull java.lang.String getBroadcasterId()
    Channel ID of which Hype Train events the clients are interested in
    java.time.Instant getCooldownEndTime()
    Timestamp of when another Hype Train can be started again
    java.time.Instant getExpiresAt()
    Timestamp of the expiration time of this Hype Train
    java.lang.Long getGoal()
    The goal value of the level above
    @NonNull java.lang.String getId()
    The distinct ID of this Hype Train
    HypeTrainEvent.Contribution getLastContribution()
    An object that represents the most recent contribution
    java.lang.Integer getLevel()
    The highest level (in the scale of 1-5) reached of the Hype Train
    java.time.Instant getStartedAt()
    Timestamp of when this Hype Train started
    java.util.List<HypeTrainEvent.Contribution> getTopContributions()
    Top contribution objects, one object for each type
    java.lang.Long getTotal()
    The total score so far towards completing the level goal above
    int hashCode()  
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EventData

      public EventData()

  • Method Details

    • getBroadcasterId

      @NonNull public @NonNull java.lang.String getBroadcasterId()
      Channel ID of which Hype Train events the clients are interested in

    • getCooldownEndTime

      public java.time.Instant getCooldownEndTime()
      Timestamp of when another Hype Train can be started again

    • getExpiresAt

      public java.time.Instant getExpiresAt()
      Timestamp of the expiration time of this Hype Train

    • getGoal

      public java.lang.Long getGoal()
      The goal value of the level above

    • getTotal

      public java.lang.Long getTotal()
      The total score so far towards completing the level goal above

    • getId

      @NonNull public @NonNull java.lang.String getId()
      The distinct ID of this Hype Train

    • getLastContribution

      public HypeTrainEvent.Contribution getLastContribution()
      An object that represents the most recent contribution

    • getLevel

      public java.lang.Integer getLevel()
      The highest level (in the scale of 1-5) reached of the Hype Train

    • getStartedAt

      public java.time.Instant getStartedAt()
      Timestamp of when this Hype Train started

    • getTopContributions

      public java.util.List<HypeTrainEvent.Contribution> getTopContributions()
      Top contribution objects, one object for each type

      For example, one object would represent top contributor of BITS, by aggregate, and one would represent top contributor of SUBS by count

    • equals

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

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

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