helix/io.github.captnblubber.twitchkt.helix.model/ChannelEmote

ChannelEmote

@Serializable

data class ChannelEmote(val id: String, val name: String, val images: EmoteImages, val tier: String = "", val emoteType: String = "", val emoteSetId: String = "", val ownerId: String = "", val format: List<String> = emptyList(), val scale: List<String> = emptyList(), val themeMode: List<String> = emptyList())

Represents an emote from the Twitch Helix API.

Used by Get Channel Emotes, Get Global Emotes, and Get Emote Sets endpoints.

See also

Twitch API Reference - Get Channel Emotes

Constructors

constructor(id: String, name: String, images: EmoteImages, tier: String = "", emoteType: String = "", emoteSetId: String = "", ownerId: String = "", format: List<String> = emptyList(), scale: List<String> = emptyList(), themeMode: List<String> = emptyList())

Properties

@SerialName(value = "emote_set_id")

val emoteSetId: String

an ID that identifies the emote set that the emote belongs to.

@SerialName(value = "emote_type")

val emoteType: String

the type of emote: bitstier, follower, or subscriptions.

val format: List<String>

the formats that the emote is available in: animated and/or static.

an ID that uniquely identifies this emote.

val images: EmoteImages

the image URLs for the emote. These always provide a static, non-animated emote image with a light background.

val name: String

the name of the emote. This is the name that viewers type in the chat window to get the emote to appear.

@SerialName(value = "owner_id")

val ownerId: String

the ID of the broadcaster who owns the emote. Present in Get Emote Sets responses.

val scale: List<String>

the sizes that the emote is available in: 1.0, 2.0, and/or 3.0.

@SerialName(value = "theme_mode")

val themeMode: List<String>

the background themes that the emote is available in: dark and/or light.

val tier: String

the subscriber tier at which the emote is unlocked. Empty string if emoteType is not subscriptions.