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

CheermoteTier

@Serializable

data class CheermoteTier(val minBits: Int, val id: String, val color: String, val images: JsonObject, val canCheer: Boolean, val showInBitsCard: Boolean)

Represents a tier level of a Cheermote.

Constructors

CheermoteTier

constructor(minBits: Int, id: String, color: String, images: JsonObject, canCheer: Boolean, showInBitsCard: Boolean)

Properties

canCheer

@SerialName(value = "can_cheer")

val canCheer: Boolean

a Boolean value that determines whether users can cheer at this tier level.

color

val color: String

the hex code of the color associated with this tier level (for example, #979797).

val id: String

the tier level. Possible tiers are: 1, 100, 500, 1000, 5000, 10000, 100000.

images

val images: JsonObject

the animated and static image sets for the Cheermote. The dictionary of images is organized by theme, format, and size. The theme keys are dark and light. Each theme is a dictionary of formats: animated and static. Each format is a dictionary of sizes: 1, 1.5, 2, 3, and 4. The value of each size contains the URL to the image.

minBits

@SerialName(value = "min_bits")

val minBits: Int

the minimum number of Bits that you must cheer at this tier level.

showInBitsCard

@SerialName(value = "show_in_bits_card")

val showInBitsCard: Boolean

a Boolean value that determines whether this tier level is shown in the Bits card.

CheermoteTier

See also

Constructors

Properties