Class StreamOnline
java.lang.Object
com.gmt2001.twitch.eventsub.EventSubSubscriptionType
com.gmt2001.twitch.eventsub.subscriptions.stream.StreamOnline
- All Implemented Interfaces:
Flow.Subscriber<EventSubInternalEvent>
The specified broadcaster starts a stream.
- Author:
- gmt2001
-
Nested Class Summary
Nested Classes -
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 notificationStreamOnline(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.id()The id of the stream.protected booleanisMatch(EventSubSubscription subscription) Returns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditionsprotected voidprotected EventSubSubscriptionCompiles the parameters of this object into anEventSubSubscriptionthat can be createdThe timestamp at which the stream went online at.The timestamp at which the stream went online at as a string.type()The stream type.protected voidValidates 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
-
StreamOnline
public StreamOnline()Only used by EventSub for handler registration -
StreamOnline
Used byonEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent)to construct an object from an incoming notification- Parameters:
e- The event
-
StreamOnline
Constructor- Parameters:
broadcaster_user_id- The user id of the broadcaster
-
-
Method Details
-
proposeSubscription
Description copied from class:EventSubSubscriptionTypeCompiles the parameters of this object into anEventSubSubscriptionthat can be created- Specified by:
proposeSubscriptionin classEventSubSubscriptionType- Returns:
-
validateParameters
Description copied from class:EventSubSubscriptionTypeValidates that the provided parameters are acceptable for use inEventSubSubscriptionType.proposeSubscription()- Specified by:
validateParametersin classEventSubSubscriptionType- Throws:
IllegalArgumentException- One of the parameters is not acceptable
-
onEventSubInternalNotificationEvent
- Overrides:
onEventSubInternalNotificationEventin classEventSubSubscriptionType
-
isMatch
Description copied from class:EventSubSubscriptionTypeReturns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditions- Specified by:
isMatchin classEventSubSubscriptionType- Returns:
-
broadcasterUserId
The broadcaster's user ID.- Returns:
-
broadcasterUserLogin
The broadcaster's user login.- Returns:
-
broadcasterUserName
The broadcaster's user display name.- Returns:
-
id
The id of the stream.- Returns:
-
type
The stream type.- Returns:
-
startedAtString
The timestamp at which the stream went online at as a string.- Returns:
-
startedAt
The timestamp at which the stream went online at.- Returns:
-