Package com.github.twitch4j.helix.domain

Class HypeTrain

java.lang.Object
com.github.twitch4j.helix.domain.HypeTrain
public class HypeTrain extends Object

  • Constructor Details

    • HypeTrain

      public HypeTrain()

  • Method Details

    • getId

      public String getId()
      The Hype Train ID.

    • getBroadcasterUserId

      public String getBroadcasterUserId()
      The broadcaster ID.

    • getBroadcasterUserLogin

      public String getBroadcasterUserLogin()
      The broadcaster login.

    • getBroadcasterUserName

      public String getBroadcasterUserName()
      The broadcaster display name.

    • getLevel

      public int getLevel()
      The current level of the Hype Train.

    • getTotal

      public int getTotal()
      Total points contributed to the Hype Train.

    • getProgress

      public int getProgress()
      The number of points contributed to the Hype Train at the current level.

    • getGoal

      public int getGoal()
      The number of points required to reach the next level.

    • getTopContributions

      public List<Contribution> getTopContributions()
      The contributors with the most points contributed.

    • getSharedTrainParticipants

      @Nullable public @Nullable List<SharedChatParticipant> getSharedTrainParticipants()
      The broadcasters participating in the shared Hype Train. Null if the Hype Train is not shared.

    • getStartedAt

      public Instant getStartedAt()
      The time when the Hype Train started.

    • getExpiresAt

      public Instant getExpiresAt()
      The time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level.

    • getType

      public HypeTrain.Type getType()
      The type of the Hype Train.

    • isSharedTrain

      public boolean isSharedTrain()
      Indicates if the Hype Train is shared. When true, getSharedTrainParticipants() will contain the list of broadcasters the train is shared with.

    • 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