java.lang.Object

com.gmt2001.twitch.eventsub.EventSubSubscriptionType

com.gmt2001.twitch.eventsub.subscriptions.Test

All Implemented Interfaces:: Flow.Subscriber<EventSubInternalEvent>

public final class Test extends EventSubSubscriptionType

Test type for development.

Author:: gmt2001

Field Summary

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

Constructors

Constructor

Description

Test()

Only used by EventSub for handler registration

Test(EventSubInternalNotificationEvent e)

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

Test(String type, String version, String[][] condition)

Constructor

Test(String type, String version, Map<String,String> condition)

Constructor
Method Summary

Modifier and Type

Method

Description

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)

JSONObject

payload()

The event payload

protected EventSubSubscription

proposeSubscription()

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

static void

sendTestEvent(String type, String version, String payload)

Allows sending a test payload to the EventSub handler

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

Constructor Details
- Test
  
  public Test()
  
  Only used by EventSub for handler registration
- Test
  
  public Test(String type, String version, Map<String,String> condition)
  
  Constructor
  
  Parameters:
  
  type - The subscription type
  
  version - The subscription version
  
  condition - The subscription condition
- Test
  
  public Test(String type, String version, String[][] condition)
  
  Constructor
  
  Parameters:
  
  type - The subscription type
  
  version - The subscription version
  
  condition - The subscription condition as key-value pairs
- Test
  
  public Test(EventSubInternalNotificationEvent e)
  
  Used by onEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent) to construct an object from an incoming notification
  
  Parameters:
  
  e - The event
Method Details
- 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
- 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:
- 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:
- payload
  
  public JSONObject payload()
  
  The event payload
  
  Returns:
- sendTestEvent
  
  public static void sendTestEvent(String type, String version, String payload)
  
  Allows sending a test payload to the EventSub handler
  
  Parameters:
  
  type - Subscription Type
  
  version - Subscription Version
  
  payload - EventSub payload

Class Test

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

Constructor Details

Test

Test

Test

Test

Method Details

validateParameters

proposeSubscription

onEventSubInternalNotificationEvent

isMatch

payload

sendTestEvent