Class HypeTrainEvent.EventData

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

public static class HypeTrainEvent.EventData extends Object
  • Constructor Details

    • EventData

      public EventData()
  • Method Details

    • getBroadcasterId

      @NonNull public @NonNull String getBroadcasterId()
      Channel ID of which Hype Train events the clients are interested in
    • getCooldownEndTime

      public Instant getCooldownEndTime()
      Timestamp of when another Hype Train can be started again
    • getExpiresAt

      public Instant getExpiresAt()
      Timestamp of the expiration time of this Hype Train
    • getGoal

      public Long getGoal()
      The goal value of the level above
    • getTotal

      public Long getTotal()
      The total score so far towards completing the level goal above
    • getId

      @NonNull public @NonNull String getId()
      The distinct ID of this Hype Train
    • getLastContribution

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

      public Integer getLevel()
      The highest level (in the scale of 1-5) reached of the Hype Train
    • getStartedAt

      public Instant getStartedAt()
      Timestamp of when this Hype Train started
    • getTopContributions

      public 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(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object