Package com.github.twitch4j.pubsub.domain

Class ChannelBitsData

java.lang.Object
com.github.twitch4j.pubsub.domain.ChannelBitsData
public class ChannelBitsData extends Object

  • Constructor Details

    • ChannelBitsData

      public ChannelBitsData()

  • Method Details

    • getTimeAsInstant

      public Instant getTimeAsInstant()
      Returns:
      the parsed time in an Instant wrapper

    • getUserId

      @Nullable public @Nullable String getUserId()
      The id for the user that cheered

    • getUserName

      @Nullable public @Nullable String getUserName()
      The login name for the user that cheered

    • getChannelId

      public String getChannelId()
      The id for the channel where the bits were used

    • getChannelName

      public String getChannelName()
      The login name of the channel where the bits were used

    • getTime

      public String getTime()
      RFC 3339 timestamp of when the bits were used

    • getChatMessage

      public String getChatMessage()
      The message sent with the cheer

    • getBitsUsed

      public Integer getBitsUsed()
      The number of bits used

    • getTotalBitsUsed

      public Integer getTotalBitsUsed()
      A cumulative total of all bits this user has cheered in this channel

    • getContext

      public String getContext()
      The event type for this bits usage (e.g. "cheer")

    • getBadgeEntitlement

      public ChannelBitsData.BadgeEntitlement getBadgeEntitlement()
      If a non-anonymous user reached a new badge level with this cheer, this object will contain more information regarding the new level

    • isAnonymous

      public Boolean isAnonymous()
      Whether or not the event was anonymous

    • setUserId

      public void setUserId(@Nullable @Nullable String userId)
      The id for the user that cheered

    • setUserName

      public void setUserName(@Nullable @Nullable String userName)
      The login name for the user that cheered

    • setChannelId

      public void setChannelId(String channelId)
      The id for the channel where the bits were used

    • setChannelName

      public void setChannelName(String channelName)
      The login name of the channel where the bits were used

    • setTime

      public void setTime(String time)
      RFC 3339 timestamp of when the bits were used

    • setChatMessage

      public void setChatMessage(String chatMessage)
      The message sent with the cheer

    • setBitsUsed

      public void setBitsUsed(Integer bitsUsed)
      The number of bits used

    • setTotalBitsUsed

      public void setTotalBitsUsed(Integer totalBitsUsed)
      A cumulative total of all bits this user has cheered in this channel

    • setContext

      public void setContext(String context)
      The event type for this bits usage (e.g. "cheer")

    • setBadgeEntitlement

      public void setBadgeEntitlement(ChannelBitsData.BadgeEntitlement badgeEntitlement)
      If a non-anonymous user reached a new badge level with this cheer, this object will contain more information regarding the new level

    • isAnonymous

      public ChannelBitsData isAnonymous(Boolean isAnonymous)
      Whether or not the event was anonymous
      Returns:
      this.

    • 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