TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Main classes

ApiClient

Helix APIs

BitsChannelsChannel pointsCharity CampaignsChatClipsContent classification labelsEntitlements (Drops)EventSubExtensionsGamesHype TrainsModerationPollsPredictionsRaidsScheduleSearchStreamsSubscriptionsTeamsUsersVideosWhispers

Classes

ApiReportedRequestConfigErrorHelixAdScheduleHelixBanHelixBanUserHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixBlockedTermHelixChannelHelixChannelEditorHelixChannelEmoteHelixChannelFollowerHelixChannelReferenceHelixChannelSearchResultHelixCharityCampaignHelixCharityCampaignAmountHelixCharityCampaignDonationHelixChatBadgeSetHelixChatBadgeVersionHelixChatChatterHelixChatSettingsHelixCheermoteListHelixClipHelixContentClassificationLabelHelixCustomRewardHelixCustomRewardRedemptionHelixDropsEntitlementHelixEmoteHelixEmoteFromSetHelixEventSubConduitHelixEventSubConduitShardHelixEventSubSubscriptionHelixExtensionBitsProductHelixExtensionTransactionHelixFollowHelixFollowedChannelHelixGameHelixGoalHelixGoalApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModeratedChannelHelixModeratorHelixPaginatedEventSubSubscriptionsRequestHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPaginatedSubscriptionsRequestHelixPollHelixPollChoiceHelixPredictionHelixPredictionOutcomeHelixPredictorHelixPrivilegedChatSettingsHelixPrivilegedUserHelixRaidHelixScheduleHelixScheduleSegmentHelixSentChatMessageHelixShieldModeStatusHelixStreamHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixTeamHelixTeamWithUsersHelixUserHelixUserBlockHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoStreamNotLiveError

Interfaces

ApiConfigHelixBanFilterHelixBanUserRequestHelixBitsLeaderboardQueryHelixChannelSearchFilterHelixChannelUpdateHelixClipCreateParamsHelixClipFilterHelixCreateCustomRewardDataHelixCreatePollDataHelixCreatePredictionDataHelixCreateScheduleSegmentDataHelixCustomRewardRedemptionFilterHelixDropsEntitlementFilterHelixDropsEntitlementPaginatedFilterHelixEventSubConduitShardsOptionsHelixEventSubConduitTransportOptionsHelixEventSubDropEntitlementGrantFilterHelixEventSubWebHookTransportOptionsHelixEventSubWebSocketTransportOptionsHelixExtensionBitsProductUpdatePayloadHelixExtensionTransactionsFilterHelixExtensionTransactionsPaginatedFilterHelixForwardPaginationHelixModeratorFilterHelixPaginatedChannelSearchFilterHelixPaginatedClipFilterHelixPaginatedCustomRewardRedemptionFilterHelixPaginatedEventSubSubscriptionsResultHelixPaginatedResultHelixPaginatedResultWithTotalHelixPaginatedScheduleFilterHelixPaginatedStreamFilterHelixPaginatedSubscriptionsResultHelixPaginatedVideoFilterHelixPaginationHelixScheduleFilterHelixScheduleSettingsUpdateHelixSendChatAnnouncementParamsHelixSendChatMessageParamsHelixStreamFilterHelixUpdateChatSettingsParamsHelixUpdateCustomRewardDataHelixUpdateScheduleSegmentDataHelixUserBlockAdditionalInfoHelixUserExtensionUpdatePayloadHelixUserExtensionUpdatePayloadActiveSlotHelixUserExtensionUpdatePayloadInactiveSlotHelixUserUpdateHelixVideoFilter

Type aliases

HelixBitsLeaderboardPeriodHelixBroadcasterTypeHelixChannelEmoteSubscriptionTierHelixChatAnnouncementColorHelixChatBadgeScaleHelixChatUserColorHelixCustomRewardRedemptionStatusHelixCustomRewardRedemptionTargetStatusHelixDropsEntitlementFulfillmentStatusHelixDropsEntitlementUpdateStatusHelixEventSubConduitShardsTransportOptionsHelixEventSubSubscriptionStatusHelixEventSubTransportOptionsHelixExtensionSlotTypeHelixGoalTypeHelixHypeTrainContributionTypeHelixHypeTrainEventTypeHelixPollStatusHelixPredictionOutcomeColorHelixPredictionStatusHelixStreamTypeHelixUserExtensionUpdatePayloadSlotHelixVideoType

HelixEmoteFromSet

A Twitch Channel emote.

Overview

Properties

Methods

Constructor

new HelixEmoteFromSet(data, client)

ParameterTypeRequiredDefaultDescription
dataHelixEmoteFromSetDatanonenone
clientBaseApiClientnonenone

Properties

emoteSetId

Type: string

The ID of the emote set the emote is part of.

formats

Type: HelixEmoteFormat[]

The formats that the emote is available in.

id

Type: string

The ID of the emote.

name

Type: string

The name of the emote.

ownerId

Type: string | null

The ID of the user that owns the emote, or null if the emote is not owned by a user.

scales

Type: HelixEmoteScale[]

The scales that the emote is available in.

themeModes

Type: HelixEmoteThemeMode[]

The theme modes that the emote is available in.

type

Type: string

The type of the emote.

Known values are: subscriptions, bitstier, follower, rewards, globals, smilies, prime, limitedtime.

This list may be non-exhaustive.

Methods

getAnimatedImageUrl(scale, themeMode)

Gets the URL of the emote image in animated format at the given scale and theme mode, or null if an animated emote image at that scale/theme mode doesn't exist.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteScale'1.0'

The scale of the image.

themeModeHelixEmoteThemeMode'light'

The theme mode of the image, either light or dark.

Return type: string | null

getFormattedImageUrl(scale, format, themeMode)

Gets the URL of the emote image in the given scale, format, and theme mode.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteScale'1.0'

The scale of the image, either 1.0 (small), 2.0 (medium), or 3.0 (large).

formatHelixEmoteFormat'static'

The format of the image, either static or animated.

themeModeHelixEmoteThemeMode'light'

The theme mode of the image, either light or dark.

Return type: string

getImageUrl(scale)

Gets the URL of the emote image in the given scale.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteImageScalenone

The scale of the image.

Return type: string

getOwner()

async

Gets more information about the user that owns the emote, or null if the emote is not owned by a user.

Return type: HelixUser | null

getStaticImageUrl(scale, themeMode)

Gets the URL of the emote image in static format at the given scale and theme mode, or null if a static emote image at that scale/theme mode doesn't exist.

ParameterTypeRequiredDefaultDescription
scaleHelixEmoteScale'1.0'

The scale of the image.

themeModeHelixEmoteThemeMode'light'

The theme mode of the image, either light or dark.

Return type: string | null