Overview
Can be accessed using client.charity on an ApiClient instance.
Example
const api = new ApiClient({ authProvider }); const charityCampaign = await api.charity.getCharityCampaign('125328655');
Methods
getCharityCampaign(broadcaster)
asyncGets information about the charity campaign that a broadcaster is running. Returns null if the specified broadcaster has no active charity campaign.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string | number | UserIdResolvableType | none | The broadcaster to get charity campaign information about. |
getCharityCampaignDonations(broadcaster, pagination)
asyncGets the list of donations that users have made to the broadcaster’s active charity campaign.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string | number | UserIdResolvableType | none | The broadcaster to get charity campaign donation information about. | |
| pagination | HelixForwardPagination | none | see below | |
| pagination.after | string | none | A cursor to get the following page of. | |
| pagination.limit | number | none | The number of results per page. |