Channel related APIs More...

Inheritance diagram for TwitchLib.Api.Helix.Channels:

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

Task< GetChannelInformationResponse >	GetChannelInformationAsync (string broadcasterId, string accessToken=null)
	Gets channel information for given user. More...

Task	ModifyChannelInformationAsync (string broadcasterId, ModifyChannelInformationRequest request, string accessToken=null)
	Modifies channel information for given user. More...

Task< GetChannelEditorsResponse >	GetChannelEditorsAsync (string broadcasterId, string accessToken=null)
	Gets a list of users who have editor permissions for a specific channel. More...

Task< GetChannelVIPsResponse >	GetVIPsAsync (string broadcasterId, List< string > userIds=null, int first=20, string after=null, string accessToken=null)
	Gets a list of the channel’s VIPs. Requires a user access token that includes the channel:read:vips scope. More...

Task	AddChannelVIPAsync (string broadcasterId, string userId, string accessToken=null)
	Adds a VIP to the broadcaster’s chat room. Rate Limits: The channel may add a maximum of 10 VIPs within a 10 seconds period. Requires a user access token that includes the channel:manage:vips scope. More...

Task	RemoveChannelVIPAsync (string broadcasterId, string userId, string accessToken=null)
	Removes a VIP from the broadcaster’s chat room. Rate Limits: The channel may remove a maximum of 10 VIPs within a 10 seconds period. Requires a user access token that includes the channel:manage:vips scope. 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

Channel related APIs

Constructor & Destructor Documentation

◆ Channels()

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

Member Function Documentation

◆ AddChannelVIPAsync()

Task TwitchLib.Api.Helix.Channels.AddChannelVIPAsync	(	string	broadcasterId,
		string	userId,
		string	accessToken = `null`
	)

Adds a VIP to the broadcaster’s chat room. Rate Limits: The channel may add a maximum of 10 VIPs within a 10 seconds period. Requires a user access token that includes the channel:manage:vips scope.

Parameters

broadcasterId	The ID of the broadcaster that’s granting VIP status to the user.
userId	The ID of the user to add as a VIP in the broadcaster’s chat room.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

◆ GetChannelEditorsAsync()

Task< GetChannelEditorsResponse > TwitchLib.Api.Helix.Channels.GetChannelEditorsAsync	(	string	broadcasterId,
		string	accessToken = `null`
	)

Gets a list of users who have editor permissions for a specific channel.

Required scope: channel:read:editors

Parameters

broadcasterId	The ID of the broadcaster whose editors you want to get.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

Exceptions

BadParameterException

◆ GetChannelInformationAsync()

Task< GetChannelInformationResponse > TwitchLib.Api.Helix.Channels.GetChannelInformationAsync	(	string	broadcasterId,
		string	accessToken = `null`
	)

Gets channel information for given user.

Parameters

broadcasterId	The ID of the broadcaster whose channel you want to get.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

Exceptions

BadParameterException

◆ GetVIPsAsync()

Task< GetChannelVIPsResponse > TwitchLib.Api.Helix.Channels.GetVIPsAsync	(	string	broadcasterId,
		List< string >	userIds = `null`,
		int	first = `20`,
		string	after = `null`,
		string	accessToken = `null`
	)

Gets a list of the channel’s VIPs. Requires a user access token that includes the channel:read:vips scope.

Parameters

broadcasterId	The ID of the broadcaster whose list of VIPs you want to get.
userIds	Filters the list for specific VIPs.
first	The maximum number of items to return per page in the response. Max 100
after	The cursor used to get the next page of results.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

◆ ModifyChannelInformationAsync()

Task TwitchLib.Api.Helix.Channels.ModifyChannelInformationAsync	(	string	broadcasterId,
		ModifyChannelInformationRequest	request,
		string	accessToken = `null`
	)

Modifies channel information for given user.

Required scope: channel:manage:broadcast

Parameters

broadcasterId	ID of the channel to be updated
request
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

Returns

Exceptions

BadParameterException

◆ RemoveChannelVIPAsync()

Task TwitchLib.Api.Helix.Channels.RemoveChannelVIPAsync	(	string	broadcasterId,
		string	userId,
		string	accessToken = `null`
	)

Removes a VIP from the broadcaster’s chat room. Rate Limits: The channel may remove a maximum of 10 VIPs within a 10 seconds period. Requires a user access token that includes the channel:manage:vips scope.

Parameters

broadcasterId	The ID of the user to remove as a VIP from the broadcaster’s chat room.
userId	The ID of the broadcaster that’s removing VIP status from the user.
accessToken	optional access token to override the use of the stored one in the TwitchAPI instance

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

TwitchLib.Api/TwitchLib.Api.Helix/Channels.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Channels()

Member Function Documentation

◆ AddChannelVIPAsync()

◆ GetChannelEditorsAsync()

◆ GetChannelInformationAsync()

◆ GetVIPsAsync()

◆ ModifyChannelInformationAsync()

◆ RemoveChannelVIPAsync()