TwitchLib 3.5.3
Loading...
Searching...
No Matches
TwitchLib.Api.Helix.Extensions Class Reference

Extensions related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.Extensions:
TwitchLib.Api.Core.ApiBase

Public Member Functions

 Extensions (IApiSettings settings, IRateLimiter rateLimiter, IHttpCallHandler http)
 
Task< GetExtensionTransactionsResponseGetExtensionTransactionsAsync (string extensionId, List< string > ids=null, string after=null, int first=20, string applicationAccessToken=null)
 Gets the list of Extension transactions for a given Extension. More...
 
Task< GetExtensionLiveChannelsResponseGetExtensionLiveChannelsAsync (string extensionId, int first=20, string after=null, string accessToken=null)
 Returns live channels that have installed or activated a specific Extension More...
 
Task< GetReleasedExtensionsResponseGetReleasedExtensionsAsync (string extensionId, string extensionVersion=null, string accessToken=null)
 Gets information about a released Extension; either the current version or a specified version. 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

Extensions related APIs

Constructor & Destructor Documentation

◆ Extensions()

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

Member Function Documentation

◆ GetExtensionLiveChannelsAsync()

Task< GetExtensionLiveChannelsResponse > TwitchLib.Api.Helix.Extensions.GetExtensionLiveChannelsAsync ( string  extensionId,
int  first = 20,
string  after = null,
string  accessToken = null 
)

Returns live channels that have installed or activated a specific Extension

A channel that recently went live may take a few minutes to appear in this list, and a channel may continue to appear on this list for a few minutes after it stops broadcasting.

Parameters
extensionIdID of the Extension to search for.
firstMaximum number of objects to return. Maximum: 100. Default: 20.
afterThe cursor used to fetch the next page of data.
accessTokenoptional access token to override the use of the stored one in the TwitchAPI instance
Returns
Exceptions
BadParameterException

◆ GetExtensionTransactionsAsync()

Task< GetExtensionTransactionsResponse > TwitchLib.Api.Helix.Extensions.GetExtensionTransactionsAsync ( string  extensionId,
List< string >  ids = null,
string  after = null,
int  first = 20,
string  applicationAccessToken = null 
)

Gets the list of Extension transactions for a given Extension.

Parameters
extensionIdID of the Extension to list transactions for.
idsTransaction IDs to look up. Maximum: 100.
afterThe cursor used to fetch the next page of data. This only applies to queries without ID. If an ID is specified, it supersedes the cursor.
firstMaximum number of objects to return. Maximum: 100. Default: 20.
applicationAccessTokenoptional app access token to override the use of the stored one in the TwitchAPI instance
Returns
Exceptions
BadParameterException

◆ GetReleasedExtensionsAsync()

Task< GetReleasedExtensionsResponse > TwitchLib.Api.Helix.Extensions.GetReleasedExtensionsAsync ( string  extensionId,
string  extensionVersion = null,
string  accessToken = null 
)

Gets information about a released Extension; either the current version or a specified version.

Parameters
extensionIdID of the Extension.
extensionVersionThe specific version of the Extension to return. If not provided, the current version is returned.
accessTokenoptional 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: