Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubGiftEvent

Emitted when a viewer offers one or more subscriptions.

If a viewer offers 10 subscriptions at once, there will be 1 sub-gift event and 10 sub-gift-received events.

Hierarchy

  • SubGiftEvent

Index

Properties

Properties

number

number: number

tier

tier: "1000" | "2000" | "3000"

Prime subs are considered a tier "1000".

Optional total

total?: number

The cumulative number of gifts from this user.

Can be undefined if not shared.

type

type: "sub-gift"

Optional viewerId

viewerId?: string

Can be undefined if it is an anonymous gift.

Optional viewerName

viewerName?: string

Can be undefined if it is an anonymous gift.

Generated using TypeDoc