com.mb3364.twitch.api.resources

Class GamesResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.GamesResource

public class GamesResource
extends AbstractResource

The GamesResource provides the functionality to access the /games 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
GamesResource(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	getTop(com.mb3364.http.RequestParams params, TopGamesResponseHandler handler) Returns a list of games objects sorted by number of current viewers on Twitch, most popular first.
void	getTop(TopGamesResponseHandler handler) Returns a list of games objects sorted by number of current viewers on Twitch, most popular first.

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

GamesResource

public GamesResource(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

getTop

public void getTop(com.mb3364.http.RequestParams params,
                   TopGamesResponseHandler handler)

Returns a list of games objects sorted by number of current viewers on Twitch, most popular first.

Parameters:

params - the optional request parameters:

• limit: the maximum number of objects in array. Maximum is 100.
• offset: the object offset for pagination. Default is 0.

handler - the response handler

getTop

public void getTop(TopGamesResponseHandler handler)

Returns a list of games objects sorted by number of current viewers on Twitch, most popular first.

Parameters:

handler - the response handler