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

CreatorGoal

@Serializable

data class CreatorGoal(val id: String, val broadcasterId: String, val broadcasterName: String, val broadcasterLogin: String, val type: String, val description: String, val currentAmount: Int, val targetAmount: Int, val createdAt: Instant)

Represents a creator goal from the Twitch Helix API.

Constructors

CreatorGoal

constructor(id: String, broadcasterId: String, broadcasterName: String, broadcasterLogin: String, type: String, description: String, currentAmount: Int, targetAmount: Int, createdAt: Instant)

Properties

broadcasterId

@SerialName(value = "broadcaster_id")

val broadcasterId: String

an ID that identifies the broadcaster that created the goal.

broadcasterLogin

@SerialName(value = "broadcaster_login")

val broadcasterLogin: String

the broadcaster's login name.

broadcasterName

@SerialName(value = "broadcaster_name")

val broadcasterName: String

the broadcaster's display name.

createdAt

@SerialName(value = "created_at")

val createdAt: Instant

the UTC date and time that the broadcaster created the goal.

currentAmount

@SerialName(value = "current_amount")

val currentAmount: Int

the goal's current value. The goal's type determines how this value is increased or decreased.

description

val description: String

a description of the goal. Is an empty string if not specified.

val id: String

an ID that identifies this goal.

targetAmount

@SerialName(value = "target_amount")

val targetAmount: Int

the goal's target value. For example, if the broadcaster has 200 followers before creating the goal, and their goal is to double that number, this field is set to 400.

type

val type: String

the type of goal. Possible values are: follower, subscription, subscription_count, new_subscription, new_subscription_count.

CreatorGoal

See also

Constructors

Properties