Package com.github.twitch4j.helix.webhooks.topics

Class ChannelSubscriptionTopic

java.lang.Object

com.github.twitch4j.helix.webhooks.topics.TwitchWebhookTopic<SubscriptionEventList>

com.github.twitch4j.helix.webhooks.topics.ChannelSubscriptionTopic

public class ChannelSubscriptionTopic
extends TwitchWebhookTopic<SubscriptionEventList>

This webhook notifies you when:

• A payment has been processed for a subscription or unsubscription.
• A user who is subscribed to a broadcaster notifies the broadcaster of their subscription in the chat.

Nested Class Summary

Nested classes/interfaces inherited from class com.github.twitch4j.helix.webhooks.topics.TwitchWebhookTopic

TwitchWebhookTopic.UnknownTopic

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Constructor Summary

Constructors

Constructor	Description
ChannelSubscriptionTopic(@NonNull String broadcasterId, String userId)	Deprecated. Will be decommissioned after 2021-09-16 in favor of EventSub
ChannelSubscriptionTopic(@NonNull String broadcasterId, String userId, String gifterId, String gifterName)	Deprecated. Will be decommissioned after 2021-09-16 in favor of EventSub

Method Summary

Modifier and Type	Method	Description
String	getBroadcasterId()
Optional<String>	getGifterId()
Optional<String>	getGifterName()
Optional<String>	getUserId()

Methods inherited from class com.github.twitch4j.helix.webhooks.topics.TwitchWebhookTopic

canEqual, equals, fromUrl, getType, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

Constructor Details

ChannelSubscriptionTopic

@Deprecated
public ChannelSubscriptionTopic(@NonNull
 @NonNull String broadcasterId,
 String userId)

Deprecated.

Will be decommissioned after 2021-09-16 in favor of EventSub

This webhook notifies you when:

• A payment has been processed for a subscription or unsubscription.
• A user who is subscribed to a broadcaster notifies the broadcaster of their subscription in the chat.

Parameters:

broadcasterId - Required. User ID of the broadcaster. Must match the User ID in the Bearer token.

userId - Optional. ID of the subscribed user. Currently only one user_id at a time can be queried.

ChannelSubscriptionTopic

@Deprecated
public ChannelSubscriptionTopic(@NonNull
 @NonNull String broadcasterId,
 String userId,
 String gifterId,
 String gifterName)

Deprecated.

Will be decommissioned after 2021-09-16 in favor of EventSub

This webhook notifies you when:

• A payment has been processed for a subscription or unsubscription.
• A user who is subscribed to a broadcaster notifies the broadcaster of their subscription in the chat.

Parameters:

broadcasterId - Required. User ID of the broadcaster. Must match the User ID in the Bearer token.

userId - Optional. ID of the subscribed user.

gifterId - Optional. ID of the user who gifted the sub. Returns an empty string for non-gifts, "274598607" for anonymous gifts

gifterName - Optional. Display name of the user who gifted the sub. Returns an empty string for non-gifts, "AnAnonymousGifter" for anonymous gifts

Method Details

getBroadcasterId

public String getBroadcasterId()

Returns:

The user ID of the broadcaster.

getUserId

public Optional<String> getUserId()

Returns:

The ID of the subscribed user.

getGifterId

public Optional<String> getGifterId()

Returns:

ID of the user who gifted the sub.

getGifterName

public Optional<String> getGifterName()

Returns:

Display name of the user who gifted the sub.