com.mb3364.twitch.api.resources

Class StreamsResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.StreamsResource

public class StreamsResource
extends AbstractResource

The StreamsResource provides the functionality to access the /streams 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
StreamsResource(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, StreamsResponseHandler handler) Returns a list of stream objects that are queried by a number of parameters sorted by number of viewers descending.
void	get(StreamsResponseHandler handler) Returns a list of stream objects that are queried by a number of parameters sorted by number of viewers descending.
void	get(java.lang.String channelName, StreamResponseHandler handler) Returns a stream object.
void	getFeatured(FeaturedStreamResponseHandler handler) Returns a list of featured (promoted) stream objects.
void	getFeatured(com.mb3364.http.RequestParams params, FeaturedStreamResponseHandler handler) Returns a list of featured (promoted) stream objects.
void	getFollowed(com.mb3364.http.RequestParams params, StreamsResponseHandler handler) Returns a list of stream objects that the authenticated user is following.
void	getFollowed(StreamsResponseHandler handler) Returns a list of stream objects that the authenticated user is following.
void	getSummary(StreamsSummaryResponseHandler handler) Returns a summary of current streams.
void	getSummary(java.lang.String game, StreamsSummaryResponseHandler handler) Returns a summary of current streams.

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

StreamsResource

public StreamsResource(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 channelName,
                StreamResponseHandler handler)

Returns a stream object.

The stream object in the onSuccess() response will be null if the stream is offline.

Parameters:

channelName - the name of the Channel

handler - the response handler

get

public void get(com.mb3364.http.RequestParams params,
                StreamsResponseHandler handler)

Returns a list of stream objects that are queried by a number of parameters sorted by number of viewers descending.

Parameters:

params - the optional request parameters:

• game: Streams categorized under game.
• channel: Streams from a comma separated list of channels.
• limit: Maximum number of objects in array. Default is 25. Maximum is 100.
• offset: Object offset for pagination. Default is 0.
• client_id: Only shows streams from applications of client_id.

handler - the response handler

get

public void get(StreamsResponseHandler handler)

Returns a list of stream objects that are queried by a number of parameters sorted by number of viewers descending.

Parameters:

handler - the response handler

getFeatured

public void getFeatured(com.mb3364.http.RequestParams params,
                        FeaturedStreamResponseHandler handler)

Returns a list of featured (promoted) stream objects.

Parameters:

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

getFeatured

public void getFeatured(FeaturedStreamResponseHandler handler)

Returns a list of featured (promoted) stream objects.

Parameters:

handler - the response handler

getSummary

public void getSummary(java.lang.String game,
                       StreamsSummaryResponseHandler handler)

Returns a summary of current streams.

Parameters:

game - Only show stats for the set game

handler - the response handler

getSummary

public void getSummary(StreamsSummaryResponseHandler handler)

Returns a summary of current streams.

Parameters:

handler - the response handler

getFollowed

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

Returns a list of stream objects that the authenticated user is following. Authenticated, required scope: Scopes.USER_READ

Parameters:

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

getFollowed

public void getFollowed(StreamsResponseHandler handler)

Returns a list of stream objects that the authenticated user is following. Authenticated, required scope: Scopes.USER_READ

Parameters:

handler - the response handler