com.mb3364.twitch.api.resources

Class ChannelsResource

java.lang.Object

com.mb3364.twitch.api.resources.AbstractResource

com.mb3364.twitch.api.resources.ChannelsResource

public class ChannelsResource
extends AbstractResource

The ChannelsResource provides the functionality to access the /channels 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
ChannelsResource(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(ChannelResponseHandler handler) Returns a channel object of authenticated user.
void	get(java.lang.String channelName, ChannelResponseHandler handler) Returns a Channel object.
void	getEditors(java.lang.String channelName, UsersResponseHandler handler) Returns a list of user objects who are editors of channelName.
void	getFollows(java.lang.String channelName, ChannelFollowsResponseHandler handler) Returns a list of follow objects representing the followers of a channel.
void	getFollows(java.lang.String channelName, com.mb3364.http.RequestParams params, ChannelFollowsResponseHandler handler) Returns a list of follow objects representing the followers of a channel.
void	getSubscription(java.lang.String channelName, java.lang.String user, ChannelSubscriptionResponseHandler handler) Returns a subscription object which includes the user if that user is subscribed.
void	getSubscriptions(java.lang.String channelName, ChannelSubscriptionsResponseHandler handler) Returns a list of subscription objects sorted by subscription relationship creation date which contain users subscribed to the specified channel.
void	getSubscriptions(java.lang.String channelName, com.mb3364.http.RequestParams params, ChannelSubscriptionsResponseHandler handler) Returns a list of subscription objects sorted by subscription relationship creation date which contain users subscribed to the specified channel.
void	getTeams(java.lang.String channelName, TeamsResponseHandler handler) Returns a list of team objects the channel belongs to.
void	getVideos(java.lang.String channelName, com.mb3364.http.RequestParams params, VideosResponseHandler handler) Returns a list of videos ordered by time of creation, starting with the most recent from specified channel.
void	getVideos(java.lang.String channelName, VideosResponseHandler handler) Returns a list of videos ordered by time of creation, starting with the most recent from specified channel.
void	put(java.lang.String channelName, com.mb3364.http.RequestParams params, ChannelResponseHandler handler) Update channel's status, game, or delay.
void	resetStreamKey(java.lang.String channelName, ChannelResponseHandler handler) Reset channel's stream key.
void	startCommercial(java.lang.String channelName, int length, CommercialResponseHandler handler) Start a commercial on channel.

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

ChannelsResource

public ChannelsResource(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(ChannelResponseHandler handler)

Returns a channel object of authenticated user. Channel object includes stream key.

Authenticated, required scope: Scopes.CHANNEL_READ

Parameters:

handler - the response handler

get

public void get(java.lang.String channelName,
                ChannelResponseHandler handler)

Returns a Channel object.

Parameters:

channelName - the name of the Channel

handler - the response handler

getEditors

public void getEditors(java.lang.String channelName,
                       UsersResponseHandler handler)

Returns a list of user objects who are editors of channelName.

Authenticated, required scope: Scopes.CHANNEL_READ

Parameters:

channelName - the name of the Channel

handler - the response handler

put

public void put(java.lang.String channelName,
                com.mb3364.http.RequestParams params,
                ChannelResponseHandler handler)

Update channel's status, game, or delay.

Authenticated, required scope: Scopes.CHANNEL_EDITOR

Parameters:

channelName - the name of the Channel

params - the optional request parameters:

• status: Channel's title
• game: Game category to be classified as.
• delay: Channel delay in seconds. Requires the channel owner's OAuth token.

handler - the response handler

resetStreamKey

public void resetStreamKey(java.lang.String channelName,
                           ChannelResponseHandler handler)

Reset channel's stream key.

Authenticated, required scope: Scopes.CHANNEL_STREAM

Parameters:

channelName - the name of the Channel

handler - the response handler

startCommercial

public void startCommercial(java.lang.String channelName,
                            int length,
                            CommercialResponseHandler handler)

Start a commercial on channel.

Authenticated, required scope: Scopes.CHANNEL_COMMERCIAL

Parameters:

channelName - the name of the channel

length - Length of commercial break in seconds. Default value is 30. Valid values are 30, 60, 90, 120, 150, and 180

handler - the response handler

getTeams

public void getTeams(java.lang.String channelName,
                     TeamsResponseHandler handler)

Returns a list of team objects the channel belongs to.

Parameters:

channelName - the name of the Channel

handler - the response handler

getFollows

public void getFollows(java.lang.String channelName,
                       com.mb3364.http.RequestParams params,
                       ChannelFollowsResponseHandler handler)

Returns a list of follow objects representing the followers of a channel.

Parameters:

channelName - the name of the Channel

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.
• direction: Creation date sorting direction. Default is desc. Valid values are asc and desc.

handler - the response handler

getFollows

public void getFollows(java.lang.String channelName,
                       ChannelFollowsResponseHandler handler)

Returns a list of follow objects representing the followers of a channel.

Parameters:

channelName - the name of the Channel

handler - the response handler

getVideos

public void getVideos(java.lang.String channelName,
                      com.mb3364.http.RequestParams params,
                      VideosResponseHandler handler)

Returns a list of videos ordered by time of creation, starting with the most recent from specified channel.

Parameters:

channelName - the name of the Channel

params - the optional request parameters:

• limit: Maximum number of objects in array. Default is 10. Maximum is 100.
• offset: Object offset for pagination. Default is 0.
• broadcasts: Returns only broadcasts when true. Otherwise only highlights are returned. Default is false
• hls: Returns only HLS VoDs when true. Otherwise only non-HLS VoDs are returned. Default is false.

handler - the response handler

getVideos

public void getVideos(java.lang.String channelName,
                      VideosResponseHandler handler)

Returns a list of videos ordered by time of creation, starting with the most recent from specified channel.

Parameters:

channelName - the name of the Channel

handler - the response handler

getSubscriptions

public void getSubscriptions(java.lang.String channelName,
                             com.mb3364.http.RequestParams params,
                             ChannelSubscriptionsResponseHandler handler)

Returns a list of subscription objects sorted by subscription relationship creation date which contain users subscribed to the specified channel.

Authenticated, required scope: Scopes.CHANNEL_SUBSCRIPTIONS

Parameters:

channelName - the name of the Channel

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.
• direction: Creation date sorting direction. Default is asc. Valid values are asc and desc.

handler - the response handler

getSubscriptions

public void getSubscriptions(java.lang.String channelName,
                             ChannelSubscriptionsResponseHandler handler)

Returns a list of subscription objects sorted by subscription relationship creation date which contain users subscribed to the specified channel.

Authenticated, required scope: Scopes.CHANNEL_SUBSCRIPTIONS

Parameters:

channelName - the name of the Channel

handler - the response handler

getSubscription

public void getSubscription(java.lang.String channelName,
                            java.lang.String user,
                            ChannelSubscriptionResponseHandler handler)

Returns a subscription object which includes the user if that user is subscribed.

Authenticated, required scope: Scopes.CHANNEL_CHECK_SUBSCRIPTION

Parameters:

channelName - the name of the channel

user - the user to check

handler - the response handler