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

Cheermote

@Serializable

data class Cheermote(val prefix: String, val tiers: List<CheermoteTier>, val type: String, val order: Int, val lastUpdated: Instant, val isCharitable: Boolean)

Represents a Cheermote that users can use to cheer Bits.

Constructors

Cheermote

constructor(prefix: String, tiers: List<CheermoteTier>, type: String, order: Int, lastUpdated: Instant, isCharitable: Boolean)

Properties

isCharitable

@SerialName(value = "is_charitable")

val isCharitable: Boolean

a Boolean value that indicates whether this Cheermote provides a charitable contribution match during charity campaigns.

lastUpdated

@SerialName(value = "last_updated")

val lastUpdated: Instant

the date and time, in RFC3339 format, when this Cheermote was last updated.

order

val order: Int

the order that the Cheermotes are shown in the Bits card.

prefix

val prefix: String

the name portion of the Cheermote string that you use in chat to cheer Bits. The full Cheermote string is the concatenation of {prefix} + {number of Bits}. For example, if the prefix is "Cheer" and you want to cheer 100 Bits, the full Cheermote string is Cheer100.

tiers

val tiers: List<CheermoteTier>

a list of tier levels that the Cheermote supports. Each tier identifies the range of Bits that you can cheer at that tier level and an image that graphically identifies the tier level.

type

val type: String

the type of Cheermote. Possible values are: global_first_party, global_third_party, channel_custom, display_only, sponsored.

Cheermote

See also

Constructors

Properties