Twitch

java.lang.Object
- com.mb3364.twitch.api.Twitch

```
public class Twitch
extends java.lang.Object
```
Enables the ability to interact with the Twitch.tv REST API.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_API_VERSION

static java.lang.String DEFAULT_BASE_URL

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_API_VERSION`
`static java.lang.String`	`DEFAULT_BASE_URL`

Constructor Summary

Constructors
Constructor and Description
`Twitch()` Constructs a Twitch application instance.
`Twitch(java.lang.String baseUrl, int apiVersion)` Constructs a Twitch application instance with a set API base URL and API version number.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authenticator`	`auth()` Get the authenticator object.
`ChannelsResource`	`channels()` Get the `ChannelsResource` object.
`ChatResource`	`chat()` Get the `ChatResource` object.
`GamesResource`	`games()` Get the `GamesResource` object.
`java.lang.String`	`getClientId()` Get the set Twitch client ID.
`IngestsResource`	`ingests()` Get the `IngestsResource` object.
`RootResource`	`root()` Get the `RootResource` object.
`SearchResource`	`search()` Get the `SearchResource` object.
`void`	`setClientId(java.lang.String clientId)` Set the Twitch client ID.
`StreamsResource`	`streams()` Get the `StreamsResource` object.
`TeamsResource`	`teams()` Get the `TeamsResource` object.
`UsersResource`	`users()` Get the `UsersResource` object.
`VideosResource`	`videos()` Get the `VideosResource` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BASE_URL
```
public static final java.lang.String DEFAULT_BASE_URL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_API_VERSION
```
public static final int DEFAULT_API_VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Twitch
```
public Twitch(java.lang.String baseUrl,
              int apiVersion)
```
    Constructs a Twitch application instance with a set API base URL and API version number.
    
    Parameters:
    
    baseUrl - the base URL of the Twitch API
    
    apiVersion - the API version number to request
  - Twitch
```
public Twitch()
```
    Constructs a Twitch application instance.
- Method Detail
  - getClientId
```
public java.lang.String getClientId()
```
    Get the set Twitch client ID.
    
    Returns:
    
    The Twitch client ID
  - setClientId
```
public void setClientId(java.lang.String clientId)
```
    Set the Twitch client ID. Register your application on Twitch.tv to retrieve a client ID.
    Passed to authorization endpoints to identify your application.
    
    Parameters:
    
    clientId - Twitch client ID
  - auth
```
public Authenticator auth()
```
    Get the authenticator object. The authenticator object allows a user to authenticate with the Twitch.tv servers.
    
    Returns:
    
    the authenticator object
    
    See Also:
    
    Authenticator
  - channels
```
public ChannelsResource channels()
```
    Get the ChannelsResource object. The ChannelsResource provides the functionality to access the /channels endpoints of the Twitch API.
    
    Returns:
    
    the ChannelsResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - chat
```
public ChatResource chat()
```
    Get the ChatResource object. The ChatResource provides the functionality to access the /chat endpoints of the Twitch API.
    
    Returns:
    
    the ChatResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - games
```
public GamesResource games()
```
    Get the GamesResource object. The GamesResource provides the functionality to access the /games endpoints of the Twitch API.
    
    Returns:
    
    the GamesResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - ingests
```
public IngestsResource ingests()
```
    Get the IngestsResource object. The IngestsResource provides the functionality to access the /ingests endpoints of the Twitch API.
    
    Returns:
    
    the IngestsResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - root
```
public RootResource root()
```
    Get the RootResource object. The RootResource provides the functionality to access the root / endpoints of the Twitch API.
    
    Returns:
    
    the RootResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - search
```
public SearchResource search()
```
    Get the SearchResource object. The SearchResource provides the functionality to access the /search endpoints of the Twitch API.
    
    Returns:
    
    the SearchResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - streams
```
public StreamsResource streams()
```
    Get the StreamsResource object. The StreamsResource provides the functionality to access the /streams endpoints of the Twitch API.
    
    Returns:
    
    the StreamsResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - teams
```
public TeamsResource teams()
```
    Get the TeamsResource object. The TeamsResource provides the functionality to access the /teams endpoints of the Twitch API.
    
    Returns:
    
    the TeamsResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - users
```
public UsersResource users()
```
    Get the UsersResource object. The UsersResource provides the functionality to access the /users endpoints of the Twitch API.
    
    Returns:
    
    the UsersResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource
  - videos
```
public VideosResource videos()
```
    Get the VideosResource object. The VideosResource provides the functionality to access the /videos endpoints of the Twitch API.
    
    Returns:
    
    the VideosResource object
    
    See Also:
    
    ChannelsResource, ChatResource, GamesResource, IngestsResource, RootResource, SearchResource, StreamsResource, TeamsResource, UsersResource, VideosResource

Class Twitch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BASE_URL

DEFAULT_API_VERSION

Constructor Detail

Twitch

Twitch

Method Detail

getClientId

setClientId

auth

channels

chat

games

ingests

root

search

streams

teams

users

videos