Class Subscription

java.lang.Object
com.github.twitch4j.helix.domain.Subscription

public class Subscription
extends java.lang.Object
  • Constructor Summary

    Constructors
    Constructor Description
    Subscription()  
  • Method Summary

    Modifier and Type Method Description
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    @NonNull java.lang.String getBroadcasterId()
    User ID of the broadcaster.
    @NonNull java.lang.String getBroadcasterLogin()
    Login name of the broadcaster.
    @NonNull java.lang.String getBroadcasterName()
    Display name of the broadcaster.
    java.lang.String getGifterId()
    ID of the user who gifted the sub.
    java.lang.String getGifterLogin()
    If the subscription was gifted, this is the login of the gifter.
    java.lang.String getGifterName()
    Display name of the user who gifted the sub.
    java.lang.Boolean getIsGift()
    Determines if the subscription is a gift subscription.
    java.lang.String getPlan_name()
    Deprecated.
    will be removed in favor of .getPlanName()
    @NonNull java.lang.String getPlanName()
    Name of the subscription.
    @NonNull java.lang.String getTier()
    Type of subscription (Tier 1, Tier 2, Tier 3). 1000 = Tier 1, 2000 = Tier 2, 3000 = Tier 3 subscriptions.
    @NonNull java.lang.String getUserId()
    ID of the subscribed user.
    @NonNull java.lang.String getUserLogin()
    Login of the subscribed user.
    @NonNull java.lang.String getUserName()
    Display name of the subscribed user.
    int hashCode()  
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Subscription

      public Subscription()
  • Method Details

    • getPlan_name

      @Deprecated public java.lang.String getPlan_name()
      Deprecated.
      will be removed in favor of .getPlanName()
      Returns:
      the subscription plan name
    • getBroadcasterId

      @NonNull public @NonNull java.lang.String getBroadcasterId()
      User ID of the broadcaster.
    • getBroadcasterLogin

      @NonNull public @NonNull java.lang.String getBroadcasterLogin()
      Login name of the broadcaster.
    • getBroadcasterName

      @NonNull public @NonNull java.lang.String getBroadcasterName()
      Display name of the broadcaster.
    • getIsGift

      public java.lang.Boolean getIsGift()
      Determines if the subscription is a gift subscription.
    • getGifterId

      public java.lang.String getGifterId()
      ID of the user who gifted the sub.
    • getGifterLogin

      public java.lang.String getGifterLogin()
      If the subscription was gifted, this is the login of the gifter.
    • getGifterName

      public java.lang.String getGifterName()
      Display name of the user who gifted the sub.
    • getTier

      @NonNull public @NonNull java.lang.String getTier()
      Type of subscription (Tier 1, Tier 2, Tier 3). 1000 = Tier 1, 2000 = Tier 2, 3000 = Tier 3 subscriptions.
    • getPlanName

      @NonNull public @NonNull java.lang.String getPlanName()
      Name of the subscription.
    • getUserId

      @NonNull public @NonNull java.lang.String getUserId()
      ID of the subscribed user.
    • getUserLogin

      @NonNull public @NonNull java.lang.String getUserLogin()
      Login of the subscribed user.
    • getUserName

      @NonNull public @NonNull java.lang.String getUserName()
      Display name of the subscribed user.
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • canEqual

      protected boolean canEqual​(java.lang.Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object