Class ChannelUpdate
java.lang.Object
com.gmt2001.twitch.eventsub.EventSubSubscriptionType
com.gmt2001.twitch.eventsub.subscriptions.channel.ChannelUpdate
- All Implemented Interfaces:
Flow.Subscriber<EventSubInternalEvent>
A broadcaster updates their channel properties e.g., category, title, mature flag, broadcast, or language.
- Author:
- gmt2001
-
Field Summary
FieldsFields inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType
flowsubscription, messageId, messageTimestamp, subscription
-
Constructor Summary
ConstructorsConstructorDescriptionOnly used by EventSub for handler registrationUsed byonEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent)
to construct an object from an incoming notificationChannelUpdate
(String broadcaster_user_id) Constructor -
Method Summary
Modifier and TypeMethodDescriptionThe broadcaster's user ID.The broadcaster's user login.The broadcaster's user display name.The channel's category ID.The category name.protected boolean
isMatch
(EventSubSubscription subscription) Returns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditionsboolean
isMature()
A boolean identifying whether the channel is flagged as mature.language()
The channel's broadcast language.protected void
protected EventSubSubscription
Compiles the parameters of this object into anEventSubSubscription
that can be createdtitle()
The channel's stream title.protected void
Validates that the provided parameters are acceptable for use inEventSubSubscriptionType.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
-
Field Details
-
TYPE
- See Also:
-
VERSION
- See Also:
-
-
Constructor Details
-
ChannelUpdate
public ChannelUpdate()Only used by EventSub for handler registration -
ChannelUpdate
Used byonEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent)
to construct an object from an incoming notification- Parameters:
e
- The event
-
ChannelUpdate
Constructor- Parameters:
broadcaster_user_id
- The user id of the broadcaster
-
-
Method Details
-
proposeSubscription
Description copied from class:EventSubSubscriptionType
Compiles the parameters of this object into anEventSubSubscription
that can be created- Specified by:
proposeSubscription
in classEventSubSubscriptionType
- Returns:
-
validateParameters
Description copied from class:EventSubSubscriptionType
Validates that the provided parameters are acceptable for use inEventSubSubscriptionType.proposeSubscription()
- Specified by:
validateParameters
in classEventSubSubscriptionType
- Throws:
IllegalArgumentException
- One of the parameters is not acceptable
-
onEventSubInternalNotificationEvent
- Overrides:
onEventSubInternalNotificationEvent
in classEventSubSubscriptionType
-
isMatch
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 classEventSubSubscriptionType
- Returns:
-
broadcasterUserId
The broadcaster's user ID.- Returns:
-
broadcasterUserLogin
The broadcaster's user login.- Returns:
-
broadcasterUserName
The broadcaster's user display name.- Returns:
-
title
The channel's stream title.- Returns:
-
language
The channel's broadcast language.- Returns:
-
categoryId
The channel's category ID.- Returns:
-
categoryName
The category name.- Returns:
-
isMature
public boolean isMature()A boolean identifying whether the channel is flagged as mature.- Returns:
-