com.mb3364.twitch.api.resources

Class UsersResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.UsersResource

public class UsersResource
extends AbstractResource

The UsersResource provides the functionality to access the /users endpoints of the Twitch API.

Nested Class Summary

Nested classes/interfaces inherited from class com.mb3364.twitch.api.resources.AbstractResource

AbstractResource.TwitchHttpResponseHandler

Field Summary

Fields inherited from class com.mb3364.twitch.api.resources.AbstractResource

http, objectMapper

Constructor Summary

Constructors

Constructor and Description
UsersResource(java.lang.String baseUrl, int apiVersion) Construct the resource using the Twitch API base URL and specified API version.

Method Summary

Modifier and Type	Method and Description
void	deleteBlock(java.lang.String user, java.lang.String target, UnblockResponseHandler handler) Removes the Block of target for the authenticated user.
void	follow(java.lang.String user, java.lang.String channel, boolean enableNotifications, UserFollowResponseHandler handler) Follow a channel.
void	follow(java.lang.String user, java.lang.String channel, UserFollowResponseHandler handler) Follow a channel.
void	get(java.lang.String user, UserResponseHandler handler) Returns a User object.
void	get(UserResponseHandler handler) Returns the authenticated User object.
void	getBlocks(java.lang.String user, BlocksResponseHandler handler) Returns a list of Block objects on User's block list.
void	getBlocks(java.lang.String user, com.mb3364.http.RequestParams params, BlocksResponseHandler handler) Returns a list of Block objects on User's block list.
void	getFollow(java.lang.String user, java.lang.String channel, UserFollowResponseHandler handler) Returns a UserFollow object representing a channel follow.
void	getFollows(java.lang.String user, com.mb3364.http.RequestParams params, UserFollowsResponseHandler handler) Returns a UserFollows object that contains a list of UserFollow objects representing channels the user is following.
void	getFollows(java.lang.String user, UserFollowsResponseHandler handler) Returns a UserFollows object that contains a list of UserFollow objects representing channels the user is following.
void	getSubscription(java.lang.String user, java.lang.String channel, UserSubscriptionResponseHandler handler) Returns the channel subscription that the user subscribes to.
void	putBlock(java.lang.String user, java.lang.String target, BlockResponseHandler handler) Blocks a target for the authenticated user.
void	unfollow(java.lang.String user, java.lang.String channel, UserUnfollowResponseHandler handler) Unfollow a channel.

Methods inherited from class com.mb3364.twitch.api.resources.AbstractResource

getBaseUrl, setAuthAccessToken, setClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersResource

public UsersResource(java.lang.String baseUrl,
                     int apiVersion)

Construct the resource using the Twitch API base URL and specified API version.

Parameters:

baseUrl - the base URL of the Twitch API

apiVersion - the requested version of the Twitch API

Method Detail

get

public void get(java.lang.String user,
                UserResponseHandler handler)

Returns a User object.

Parameters:

user - the user to request

handler - the response handler

get

public void get(UserResponseHandler handler)

Returns the authenticated User object. Authenticated, required scope: Scopes.USER_READ

Parameters:

handler - the response handler

getSubscription

public void getSubscription(java.lang.String user,
                            java.lang.String channel,
                            UserSubscriptionResponseHandler handler)

Returns the channel subscription that the user subscribes to. Authenticated, required scope: Scopes.USER_SUBSCRIPTIONS

Parameters:

user - the authenticated user's name

channel - the channel name of the subscription

handler - the response handler

getFollows

public void getFollows(java.lang.String user,
                       com.mb3364.http.RequestParams params,
                       UserFollowsResponseHandler handler)

Returns a UserFollows object that contains a list of UserFollow objects representing channels the user is following.

Parameters:

user - the user's name

params - the optional request parameters:

• limit: Maximum number of objects in array. Default is 25. Maximum is 100.
• offset: Object offset for pagination. Default is 0.
• direction: Sorting direction. Default is desc. Valid values are asc and desc.
• sortby: Sort key. Default is created_at. Valid values are created_at and last_broadcast.

handler - the response handler

getFollows

public void getFollows(java.lang.String user,
                       UserFollowsResponseHandler handler)

Returns a UserFollows object that contains a list of UserFollow objects representing channels the user is following.

Parameters:

user - the user's name

handler - the response handler

getFollow

public void getFollow(java.lang.String user,
                      java.lang.String channel,
                      UserFollowResponseHandler handler)

Returns a UserFollow object representing a channel follow.

Parameters:

user - the user

channel - the channel

handler - the response handler

follow

public void follow(java.lang.String user,
                   java.lang.String channel,
                   boolean enableNotifications,
                   UserFollowResponseHandler handler)

Follow a channel. Must be authenticated as the user. Authenticated, required scope: Scopes.USER_FOLLOWS_EDIT

Parameters:

user - the authenticated user

channel - the channel to follow

enableNotifications - receive email/push notifications when channel goes live. Default is false.

handler - the response handler

follow

public void follow(java.lang.String user,
                   java.lang.String channel,
                   UserFollowResponseHandler handler)

Follow a channel. Must be authenticated as the user. Authenticated, required scope: Scopes.USER_FOLLOWS_EDIT

Parameters:

user - the authenticated user

channel - the channel to follow

handler - the response handler

unfollow

public void unfollow(java.lang.String user,
                     java.lang.String channel,
                     UserUnfollowResponseHandler handler)

Unfollow a channel. Must be authenticated as the user. Authenticated, required scope: Scopes.USER_FOLLOWS_EDIT

Parameters:

user - the authenticated user

channel - the channel to unfollow

handler - the response handler

getBlocks

public void getBlocks(java.lang.String user,
                      com.mb3364.http.RequestParams params,
                      BlocksResponseHandler handler)

Returns a list of Block objects on User's block list. List sorted by recency, newest first. Authenticated, required scope: Scopes.USER_BLOCKS_READ

Parameters:

user - the authenticated user

params - the optional request parameters:

• limit: Maximum number of objects in array. Default is 25. Maximum is 100.
• offset: Object offset for pagination. Default is 0.

handler - the response handler

getBlocks

public void getBlocks(java.lang.String user,
                      BlocksResponseHandler handler)

Returns a list of Block objects on User's block list. List sorted by recency, newest first. Authenticated, required scope: Scopes.USER_BLOCKS_READ

Parameters:

user - the authenticated user

handler - the response handler

putBlock

public void putBlock(java.lang.String user,
                     java.lang.String target,
                     BlockResponseHandler handler)

Blocks a target for the authenticated user. Authenticated, required scope: Scopes.USER_FOLLOWS_EDIT

Parameters:

user - the authenticated user

target - the user to block

handler - the response handler

deleteBlock

public void deleteBlock(java.lang.String user,
                        java.lang.String target,
                        UnblockResponseHandler handler)

Removes the Block of target for the authenticated user. Authenticated, required scope: Scopes.USER_FOLLOWS_EDIT

Parameters:

user - the authenticated user

target - the user to unblock

handler - the response handler