TwitchLib.Api.Helix.Charity Class Reference

Charity related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.Charity:

Public Member Functions
	Charity (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
Task< GetCharityCampaignResponse >	GetCharityCampaignAsync (string broadcasterId, string accessToken=null)
	[BETA] - Gets information about the charity campaign that a broadcaster is running, such as their fundraising goal and the amount that’s been donated so far. Requires an user access token that includes the channel:read:charity scope. The ID in the broadcaster_id query parameter must match the user ID in the access token. More...
Public Member Functions inherited from TwitchLib.Api.Core.ApiBase
	ApiBase (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
async ValueTask< string >	GetAccessTokenAsync (string accessToken=null)

Additional Inherited Members
Protected Member Functions inherited from TwitchLib.Api.Core.ApiBase
async Task< string >	TwitchGetAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchGetGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPatchGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< string >	TwitchPatchAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< KeyValuePair< int, string > >	TwitchDeleteAsync (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPostGenericAsync< T > (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPostGenericModelAsync< T > (string resource, ApiVersion api, RequestModel model, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchDeleteGenericAsync< T > (string resource, ApiVersion api, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< T >	TwitchPutGenericAsync< T > (string resource, ApiVersion api, string payload=null, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< string >	TwitchPutAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
async Task< KeyValuePair< int, string > >	TwitchPostAsync (string resource, ApiVersion api, string payload, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, string clientId=null, string customBase=null)
Task	PutBytesAsync (string url, byte[] payload)
async Task< T >	GetGenericAsync< T > (string url, List< KeyValuePair< string, string > > getParams=null, string accessToken=null, ApiVersion api=ApiVersion.Helix, string clientId=null)
Protected Attributes inherited from TwitchLib.Api.Core.ApiBase
readonly IApiSettings	Settings

Detailed Description

Charity related APIs

Constructor & Destructor Documentation

Charity()

TwitchLib.Api.Helix.Charity.Charity	(	IApiSettings	settings,
		IRateLimiter	rateLimiter,
		IHttpCallHandler	http
	)

Member Function Documentation

GetCharityCampaignAsync()

Task< GetCharityCampaignResponse > TwitchLib.Api.Helix.Charity.GetCharityCampaignAsync	(	string	broadcasterId,
		string	accessToken = null
	)

[BETA] - Gets information about the charity campaign that a broadcaster is running, such as their fundraising goal and the amount that’s been donated so far. Requires an user access token that includes the channel:read:charity scope. The ID in the broadcaster_id query parameter must match the user ID in the access token.

Parameters

broadcasterId	The ID of the broadcaster that’s actively running a charity campaign.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

A list that contains the charity campaign that the broadcaster is currently running.

---

The documentation for this class was generated from the following file:

• TwitchLib.Api/TwitchLib.Api.Helix/Charity.cs