TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

Classes

ApiReportedRequestConfigErrorHelixAdScheduleHelixBanHelixBanUserHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixBlockedTermHelixChannelHelixChannelEditorHelixChannelEmoteHelixChannelFollowerHelixChannelReferenceHelixChannelSearchResultHelixCharityCampaignHelixCharityCampaignAmountHelixCharityCampaignDonationHelixChatBadgeSetHelixChatBadgeVersionHelixChatChatterHelixChatSettingsHelixCheermoteListHelixClipHelixContentClassificationLabelHelixCustomRewardHelixCustomRewardRedemptionHelixDropsEntitlementHelixEmoteHelixEmoteFromSetHelixEventSubConduitHelixEventSubConduitShardHelixEventSubSubscriptionHelixExtensionBitsProductHelixExtensionTransactionHelixFollowHelixFollowedChannelHelixGameHelixGoalHelixGoalApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModeratedChannelHelixModeratorHelixPaginatedEventSubSubscriptionsRequestHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPaginatedSubscriptionsRequestHelixPollHelixPollChoiceHelixPredictionHelixPredictionOutcomeHelixPredictorHelixPrivilegedChatSettingsHelixPrivilegedUserHelixRaidHelixScheduleHelixScheduleSegmentHelixSentChatMessageHelixSharedChatSessionHelixSharedChatSessionParticipantHelixShieldModeStatusHelixStreamHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixTeamHelixTeamWithUsersHelixUnbanRequestHelixUserHelixUserBlockHelixUserEmoteHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoHelixWarningStreamNotLiveError

HelixUserEmote

A Twitch user emote.

Overview

Constructor

new HelixUserEmote(data, client)

ParameterTypeRequiredDefaultDescription
dataHelixUserEmoteDatanonenone
clientBaseApiClientnonenone

Properties

emoteSetId

Type: string | null

The ID that identifies the emote set that the emote belongs to, or null if the emote is not from any set.

ownerId

Type: string | null

The ID of the broadcaster who owns the emote, or null if the emote has no owner, e.g. it's a global emote.

type

Type: string

The type of the emote.

There are many types of emotes that Twitch seems to arbitrarily assign. Check the relevant values in the official documentation.

Methods

getAllEmotesFromSet()

async

Gets all emotes from the emotes set, or null if emote is not from any set.

Return type: HelixEmoteFromSet[] | null

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