TwitchLib.Api.Helix.Search Class Reference

Search related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.Search:

Public Member Functions
	Search (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
Task< SearchCategoriesResponse >	SearchCategoriesAsync (string encodedSearchQuery, string after=null, int first=20, string accessToken=null)
	Returns a list of games or categories that match the query via name either entirely or partially. More...
Task< SearchChannelsResponse >	SearchChannelsAsync (string encodedSearchQuery, bool liveOnly=false, string after=null, int first=20, string accessToken=null)
	Returns a list of channels (users who have streamed within the past 6 months) that match the query via channel name or description either entirely or partially. 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

Search related APIs

Constructor & Destructor Documentation

Search()

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

Member Function Documentation

SearchCategoriesAsync()

Task< SearchCategoriesResponse > TwitchLib.Api.Helix.Search.SearchCategoriesAsync	(	string	encodedSearchQuery,
		string	after = null,
		int	first = 20,
		string	accessToken = null
	)

Returns a list of games or categories that match the query via name either entirely or partially.

Parameters

encodedSearchQuery	URl encoded search query
after	Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
first	Maximum number of objects to return.

Default: 20. Maximum: 100.

Parameters

accessToken

optional access token to override the use of the stored one in the TwitchAPI instance

Returns

Exceptions

BadParameterException

SearchChannelsAsync()

Task< SearchChannelsResponse > TwitchLib.Api.Helix.Search.SearchChannelsAsync	(	string	encodedSearchQuery,
		bool	liveOnly = false,
		string	after = null,
		int	first = 20,
		string	accessToken = null
	)

Returns a list of channels (users who have streamed within the past 6 months) that match the query via channel name or description either entirely or partially.

Results include both live and offline channels.

Online channels will have additional metadata (e.g. started_at, tag_ids).

Parameters

encodedSearchQuery	URl encoded search query
liveOnly	Filter results for live streams only. Default: false
after	Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
first	Maximum number of objects to return.

Default: 20. Maximum: 100.

Parameters

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/Search.cs