Inheritance diagram for TwitchLib.Api.Helix.Raids:

Public Member Functions
	Raids (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)

Task< StartRaidResponse >	StartRaidAsync (string fromBroadcasterId, string toBroadcasterId, string accessToken=null)
	Raid another channel by sending the broadcaster’s viewers to the targeted channel. More...

Task	CancelRaidAsync (string broadcasterId, string accessToken=null)
	Cancel a pending raid. 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

Raids related APIs

Constructor & Destructor Documentation

◆ Raids()

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

Member Function Documentation

◆ CancelRaidAsync()

Task TwitchLib.Api.Helix.Raids.CancelRaidAsync	(	string	broadcasterId,
		string	accessToken = `null`
	)

Cancel a pending raid.

You can cancel a raid at any point up until the broadcaster clicks Raid Now in the Twitch UX or the 90 seconds countdown expires.

Rate Limit: The limit is 10 requests within a 10-minute window.

Requires a user access token that includes the channel:manage:raids scope.

The ID in the broadcaster_id query parameter must match the user ID in the OAuth token.

Parameters

broadcasterId	The ID of the broadcaster that sent the raiding party.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

◆ StartRaidAsync()

Task< StartRaidResponse > TwitchLib.Api.Helix.Raids.StartRaidAsync	(	string	fromBroadcasterId,
		string	toBroadcasterId,
		string	accessToken = `null`
	)

Raid another channel by sending the broadcaster’s viewers to the targeted channel.

Rate Limit: The limit is 10 requests within a 10-minute window.

Requires a user access token that includes the channel:manage:raids scope.

The ID in the from_broadcaster_id query parameter must match the user ID in the OAuth token.