java.lang.Object

com.gmt2001.twitch.eventsub.EventSubSubscriptionType

com.gmt2001.twitch.eventsub.subscriptions.channel.ChannelFollow

All Implemented Interfaces:: Flow.Subscriber<EventSubInternalEvent>

public final class ChannelFollow extends EventSubSubscriptionType

A specified channel receives a follow.

Author:: gmt2001

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

ChannelFollow()

Only used by EventSub for handler registration

ChannelFollow(EventSubInternalNotificationEvent e)

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

ChannelFollow(String broadcaster_user_id)

Constructor

ChannelFollow(String broadcaster_user_id, String moderator_user_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.

ZonedDateTime

followedAt()

The timestamp of when the follow occurred.

String

followedAtString()

The timestamp of when the follow occurred as a string.

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

String

userId()

The new follower's user ID.

String

userLogin()

The new follower's user login.

String

userName()

The new follower's user display name.

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
- ChannelFollow
  
  public ChannelFollow()
  
  Only used by EventSub for handler registration
- ChannelFollow
  
  public ChannelFollow(EventSubInternalNotificationEvent e)
  
  Used by onEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent) to construct an object from an incoming notification
  
  Parameters:
  
  e - The event
- ChannelFollow
  
  public ChannelFollow(String broadcaster_user_id)
  
  Constructor
  
  Parameters:
  
  broadcaster_user_id - The user id of the broadcaster
- ChannelFollow
  
  public ChannelFollow(String broadcaster_user_id, String moderator_user_id)
  
  Constructor
  
  Parameters:
  
  broadcaster_user_id - The user id of the broadcaster
  
  moderator_user_id - The ID of the moderator of the channel you want to get notifications for. If you have authorization from the broadcaster rather than a moderator, specify the broadcaster's user ID here
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()
  
  The new follower's user ID.
  
  Returns:
- userLogin
  
  public String userLogin()
  
  The new follower's user login.
  
  Returns:
- userName
  
  public String userName()
  
  The new follower's user display name.
  
  Returns:
- followedAtString
  
  public String followedAtString()
  
  The timestamp of when the follow occurred as a string.
  
  Returns:
- followedAt
  
  public ZonedDateTime followedAt()
  
  The timestamp of when the follow occurred.
  
  Returns:

Class ChannelFollow

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

ChannelFollow

ChannelFollow

ChannelFollow

ChannelFollow

Method Details

proposeSubscription

validateParameters

onEventSubInternalNotificationEvent

isMatch

broadcasterUserId

broadcasterUserLogin

broadcasterUserName

userId

userLogin

userName

followedAtString

followedAt