BlushyFace.Twitch.API.Helix.Endpoints.Users Class Reference

Implemented More...

Public Member Functions
	Users (HttpHandler httpHandler)
async Task< string >	CreateUserFollowsAsync (List< KeyValuePair< string, string >> parameters=null)
async Task< string >	DeleteUserFollowsAsync (List< KeyValuePair< string, string >> parameters=null)
async Task< UserResponse >	GetUsersAsync (List< KeyValuePair< string, string >> parameters=null)
async Task< UserFollowResponse >	GetUserFollowsAsync (List< KeyValuePair< string, string >> parameters=null)
async Task< UpdateUserResponse >	UpdateUserAsync (List< KeyValuePair< string, string >> parameters)

Detailed Description

Implemented

Member Function Documentation

CreateUserFollowsAsync()

async Task<string> BlushyFace.Twitch.API.Helix.Endpoints.Users.CreateUserFollowsAsync ( List< KeyValuePair< string, string >>  parameters = null )

inline

Adds a specified user to the followers of a specified channel.

Required scope: user:edit:follows

Required Query Parameters: from_id + to_id

More info: https://dev.twitch.tv/docs/api/reference#create-user-follows

Parameters

parameters

Returns

DeleteUserFollowsAsync()

async Task<string> BlushyFace.Twitch.API.Helix.Endpoints.Users.DeleteUserFollowsAsync ( List< KeyValuePair< string, string >>  parameters = null )

inline

Deletes a specified user from the followers of a specified channel.

Required scope: user:edit:follows

Required Query Parameters: from_id, to_id

More info: https://dev.twitch.tv/docs/api/reference#delete-user-follows

Parameters

parameters

Returns

GetUserFollowsAsync()

async Task<UserFollowResponse> BlushyFace.Twitch.API.Helix.Endpoints.Users.GetUserFollowsAsync ( List< KeyValuePair< string, string >>  parameters = null )

inline

Gets information on follow relationships between two Twitch users. Information returned is sorted in order, most recent follow first. This can return information like “who is qotrok following,” “who is following qotrok,” or “is user X following user Y.”

The response has a JSON payload with a data field containing an array of follow relationship elements and a pagination field containing information required to query for more follow information.

At minimum, from_id or to_id must be provided for a query to be valid.

More info: https://dev.twitch.tv/docs/api/reference#get-users-follows

Parameters

parameters

Returns

GetUsersAsync()

async Task<UserResponse> BlushyFace.Twitch.API.Helix.Endpoints.Users.GetUsersAsync ( List< KeyValuePair< string, string >>  parameters = null )

inline

Gets information about one or more specified Twitch users. Users are identified by optional user IDs and/or login name. If neither a user ID nor a login name is specified, the user is looked up by Bearer token.

The response has a JSON payload with a data field containing an array of user-information elements.

Required scope: user:read:email

More info: https://dev.twitch.tv/docs/api/reference#get-users

Parameters

parameters

Returns

UpdateUserAsync()

async Task<UpdateUserResponse> BlushyFace.Twitch.API.Helix.Endpoints.Users.UpdateUserAsync ( List< KeyValuePair< string, string >>  parameters )

inline

Updates the description of a user specified by a Bearer token.

Required scope: user:edit

More info: https://dev.twitch.tv/docs/api/reference#update-user

Parameters

description

Returns