com.mb3364.twitch.api.resources

Class AbstractResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

Direct Known Subclasses:

ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource

public abstract class AbstractResource
extends java.lang.Object

AbstractResource is the abstract base class of a Twitch resource. A resource provides the functionality to access the REST endpoints of the Twitch API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractResource.TwitchHttpResponseHandler Handles HTTP response's from the Twitch API.

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.mb3364.http.AsyncHttpClient	http
protected static com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getBaseUrl() Get the base URL to the Twitch API.
void	setAuthAccessToken(java.lang.String accessToken) Sets the authentication access token to be included in the HTTP headers of each API request.
void	setClientId(java.lang.String clientId) Sets the application's client ID to be included in the HTTP headers of each API request.

Methods inherited from class java.lang.Object

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

Field Detail

objectMapper

protected static final com.fasterxml.jackson.databind.ObjectMapper objectMapper

http

protected static final com.mb3364.http.AsyncHttpClient http

Constructor Detail

AbstractResource

protected AbstractResource(java.lang.String baseUrl,
                           int apiVersion)

Construct a 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

setAuthAccessToken

public void setAuthAccessToken(java.lang.String accessToken)

Sets the authentication access token to be included in the HTTP headers of each API request.

Parameters:

accessToken - the user's authentication access token

setClientId

public void setClientId(java.lang.String clientId)

Sets the application's client ID to be included in the HTTP headers of each API request.

Parameters:

clientId - the application's client ID

getBaseUrl

protected java.lang.String getBaseUrl()

Get the base URL to the Twitch API. Intended to be called by subclasses when generating their resource URL endpoint.

Returns:

the base URL to the Twitch API