Package com.github.twitch4j.eventsub.events

Class ChannelPointsCustomRewardEvent

java.lang.Object
com.github.twitch4j.eventsub.events.EventSubEvent
com.github.twitch4j.eventsub.events.EventSubChannelEvent
com.github.twitch4j.eventsub.events.ChannelPointsCustomRewardEvent
Direct Known Subclasses:
CustomRewardAddEvent, CustomRewardRemoveEvent, CustomRewardUpdateEvent
public abstract class ChannelPointsCustomRewardEvent extends EventSubChannelEvent

  • Constructor Details

    • ChannelPointsCustomRewardEvent

      public ChannelPointsCustomRewardEvent()

  • Method Details

    • getId

      public String getId()
      The reward identifier.

    • isEnabled

      public Boolean isEnabled()
      Whether the reward is currently enabled. If false, the reward won’t show up to viewers.

    • isPaused

      public Boolean isPaused()
      Whether the reward is currently paused. If true, viewers can’t redeem.

    • isInStock

      public Boolean isInStock()
      Whether the reward is currently in stock. If false, viewers can’t redeem.

    • getTitle

      public String getTitle()
      The reward title.

    • getCost

      public Integer getCost()
      The reward cost.

    • getPrompt

      public String getPrompt()
      The reward description.

    • isUserInputRequired

      public Boolean isUserInputRequired()
      Whether the viewer needs to enter information when redeeming the reward.

    • getShouldRedemptionsSkipRequestQueue

      public Boolean getShouldRedemptionsSkipRequestQueue()
      Whether redemptions should be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status.

    • getMaxPerStream

      public MaxPerStream getMaxPerStream()
      Whether a maximum per stream is enabled and what the maximum is.

    • getMaxPerUserPerStream

      public MaxPerUserPerStream getMaxPerUserPerStream()
      Whether a maximum per user per stream is enabled and what the maximum is.

    • getBackgroundColor

      public String getBackgroundColor()
      Custom background color for the reward.

    • getImage

      public Reward.Image getImage()
      Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded.

    • getDefaultImage

      public Reward.Image getDefaultImage()
      Set of default images of 1x, 2x and 4x sizes for the reward.

    • getGlobalCooldown

      public GlobalCooldown getGlobalCooldown()
      Whether a cooldown is enabled and what the cooldown is in seconds.

    • getCooldownExpiresAt

      public Instant getCooldownExpiresAt()
      Timestamp of the cooldown expiration. null if the reward isn’t on cooldown.

    • getRedemptionsRedeemedCurrentStream

      public Integer getRedemptionsRedeemedCurrentStream()
      The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn’t live or max_per_stream isn’t enabled.

    • toString

      public String toString()
      Overrides:
      toString in class EventSubChannelEvent

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class EventSubChannelEvent

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class EventSubChannelEvent

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class EventSubChannelEvent