TwitchLib.Api.Helix.HypeTrain Class Reference

HypeTrain related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.HypeTrain:

Public Member Functions
	HypeTrain (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
Task< GetHypeTrainResponse >	GetHypeTrainEventsAsync (string broadcasterId, int first=1, string cursor=null, string accessToken=null)
	Gets the information of the most recent Hype Train of the given channel ID. 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

HypeTrain related APIs

Constructor & Destructor Documentation

HypeTrain()

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

Member Function Documentation

GetHypeTrainEventsAsync()

Task< GetHypeTrainResponse > TwitchLib.Api.Helix.HypeTrain.GetHypeTrainEventsAsync	(	string	broadcasterId,
		int	first = 1,
		string	cursor = null,
		string	accessToken = null
	)

Gets the information of the most recent Hype Train of the given channel ID.

When there is currently an active Hype Train, it returns information about that Hype Train.

When there is currently no active Hype Train, it returns information about the most recent Hype Train.

After 5 days, if no Hype Train has been active, the endpoint will return an empty response.

Required scope: channel:read:hype_train

Parameters

broadcasterId	User ID of the broadcaster. Must match the User ID in the Access Token.
first	Maximum number of objects to return. Maximum: 100. Default: 1.
cursor	Cursor for forward pagination: tells the server where to start fetching the next set of results in a multi-page response.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

Exceptions

BadParameterException

---

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

• TwitchLib.Api/TwitchLib.Api.Helix/HypeTrain.cs