Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- advancedConfiguration(UnaryOperator<TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder<?, ?>>) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
Further configuration that should be applied to the builder when creating new EventSocket (single-user) pools.
- api(TwitchHelix) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- appAccessToken() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The app access token for helix requests.
- appAccessToken(OAuth2Credential) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The app access token for helix requests.
- avoidRetryFailedSubscription(Boolean) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
B
- backoffStrategy(IBackoffStrategy) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- baseUrl(String) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The base url for websocket connections.
- baseUrl(String) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- baseUrl(String) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
-
The base url for websocket connections.
- build() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- build() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
- build() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
- builder() - Static method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- builder() - Static method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- builder() - Static method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
C
- canEqual(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
- canEqual(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
- canEqual(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
- canEqual(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
- CLIENT_FAILED_PING_PONG - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
You must respond to ping messages with a pong message.
- CLIENT_SENT_INBOUND_TRAFFIC - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
Sending outgoing messages to the server is prohibited with the exception of pong messages.
- clientId() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
Your application's client ID.
- clientId(String) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
Your application's client ID.
- clientId(String) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- clientSecret() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
Your application's client secret.
- clientSecret(String) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
Your application's client secret.
- clientSecret(String) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- close() - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- close() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- close() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- com.github.twitch4j.eventsub.socket - package com.github.twitch4j.eventsub.socket
- com.github.twitch4j.eventsub.socket.conduit - package com.github.twitch4j.eventsub.socket.conduit
- com.github.twitch4j.eventsub.socket.conduit.exceptions - package com.github.twitch4j.eventsub.socket.conduit.exceptions
- com.github.twitch4j.eventsub.socket.domain - package com.github.twitch4j.eventsub.socket.domain
- com.github.twitch4j.eventsub.socket.enums - package com.github.twitch4j.eventsub.socket.enums
- com.github.twitch4j.eventsub.socket.events - package com.github.twitch4j.eventsub.socket.events
- conduitId() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The ID of an already created Conduit (optional); otherwise
TwitchConduitSocketPoolwill create a new Conduit. - conduitId(String) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The ID of an already created Conduit (optional); otherwise
TwitchConduitSocketPoolwill create a new Conduit. - ConduitNotFoundException - Exception in com.github.twitch4j.eventsub.socket.conduit.exceptions
- ConduitNotFoundException(String, Exception) - Constructor for exception com.github.twitch4j.eventsub.socket.conduit.exceptions.ConduitNotFoundException
- ConduitResizeException - Exception in com.github.twitch4j.eventsub.socket.conduit.exceptions
- ConduitResizeException(String, Exception) - Constructor for exception com.github.twitch4j.eventsub.socket.conduit.exceptions.ConduitResizeException
- ConduitShardReassociationFailureEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Fired when a websocket shard unexpected disconnected and could not be re-associated with the conduit after reconnecting.
- ConduitShardReassociationFailureEvent(TwitchEventSocket, TwitchConduitSocketPool, String, Exception) - Constructor for class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
-
Creates a new
ConduitShardReassociationFailureEventinstance. - ConduitSocketPoolException - Interface in com.github.twitch4j.eventsub.socket.conduit.exceptions
- ConduitSpec - Class in com.github.twitch4j.eventsub.socket.conduit
- connect() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Establishes a connection to the EventSub WebSocket server.
- connect() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
Connecting to EventSub-WS
- connect() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- connect() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- CONNECTED - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.EventSubSocketStatus
- connection(WebsocketConnection) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- CONNECTION_UNUSED - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
When you connect to the server, you must create a subscription within 10 seconds or the connection is closed.
- create(Consumer<ConduitSpec>) - Static method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
-
Creates a managed websocket pool to serve as shards for an EventSub Conduit.
- CreateConduitException - Exception in com.github.twitch4j.eventsub.socket.conduit.exceptions
- CreateConduitException(Exception) - Constructor for exception com.github.twitch4j.eventsub.socket.conduit.exceptions.CreateConduitException
- createConnection() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
D
- defaultToken(OAuth2Credential) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- defaultToken(OAuth2Credential) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
-
The default credential (representing the single user) to create eventsub subscriptions with.
- disconnect() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Disconnects from the WebSocket server.
- disconnect() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
Disconnecting from EventSub-WS
- disconnect() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- disconnect() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- DISCONNECTED - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.EventSubSocketStatus
- disposeConnection(TwitchEventSocket) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
E
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketClosedByTwitchEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionSuccessEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionSuccessEvent
- equals(Object) - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
- eventManager() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An optional
EventManager(if one is already created). - eventManager(EventManager) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An optional
EventManager(if one is already created). - eventManager(EventManager) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- eventManager(EventManager) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The default
EventManagerfor this connection pool, if specified. - EventSocketClosedByTwitchEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Called when Twitch decides to close our EventSocket.
- EventSocketClosedByTwitchEvent(SocketCloseReason, TwitchEventSocket) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketClosedByTwitchEvent
-
Creates a new
EventSocketClosedByTwitchEventinstance. - EventSocketConnectionStateEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Called when the connection state of an EventSocket changes.
- EventSocketConnectionStateEvent(WebsocketConnectionState, WebsocketConnectionState, TwitchEventSocket) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
-
Creates a new
EventSocketConnectionStateEventinstance. - EventSocketDeleteSubscriptionFailureEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Called when an EventSocket fails to delete a subscription via the Helix API.
- EventSocketDeleteSubscriptionFailureEvent(EventSubSubscription, TwitchEventSocket, Throwable) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
-
Creates a new
EventSocketDeleteSubscriptionFailureEventinstance. - EventSocketDeleteSubscriptionSuccessEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Called when an EventSocket successfully deletes a subscription via the Helix API.
- EventSocketDeleteSubscriptionSuccessEvent(EventSubSubscription, TwitchEventSocket) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionSuccessEvent
-
Creates a new
EventSocketDeleteSubscriptionSuccessEventinstance. - EventSocketSubscriptionFailureEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Called when an EventSocket fails to register subscription with the Helix API.
- EventSocketSubscriptionFailureEvent(EventSubSubscription, TwitchEventSocket, Throwable, boolean) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
-
Creates a new
EventSocketSubscriptionFailureEventinstance. - EventSocketSubscriptionSuccessEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Called when an EventSocket successfully registers a subscription with the Helix API.
- EventSocketSubscriptionSuccessEvent(EventSubSubscription, TwitchEventSocket) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionSuccessEvent
-
Creates a new
EventSocketSubscriptionSuccessEventinstance. - EventSocketWelcomedEvent - Class in com.github.twitch4j.eventsub.socket.events
-
Fired when a
TwitchEventSocketreceives aSocketMessageType.SESSION_WELCOMEmessage. - EventSocketWelcomedEvent(TwitchEventSocket, String, boolean) - Constructor for class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
-
Creates a new
EventSocketWelcomedEventinstance. - EventSubSocketInformation - Class in com.github.twitch4j.eventsub.socket.domain
- EventSubSocketInformation() - Constructor for class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
- EventSubSocketMessage - Class in com.github.twitch4j.eventsub.socket.domain
- EventSubSocketMessage() - Constructor for class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
- EventSubSocketStatus - Enum Class in com.github.twitch4j.eventsub.socket.enums
- executor() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An optional
ScheduledThreadPoolExecutor. - executor(ScheduledThreadPoolExecutor) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An optional
ScheduledThreadPoolExecutor. - executor(ScheduledThreadPoolExecutor) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The
ScheduledThreadPoolExecutorto be used by connections in this pool, if specified.
F
- fallbackToken(OAuth2Credential) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The default
OAuth2Credentialto use when initially creating an EventSub subscription.
G
- getCode() - Method in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
- getConduitId() - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- getConduitId() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubConduit
- getConnectedAt() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
-
The UTC date and time that the connection was created.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketClosedByTwitchEvent
-
The EventSocket instance whose connection status changed.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
-
The EventSocket instance whose connection status changed.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
-
The EventSocket attempting to delete the subscription.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionSuccessEvent
-
The EventSocket connection associated with the subscription.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
-
The EventSocket attempting to create the subscription.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionSuccessEvent
-
The EventSocket connection associated with the subscription.
- getConnection() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
-
The EventSocket instance whose connection status changed.
- getDefaultToken() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
- getDefaultToken() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
Default Helix Token
- getDefaultToken() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- getDefaultToken() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
-
The default credential (representing the single user) to create eventsub subscriptions with.
- getError() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
-
The exception associated with the deletion failure.
- getError() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
-
The exception associated with the subscription failure.
- getEventData() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
-
The event’s data.
- getEventManager() - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- getEventManager() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubConduit
- getEventManager() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
- getEventManager() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
EventManager
- getEventManager() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
-
The default
EventManagerfor this connection pool, if specified. - getException() - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
-
The exception thrown by
TwitchHelix.updateConduitShards(String, ShardsInput)when trying to re-associate the websocket as a conduit shard for the given ID. - getId() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
-
An ID that uniquely identifies this WebSocket connection.
- getKeepaliveTimeoutSeconds() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
-
The maximum number of seconds that you should expect silence before receiving a keepalive message.
- getLatency() - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- getLatency() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubConduit
- getLatency() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
- getLatency() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- getLatency() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- getLatency() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- getManagedShardCount() - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- getMessageId() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
-
An ID that uniquely identifies the message.
- getMessageTimestamp() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
-
The UTC date and time that the message was sent.
- getMessageType() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
-
The type of message.
- getMetadata() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
-
An object that identifies the message.
- getParsedEvent() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
- getParsedSubscriptionType() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
- getPayload() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
-
An object that contains the message.
- getPool() - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
-
The Conduit pool containing the disconnected conduit shard.
- getPreviousState() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
-
The previous state of the websocket.
- getReason() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketClosedByTwitchEvent
-
The reported reason for why Twitch closed the EventSocket connection.
- getReconnectUrl() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
-
The URL to reconnect to if you get a
SocketMessageType.SESSION_RECONNECTmessage. - getRequestFromSubscription(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- getSession() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
-
An object that contains information about the connection.
- getSessionId() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
-
The ID that was assigned to the websocket upon connect.
- getShardId() - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
-
The ID of the shard that disconnected.
- getShardOffset() - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- getSocket() - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
-
The websocket that reconnected after an unexpected connection loss, but could not be re-associated as a conduit shard.
- getState() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
-
The updated state of the websocket.
- getState() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- getStatus() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
-
The connection’s status.
- getSubscription() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
-
An object that contains information about your subscription.
- getSubscription() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
-
The subscription that was attempted to be deleted.
- getSubscription() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionSuccessEvent
-
The eventsub subscription that was successfully deleted.
- getSubscription() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
-
The subscription that was attempted to be created.
- getSubscription() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionSuccessEvent
-
The eventsub subscription that was successfully created.
- getSubscriptions() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
- getSubscriptions() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- getSubscriptions() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- getSubscriptions() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- getSubscriptionSize(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- getSubscriptionType() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
-
The type of event sent in the message.
- getSubscriptionVersion() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
-
The version number of the subscription type’s definition.
- getWebsocketId() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
The Twitch-assigned id associated with this websocket, which is used when creating eventsub subscriptions via the API.
H
- handleDuplicateSubscription(TwitchEventSocket, TwitchEventSocket, EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- handleSubscription(TwitchEventSocket, EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- handleUnsubscription(TwitchEventSocket, EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketClosedByTwitchEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionSuccessEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionSuccessEvent
- hashCode() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
- helix() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An optional
TwitchHelixinstance (if one is already created). - helix(TwitchHelix) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An optional
TwitchHelixinstance (if one is already created). - helix(TwitchHelix) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The
TwitchHelixinstance for creating eventsub subscriptions in the official API. - helix(TwitchHelix) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
-
The
TwitchHelixinstance for creating eventsub subscriptions in the official API.
I
- identityProvider(TwitchIdentityProvider) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The
TwitchIdentityProviderto enrich credentials. - IEventSubConduit - Interface in com.github.twitch4j.eventsub.socket
- IEventSubSocket - Interface in com.github.twitch4j.eventsub.socket
- INTERNAL_SERVER_ERROR - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
Indicates a problem with the server (similar to an HTTP 500 status code).
- INVALID_RECONNECT - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
The reconnect URL is invalid.
- isSessionChanged() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
-
Whether the Session ID changed due to the session_welcome handshake.
M
- MAPPINGS - Static variable in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
- MAX_SUBSCRIPTIONS_PER_SOCKET - Static variable in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
Each WebSocket connection may create a maximum of 300 enabled subscriptions (disabled subscriptions don't count against the limit).
- maxSubscriptionsPerUser(int) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
-
The maximum number of eventsub subscriptions that a single user_id can have.
N
- NETWORK_ERROR - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
Transient network error.
- NETWORK_TIMEOUT - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
Transient network timeout.
- NOTIFICATION - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
- numConnections() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- numSubscriptions() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
P
- poolShards() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The number of websockets that should be created by the
TwitchConduitSocketPoolinstance. - poolShards(int) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The number of websockets that should be created by the
TwitchConduitSocketPoolinstance. - process(Consumer<ConduitSpec>) - Static method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
- proxyConfig() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
Optional: the proxy to use for helix requests and the websocket connections.
- proxyConfig(ProxyConfig) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
Optional: the proxy to use for helix requests and the websocket connections.
- proxyConfig(ProxyConfig) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
R
- reconnect() - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Reconnects to the WebSocket server.
- reconnect() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
Reconnecting to EventSub-WS
- reconnect() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- reconnect() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- RECONNECT_GRACE_TIME_EXPIRED - Enum constant in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
When you receive a session_reconnect message, you have 30 seconds to reconnect to the server and close the old connection.
- RECONNECTING - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.EventSubSocketStatus
- register(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- register(EventSubSubscription) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubConduit
-
Creates an eventsub subscription for this conduit.
- register(SubscriptionType<C, B, ?>, Function<B, C>) - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- register(SubscriptionType<C, B, ?>, Function<B, C>) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubConduit
-
Creates an eventsub subscription for this conduit.
- register(OAuth2Credential, EventSubSubscription) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Creates (or schedules) an eventsub subscription for this socket.
- register(OAuth2Credential, EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- register(OAuth2Credential, EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- register(OAuth2Credential, EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- register(EventSubSubscription) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Creates (or schedules) an eventsub subscription for this socket, using
IEventSubSocket.getDefaultToken(). - register(SubscriptionType<C, B, E>, C) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Deprecated.
- register(SubscriptionType<C, B, E>, Function<B, C>) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Helper method for
IEventSubSocket.register(EventSubSubscription) - REQUIRED_THREAD_COUNT - Static variable in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- REVOCATION - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
S
- self() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
- SESSION_KEEPALIVE - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
- SESSION_RECONNECT - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
- SESSION_WELCOME - Enum constant in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
- shardOffset() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An integer offset for the Shard IDs to be registered with the Conduit.
- shardOffset(int) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
An integer offset for the Shard IDs to be registered with the Conduit.
- ShardRegistrationException - Exception in com.github.twitch4j.eventsub.socket.conduit.exceptions
- ShardRegistrationException(String, Exception) - Constructor for exception com.github.twitch4j.eventsub.socket.conduit.exceptions.ShardRegistrationException
- ShardTimeoutException - Exception in com.github.twitch4j.eventsub.socket.conduit.exceptions
- ShardTimeoutException(long) - Constructor for exception com.github.twitch4j.eventsub.socket.conduit.exceptions.ShardTimeoutException
- SocketCloseReason - Enum Class in com.github.twitch4j.eventsub.socket.domain
-
The reasons for closing the eventsub websocket connection.
- SocketMessageMetadata - Class in com.github.twitch4j.eventsub.socket.domain
-
An object that identifies the message sent over EventSub Websockets.
- SocketMessageMetadata() - Constructor for class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
- SocketMessageType - Enum Class in com.github.twitch4j.eventsub.socket.enums
- SocketPayload - Class in com.github.twitch4j.eventsub.socket.domain
-
An object that contains the EventSub Websocket message.
- SocketPayload() - Constructor for class com.github.twitch4j.eventsub.socket.domain.SocketPayload
- socketWelcomeTimeout() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The amount of time to wait for the websocket shards to be welcomed by Twitch.
- socketWelcomeTimeout(Duration) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The amount of time to wait for the websocket shards to be welcomed by Twitch.
T
- taskExecutor(ScheduledExecutorService) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- toString() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
- toString() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketInformation
- toString() - Method in class com.github.twitch4j.eventsub.socket.domain.EventSubSocketMessage
- toString() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketMessageMetadata
- toString() - Method in class com.github.twitch4j.eventsub.socket.domain.SocketPayload
- toString() - Method in enum class com.github.twitch4j.eventsub.socket.enums.EventSubSocketStatus
- toString() - Method in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.ConduitShardReassociationFailureEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketClosedByTwitchEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketConnectionStateEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionFailureEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketDeleteSubscriptionSuccessEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionSuccessEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketWelcomedEvent
- toString() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
- toString() - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool.TwitchEventSocketPoolBuilder
- toString() - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
- totalShardCount() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The total number of shards associated with the Conduit ID (optional).
- totalShardCount(Integer) - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
-
The total number of shards associated with the Conduit ID (optional).
- TwitchConduitSocketPool - Class in com.github.twitch4j.eventsub.socket.conduit
-
Facilitates creating EventSub WebSocket shards for a new or existing Conduit.
- TwitchEventSocket - Class in com.github.twitch4j.eventsub.socket
-
A single EventSub websocket for a single user id.
- TwitchEventSocket.TwitchEventSocketBuilder - Class in com.github.twitch4j.eventsub.socket
- TwitchEventSocketPool - Class in com.github.twitch4j.eventsub.socket
-
A pool for EventSub websocket subscriptions across multiple users.
- TwitchEventSocketPool.TwitchEventSocketPoolBuilder - Class in com.github.twitch4j.eventsub.socket
- TwitchSingleUserEventSocketPool - Class in com.github.twitch4j.eventsub.socket
-
A pool for a single user id to subscriptions spread over multiple EventSub websockets.
- TwitchSingleUserEventSocketPool(TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder<?, ?>) - Constructor for class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder<C extends TwitchSingleUserEventSocketPool,
B extends TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder<C, B>> - Class in com.github.twitch4j.eventsub.socket - TwitchSingleUserEventSocketPoolBuilder() - Constructor for class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder
U
- unregister(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.conduit.TwitchConduitSocketPool
- unregister(EventSubSubscription) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubConduit
-
Deletes an eventsub subscription from helix (and this conduit).
- unregister(EventSubSubscription) - Method in interface com.github.twitch4j.eventsub.socket.IEventSubSocket
-
Deletes an eventsub subscription from helix (and this socket).
- unregister(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
- unregister(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocketPool
- unregister(EventSubSubscription) - Method in class com.github.twitch4j.eventsub.socket.TwitchSingleUserEventSocketPool
- url(String) - Method in class com.github.twitch4j.eventsub.socket.TwitchEventSocket.TwitchEventSocketBuilder
V
- validate() - Method in class com.github.twitch4j.eventsub.socket.conduit.ConduitSpec
- valueOf(String) - Static method in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.twitch4j.eventsub.socket.enums.EventSubSocketStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.twitch4j.eventsub.socket.domain.SocketCloseReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.twitch4j.eventsub.socket.enums.EventSubSocketStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.twitch4j.eventsub.socket.enums.SocketMessageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WEB_SOCKET_SERVER - Static variable in class com.github.twitch4j.eventsub.socket.TwitchEventSocket
-
The WebSocket Server
- willRetry() - Method in class com.github.twitch4j.eventsub.socket.events.EventSocketSubscriptionFailureEvent
-
Whether the library will automatically try to create the subscription again (at the next reconnect).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
IEventSubSocket.register(SubscriptionType, Function)