com.mb3364.twitch.api.resources

Class TeamsResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.TeamsResource

public class TeamsResource
extends AbstractResource

The TeamsResource provides the functionality to access the /teams 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
TeamsResource(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	get(com.mb3364.http.RequestParams params, TeamsResponseHandler handler) Returns a list of active teams.
void	get(java.lang.String team, TeamResponseHandler handler) Returns a specified Team object.
void	get(TeamsResponseHandler handler) Returns a list of active teams.

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

TeamsResource

public TeamsResource(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(com.mb3364.http.RequestParams params,
                TeamsResponseHandler handler)

Returns a list of active teams.

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

get

public void get(TeamsResponseHandler handler)

Returns a list of active teams.

Parameters:

handler - the response handler

get

public void get(java.lang.String team,
                TeamResponseHandler handler)

Returns a specified Team object.

Parameters:

team - the name of the Team

handler - the response handler