Package com.github.twitch4j.eventsub

Class EventSubTransport.EventSubTransportBuilder

java.lang.Object

com.github.twitch4j.eventsub.EventSubTransport.EventSubTransportBuilder

Enclosing class:

EventSubTransport

public static class EventSubTransport.EventSubTransportBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
EventSubTransport	build()
EventSubTransport.EventSubTransportBuilder	callback(@Nullable String callback)	The callback URL where the notification should be sent.
EventSubTransport.EventSubTransportBuilder	conduitId(@Nullable String conduitId)	An ID that identifies the conduit to send notifications to.
EventSubTransport.EventSubTransportBuilder	connectedAt(@Nullable Instant connectedAt)	The UTC date and time that the WebSocket connection was established.
EventSubTransport.EventSubTransportBuilder	disconnectedAt(@Nullable Instant disconnectedAt)	The UTC date and time that the WebSocket connection was lost.
EventSubTransport.EventSubTransportBuilder	method(@NotNull EventSubTransportMethod method)	The transport method.
EventSubTransport.EventSubTransportBuilder	secret(@Nullable String secret)	The secret used for verifying a webhook signature.
EventSubTransport.EventSubTransportBuilder	sessionId(@Nullable String sessionId)	An ID that identifies the WebSocket that notifications are sent to.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

method

public EventSubTransport.EventSubTransportBuilder method(@NotNull
 @NotNull EventSubTransportMethod method)

The transport method.

Returns:

this.

callback

public EventSubTransport.EventSubTransportBuilder callback(@Nullable
 @Nullable String callback)

The callback URL where the notification should be sent.

Specify this field only if method is set to webhook.

Returns:

this.

secret

public EventSubTransport.EventSubTransportBuilder secret(@Nullable
 @Nullable String secret)

The secret used for verifying a webhook signature.

The secret must be an ASCII string that’s a minimum of 10 characters long and a maximum of 100 characters long.

Specify this field only if method is set to webhook.

Returns:

this.

conduitId

public EventSubTransport.EventSubTransportBuilder conduitId(@Nullable
 @Nullable String conduitId)

An ID that identifies the conduit to send notifications to.

When you create a conduit, the server returns the conduit ID.

Specify this field only if method is set to conduit.

Returns:

this.

sessionId

public EventSubTransport.EventSubTransportBuilder sessionId(@Nullable
 @Nullable String sessionId)

An ID that identifies the WebSocket that notifications are sent to.

Specify this field only if method is set to websocket.

Returns:

this.

connectedAt

public EventSubTransport.EventSubTransportBuilder connectedAt(@Nullable
 @Nullable Instant connectedAt)

The UTC date and time that the WebSocket connection was established.

Included only if method is set to websocket.

Returns:

this.

disconnectedAt

public EventSubTransport.EventSubTransportBuilder disconnectedAt(@Nullable
 @Nullable Instant disconnectedAt)

The UTC date and time that the WebSocket connection was lost.

Included only if method is set to websocket.

Returns:

this.

build

public EventSubTransport build()

toString

public String toString()

Overrides:

toString in class Object