com.mb3364.twitch.api.resources

Class VideosResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.VideosResource

public class VideosResource
extends AbstractResource

The VideosResource provides the functionality to access the /videos 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
VideosResource(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(java.lang.String id, VideoResponseHandler handler) Returns a Video object.
void	getFollowed(com.mb3364.http.RequestParams params, VideosResponseHandler handler) Returns a list of Video's from channels that the authenticated user is following.
void	getFollowed(VideosResponseHandler handler) Returns a list of Video's from channels that the authenticated user is following.
void	getTop(com.mb3364.http.RequestParams params, VideosResponseHandler handler) Returns a list of Video's created in a given time period sorted by number of views, most popular first.
void	getTop(VideosResponseHandler handler) Returns a list of Video's created in a given time period sorted by number of views, 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

VideosResource

public VideosResource(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 id,
                VideoResponseHandler handler)

Returns a Video object.

Parameters:

id - the ID of the Video

handler - the response handler

getTop

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

Returns a list of Video's created in a given time period sorted by number of views, 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.
• game: Returns only videos from game.
• period: Returns only videos created in time period. Valid values are week, month, or all. Default is week.

handler - the response handler

getTop

public void getTop(VideosResponseHandler handler)

Returns a list of Video's created in a given time period sorted by number of views, most popular first.

Parameters:

handler - the response handler

getFollowed

public void getFollowed(com.mb3364.http.RequestParams params,
                        VideosResponseHandler handler)

Returns a list of Video's from channels that the authenticated user is following. Authenticated, required scope: Scopes.USER_READ

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

getFollowed

public void getFollowed(VideosResponseHandler handler)

Returns a list of Video's from channels that the authenticated user is following. Authenticated, required scope: Scopes.USER_READ

Parameters:

handler - the response handler