Skip to main content

Charity

FunctionReturns
getCharityCampaignPromise<CharityCampaign>
getCharityCampaignDonationsPromise<PaginatedResult<CharityCampaignDonation>>

Functions​

getCharityCampaign​

twitch.charity.getCharityCampaign(): Promise<CharityCampaign>

getCharityCampaignDonations​

twitch.charity.getCharityCampaignDonations(): Promise<PaginatedResult<CharityCampaignDonation>>

Types​

CharityCampaign​

type CharityCampaign = {
	id: string
	broadcasterId: string
	broadcasterLogin: string
	broadcasterName: string
	charityName: string
	charityDescription: string
	charityLogo: string
	charityWebsite: string
	currentAmount: CharityCampaignAmount
	targetAmount: CharityCampaignAmount
}

CharityCampaignAmount​

type CharityCampaignAmount = {
	value: number
	decimalPlaces: number
	currency: string
}

CharityCampaignDonation​

type CharityCampaignDonation = {
	campaignId: string
	userId: string
	userLogin: string
	userName: string
	amount: CharityCampaignAmount
}

PaginatedResult​

type PaginatedResult<T> = {
	data: Array<T>
	cursor?: string
}