TwurpleAuthenticationGetting dataExamplesFAQMigration

CommunitySubEvent

An event representing a user gifting subscriptions to the community of a channel.

Overview

Properties

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

count

Type: number

The number of subscriptions that were gifted.

gifterDisplayName

Type: string | null

The display name of the user who sent the gift.

gifterId

Type: string | null

The ID of the user who sent the gift.

gifterName

Type: string | null

The name of the user who sent the gift.

messageObject

Type: UserNotice

The full object that contains all the message information.

plan

Type: string

The plan of the gifted subscription.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getGifter()

async

Gets more information about the user who sent the gift.

Return type: HelixUser | null