com.mb3364.twitch.api.resources

Class SearchResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.SearchResource

public class SearchResource
extends AbstractResource

The SearchResource provides the functionality to access the /search 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
SearchResource(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	channels(java.lang.String query, ChannelsResponseHandler handler) Returns a list of channel objects matching the search query.
void	channels(java.lang.String query, com.mb3364.http.RequestParams params, ChannelsResponseHandler handler) Returns a list of channel objects matching the search query.
void	games(java.lang.String query, GamesResponseHandler handler) Returns a list of game objects matching the search query.
void	games(java.lang.String query, com.mb3364.http.RequestParams params, GamesResponseHandler handler) Returns a list of game objects matching the search query.
void	streams(java.lang.String query, com.mb3364.http.RequestParams params, StreamsResponseHandler handler) Returns a list of stream objects matching the search query.
void	streams(java.lang.String query, StreamsResponseHandler handler) Returns a list of stream objects matching the search query.

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

SearchResource

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

channels

public void channels(java.lang.String query,
                     com.mb3364.http.RequestParams params,
                     ChannelsResponseHandler handler)

Returns a list of channel objects matching the search query.

Parameters:

query - the search query

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

channels

public void channels(java.lang.String query,
                     ChannelsResponseHandler handler)

Returns a list of channel objects matching the search query.

Parameters:

query - the search query

handler - the response handler

streams

public void streams(java.lang.String query,
                    com.mb3364.http.RequestParams params,
                    StreamsResponseHandler handler)

Returns a list of stream objects matching the search query.

Parameters:

query - the search query

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.
• hls: If set to true, only returns streams using HLS. If set to false, only returns streams that are non-HLS.

handler - the response handler

streams

public void streams(java.lang.String query,
                    StreamsResponseHandler handler)

Returns a list of stream objects matching the search query.

Parameters:

query - the search query

handler - the response handler

games

public void games(java.lang.String query,
                  com.mb3364.http.RequestParams params,
                  GamesResponseHandler handler)

Returns a list of game objects matching the search query.

Parameters:

query - the search query

params - the optional request parameters:

• live: If true, only returns games that are live on at least one channel.

handler - the response handler

games

public void games(java.lang.String query,
                  GamesResponseHandler handler)

Returns a list of game objects matching the search query.

Parameters:

query - the search query

handler - the response handler