Overview
Constructor
new HelixChannelEmote(data, client)
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| data | HelixChannelEmoteData | none | none | |
| client | BaseApiClient | none | none |
Properties
tier
Type: HelixChannelEmoteSubscriptionTier | null
The subscription tier necessary to unlock the emote, or null if the emote is not a subscription emote.
type
Type: string
The type of the emote.
There are many types of emotes that Twitch seems to arbitrarily assign. Do not rely on this value.
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.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| scale | HelixEmoteScale | '1.0' | The scale of the image. | |
| themeMode | HelixEmoteThemeMode | 'light' | The theme mode of the image, either |
getFormattedImageUrl(scale, format, themeMode)
Gets the URL of the emote image in the given scale, format, and theme mode.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| scale | HelixEmoteScale | '1.0' | The scale of the image, either | |
| format | HelixEmoteFormat | 'static' | The format of the image, either | |
| themeMode | HelixEmoteThemeMode | 'light' | The theme mode of the image, either |
getImageUrl(scale)
Gets the URL of the emote image in the given scale.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| scale | HelixEmoteImageScale | none | The scale of the image. |
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.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| scale | HelixEmoteScale | '1.0' | The scale of the image. | |
| themeMode | HelixEmoteThemeMode | 'light' | The theme mode of the image, either |