twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedConnecting to ChatListening to events

Upgrading

Upgrading to 2.xUpgrading to 3.xUpgrading to 4.x

Examples

Basic botPreventing sub gift spam

Classes

ChatClientChatUserTwitchPrivateMessageUserNotice

Interfaces

BaseChatClientOptionsChatBitsBadgeUpgradeInfoChatCommunityPayForwardInfoChatCommunitySubInfoChatPrimeCommunityGiftInfoChatRaidInfoChatRewardGiftInfoChatRitualInfoChatSayMessageAttributesChatStandardPayForwardInfoChatSubExtendInfoChatSubGiftInfoChatSubGiftUpgradeInfoChatSubInfoChatSubUpgradeInfoParsedMessageCheerPartParsedMessageEmotePartParsedMessageTextPartTcpChatClientOptionsWebSocketChatClientOptions

ChatStandardPayForwardInfo

Information about a "forward payment" to a specific user.

{
The display name of the forwarding user.
displayName: string
The display name of the original gifter.
The user ID of the original gifter.
The display name of the user receiving the new gift.
The user ID of the user receiving the new gift.
recipientUserId: string
The user ID of the forwarding user.
userId: string
}

Properties

displayName

Type: string

The display name of the forwarding user.

originalGifterDisplayName

Type: ?string

The display name of the original gifter.

May be empty if the original gift was anonymous.

originalGifterUserId

Type: ?string

The user ID of the original gifter.

May be empty if the original gift was anonymous.

recipientDisplayName

Type: string

The display name of the user receiving the new gift.

recipientUserId

Type: string

The user ID of the user receiving the new gift.

userId

Type: string

The user ID of the forwarding user.