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

CharityCampaign

@Serializable

data class CharityCampaign(val id: String, val broadcasterId: String, val broadcasterLogin: String, val broadcasterName: String, val charityName: String, val charityDescription: String, val charityLogo: String, val charityWebsite: String, val currentAmount: CharityAmount, val targetAmount: CharityAmount? = null)

Represents a charity campaign that a broadcaster is running.

See also

Twitch API Reference - Get Charity Campaign

Constructors

CharityCampaign

constructor(id: String, broadcasterId: String, broadcasterLogin: String, broadcasterName: String, charityName: String, charityDescription: String, charityLogo: String, charityWebsite: String, currentAmount: CharityAmount, targetAmount: CharityAmount? = null)

Properties

@SerialName(value = "broadcaster_id")

val broadcasterId: String

an ID that identifies the broadcaster that's running the campaign.

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.

charityDescription

@SerialName(value = "charity_description")

val charityDescription: String

a description of the charity.

@SerialName(value = "charity_logo")

val charityLogo: String

a URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px.

@SerialName(value = "charity_name")

val charityName: String

the charity's name.

@SerialName(value = "charity_website")

val charityWebsite: String

a URL to the charity's website.

@SerialName(value = "current_amount")

val currentAmount: CharityAmount

the current amount of donations that the campaign has received.

an ID that identifies the charity campaign.

@SerialName(value = "target_amount")

val targetAmount: CharityAmount?

the campaign's fundraising goal. This field is null if the broadcaster has not defined a fundraising goal.