java.lang.Object

com.gmt2001.twitch.eventsub.EventSubSubscriptionType

com.gmt2001.twitch.eventsub.subscriptions.channel.channel_points.redemption.ChannelPointsCustomRewardRedemptionAdd

All Implemented Interfaces:: Flow.Subscriber<EventSubInternalEvent>

public final class ChannelPointsCustomRewardRedemptionAdd extends EventSubSubscriptionType

A viewer has redeemed a custom channel points reward on the specified channel

Author:: gmt2001

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

ChannelPointsCustomRewardRedemptionAdd.RedemptionStatus

The status of the redemption
Field Summary

Fields

Modifier and Type

Field

Description

static final String

TYPE

static final String

VERSION

Fields inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType
flowsubscription, messageId, messageTimestamp, subscription
Constructor Summary

Constructors

Constructor

Description

ChannelPointsCustomRewardRedemptionAdd()

Only used by EventSub for handler registration

ChannelPointsCustomRewardRedemptionAdd(EventSubInternalNotificationEvent e)

Used by onEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent) to construct an object from an incoming notification

ChannelPointsCustomRewardRedemptionAdd(String broadcaster_user_id)

Constructor.

ChannelPointsCustomRewardRedemptionAdd(String broadcaster_user_id, String reward_id)

Constructor.
Method Summary

Modifier and Type

Method

Description

String

broadcasterUserId()

The broadcaster's user ID.

String

broadcasterUserLogin()

The broadcaster's user login.

String

broadcasterUserName()

The broadcaster's user display name.

String

id()

The redemption identifier.

protected boolean

isMatch(EventSubSubscription subscription)

Returns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditions

protected void

onEventSubInternalNotificationEvent(EventSubInternalNotificationEvent e)

protected EventSubSubscription

proposeSubscription()

Compiles the parameters of this object into an EventSubSubscription that can be created

ZonedDateTime

redeemedAt()

Timestamp of when the reward was redeemed.

String

redeemedAtString()

RFC3339 timestamp of when the reward was redeemed as a string.

ChannelPointsReward

reward()

Basic information about the reward that was redeemed, at the time it was redeemed.

ChannelPointsCustomRewardRedemptionAdd.RedemptionStatus

status()

The status of the redemption.

String

statusString()

The status of the redemption as a string.

String

userId()

User ID of the user that redeemed the reward.

String

userInput()

The user input provided.

String

userLogin()

Login of the user that redeemed the reward.

String

userName()

Display name of the user that redeemed the reward.

protected void

validateParameters()

Validates that the provided parameters are acceptable for use in EventSubSubscriptionType.proposeSubscription()

Methods inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType
create, delete, deleteAll, findMatchingSubscriptionId, findMatchingSubscriptionIds, getExistingSubscription, isAlreadySubscribed, messageId, messageTimestamp, onComplete, onError, onEventSubInternalEvent, onEventSubInternalRevocationEvent, onEventSubInternalVerificationEvent, onNext, onSubscribe, proposeSubscriptionInternal, proposeTransport, subscribe, subscription

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- TYPE
  
  public static final String TYPE
  See Also:
  
  Constant Field Values
- VERSION
  
  public static final String VERSION
  See Also:
  
  Constant Field Values
Constructor Details
- ChannelPointsCustomRewardRedemptionAdd
  
  public ChannelPointsCustomRewardRedemptionAdd()
  
  Only used by EventSub for handler registration
- ChannelPointsCustomRewardRedemptionAdd
  
  public ChannelPointsCustomRewardRedemptionAdd(EventSubInternalNotificationEvent e)
  
  Used by onEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent) to construct an object from an incoming notification
  
  Parameters:
  
  e - The event
- ChannelPointsCustomRewardRedemptionAdd
  
  public ChannelPointsCustomRewardRedemptionAdd(String broadcaster_user_id)
  
  Constructor. Subscribes to all rewards for the broadcaster
  
  Parameters:
  
  broadcaster_user_id - The user id of the broadcaster
- ChannelPointsCustomRewardRedemptionAdd
  
  public ChannelPointsCustomRewardRedemptionAdd(String broadcaster_user_id, String reward_id)
  
  Constructor. Subscribes only to the specified reward for the broadcaster
  
  Parameters:
  
  broadcaster_user_id - The user id of the broadcaster
  
  reward_id - The id of the reward
Method Details
- proposeSubscription
  
  protected EventSubSubscription proposeSubscription()
  
  Description copied from class: EventSubSubscriptionType
  
  Compiles the parameters of this object into an EventSubSubscription that can be created
  
  Specified by:
  
  proposeSubscription in class EventSubSubscriptionType
  
  Returns:
- validateParameters
  
  protected void validateParameters() throws IllegalArgumentException
  
  Description copied from class: EventSubSubscriptionType
  
  Validates that the provided parameters are acceptable for use in EventSubSubscriptionType.proposeSubscription()
  
  Specified by:
  
  validateParameters in class EventSubSubscriptionType
  
  Throws:
  
  IllegalArgumentException - One of the parameters is not acceptable
- onEventSubInternalNotificationEvent
  
  protected void onEventSubInternalNotificationEvent(EventSubInternalNotificationEvent e)
  
  Overrides:
  
  onEventSubInternalNotificationEvent in class EventSubSubscriptionType
- isMatch
  
  protected boolean isMatch(EventSubSubscription subscription)
  
  Description copied from class: EventSubSubscriptionType
  
  Returns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditions
  
  Specified by:
  
  isMatch in class EventSubSubscriptionType
  
  Returns:
- broadcasterUserId
  
  public String broadcasterUserId()
  
  The broadcaster's user ID.
  
  Returns:
- broadcasterUserLogin
  
  public String broadcasterUserLogin()
  
  The broadcaster's user login.
  
  Returns:
- broadcasterUserName
  
  public String broadcasterUserName()
  
  The broadcaster's user display name.
  
  Returns:
- userId
  
  public String userId()
  
  User ID of the user that redeemed the reward.
  
  Returns:
- userLogin
  
  public String userLogin()
  
  Login of the user that redeemed the reward.
  
  Returns:
- userName
  
  public String userName()
  
  Display name of the user that redeemed the reward.
  
  Returns:
- id
  
  public String id()
  
  The redemption identifier.
  
  Returns:
- userInput
  
  public String userInput()
  
  The user input provided. Empty string if not provided.
  
  Returns:
- statusString
  
  public String statusString()
  
  The status of the redemption as a string.
  
  Returns:
- status
  
  public ChannelPointsCustomRewardRedemptionAdd.RedemptionStatus status()
  
  The status of the redemption.
  
  Returns:
- reward
  
  public ChannelPointsReward reward()
  
  Basic information about the reward that was redeemed, at the time it was redeemed.
  
  Returns:
- redeemedAtString
  
  public String redeemedAtString()
  
  RFC3339 timestamp of when the reward was redeemed as a string.
  
  Returns:
- redeemedAt
  
  public ZonedDateTime redeemedAt()
  
  Timestamp of when the reward was redeemed.
  
  Returns:

Class ChannelPointsCustomRewardRedemptionAdd

Nested Class Summary

Field Summary

Fields inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType

Constructor Summary

Method Summary

Methods inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType

Methods inherited from class java.lang.Object

Field Details

TYPE

VERSION

Constructor Details

ChannelPointsCustomRewardRedemptionAdd

ChannelPointsCustomRewardRedemptionAdd

ChannelPointsCustomRewardRedemptionAdd

ChannelPointsCustomRewardRedemptionAdd

Method Details

proposeSubscription

validateParameters

onEventSubInternalNotificationEvent

isMatch

broadcasterUserId

broadcasterUserLogin

broadcasterUserName

userId

userLogin

userName

id

userInput

statusString

status

reward

redeemedAtString

redeemedAt