Enum SubscriptionEvent.Type

java.lang.Object
java.lang.Enum<SubscriptionEvent.Type>
com.github.twitch4j.helix.domain.SubscriptionEvent.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SubscriptionEvent.Type>, java.lang.constant.Constable
Enclosing class:
SubscriptionEvent

public static enum SubscriptionEvent.Type
extends java.lang.Enum<SubscriptionEvent.Type>
The type of event in the event_data payload.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    NOTIFICATION
    When a user who is subscribed to a broadcaster notifies the broadcaster of their subscription in the chat.
    SUBSCRIBE
    When the subscription payment is processed and the user has officially started their subscription.
    UNSUBSCRIBE
    When a user’s subscription ends.
  • Method Summary

    Modifier and Type Method Description
    static SubscriptionEvent.Type valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SubscriptionEvent.Type[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • SUBSCRIBE

      public static final SubscriptionEvent.Type SUBSCRIBE
      When the subscription payment is processed and the user has officially started their subscription.
    • UNSUBSCRIBE

      public static final SubscriptionEvent.Type UNSUBSCRIBE
      When a user’s subscription ends.
    • NOTIFICATION

      public static final SubscriptionEvent.Type NOTIFICATION
      When a user who is subscribed to a broadcaster notifies the broadcaster of their subscription in the chat.
  • Method Details

    • values

      public static SubscriptionEvent.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static SubscriptionEvent.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null