Package com.github.twitch4j.eventsub

Class EventSubSubscription

java.lang.Object

com.github.twitch4j.eventsub.EventSubSubscription

public class EventSubSubscription
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventSubSubscription.EventSubSubscriptionBuilder

Constructor Summary

Constructors

Constructor	Description
EventSubSubscription()
EventSubSubscription(String id, EventSubSubscriptionStatus status, SubscriptionType<?,?,?> type, EventSubCondition condition, Instant createdAt, EventSubTransport transport, Integer cost, Boolean isBatchingEnabled, String rawType, String rawVersion)	Creates a new EventSubSubscription instance.
EventSubSubscription(String id, EventSubSubscriptionStatus status, String type, String version, Map<String,Object> condition, Instant createdAt, EventSubTransport transport, Integer cost, Boolean isBatchingEnabled)

Method Summary

Modifier and Type	Method	Description
static EventSubSubscription.EventSubSubscriptionBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
EventSubCondition	getCondition()	Object specifying custom parameters for the subscription.
Integer	getCost()	How much the subscription counts against your limit.
Instant	getCreatedAt()	Timestamp indicating when the subscription was created.
String	getId()	ID of the subscription.
String	getRawType()	The category of the subscription.
String	getRawVersion()	The version of the subscription.
EventSubSubscriptionStatus	getStatus()	Status of the subscription.
EventSubTransport	getTransport()	Object indicating the notification delivery specific information.
SubscriptionType<?,?,?>	getType()	The category and version of the subscription.
int	hashCode()
Boolean	isBatchingEnabled()	Whether events fired for this type are batched by Twitch.
void	setStatus(EventSubSubscriptionStatus status)	Deprecated.
void	setTransport(EventSubTransport transport)	Deprecated.
EventSubSubscription.EventSubSubscriptionBuilder	toBuilder()
String	toString()
EventSubSubscription	withTransport(EventSubTransport transport)	Object indicating the notification delivery specific information.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EventSubSubscription

public EventSubSubscription(String id,
 EventSubSubscriptionStatus status,
 String type,
 String version,
 Map<String,Object> condition,
 Instant createdAt,
 EventSubTransport transport,
 Integer cost,
 Boolean isBatchingEnabled)

EventSubSubscription

public EventSubSubscription()

EventSubSubscription

public EventSubSubscription(String id,
 EventSubSubscriptionStatus status,
 SubscriptionType<?,?,?> type,
 EventSubCondition condition,
 Instant createdAt,
 EventSubTransport transport,
 Integer cost,
 Boolean isBatchingEnabled,
 String rawType,
 String rawVersion)

Creates a new EventSubSubscription instance.

Parameters:

id - ID of the subscription.

status - Status of the subscription.

type - The category and version of the subscription.

condition - Object specifying custom parameters for the subscription.

createdAt - Timestamp indicating when the subscription was created.

transport - Object indicating the notification delivery specific information.

cost - How much the subscription counts against your limit. Subscriptions cost 0 if the user has authorized your application; otherwise they cost 1.

isBatchingEnabled - Whether events fired for this type are batched by Twitch.

rawType - The category of the subscription.

rawVersion - The version of the subscription.

See Also:

• Limit Docs

Method Details

builder

public static EventSubSubscription.EventSubSubscriptionBuilder builder()

toBuilder

public EventSubSubscription.EventSubSubscriptionBuilder toBuilder()

getId

public String getId()

ID of the subscription.

getStatus

public EventSubSubscriptionStatus getStatus()

Status of the subscription.

getCondition

public EventSubCondition getCondition()

Object specifying custom parameters for the subscription.

getCreatedAt

public Instant getCreatedAt()

Timestamp indicating when the subscription was created.

getTransport

public EventSubTransport getTransport()

Object indicating the notification delivery specific information.

getCost

public Integer getCost()

How much the subscription counts against your limit. Subscriptions cost 0 if the user has authorized your application; otherwise they cost 1.

See Also:

• Limit Docs

isBatchingEnabled

public Boolean isBatchingEnabled()

Whether events fired for this type are batched by Twitch.

getRawType

public String getRawType()

The category of the subscription.

getRawVersion

public String getRawVersion()

The version of the subscription.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setStatus

@Deprecated
@Internal
public void setStatus(EventSubSubscriptionStatus status)

Deprecated.

Status of the subscription.

getType

public SubscriptionType<?,?,?> getType()

The category and version of the subscription.

withTransport

public EventSubSubscription withTransport(EventSubTransport transport)

Object indicating the notification delivery specific information.

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

setTransport

@Deprecated
@Internal
public void setTransport(EventSubTransport transport)

Deprecated.

Object indicating the notification delivery specific information.