TwitchClient (Twitch4J (v0.11.0))

java.lang.Object
- me.philippheuer.twitch4j.TwitchClient

```
public class TwitchClient
extends java.lang.Object
```
TwitchClient is the core class for all api operations.
The TwitchClient class is the central component, that grants access to the various rest endpoints, the twitch chat interface and the client related services. (CredentialManager/CommandHandler/...)

Since:

1.0

Field Summary

Fields
Modifier and Type Field and Description

int twitchEndpointVersion
Twitch API Version

Fields
Modifier and Type	Field and Description
`int`	`twitchEndpointVersion` Twitch API Version

Constructor Summary

Constructors
Constructor and Description
`TwitchClient(java.lang.String clientId, java.lang.String clientSecret)` Class Constructor - Creates a new TwitchClient Instance for the provided app.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`connect()` Connect to other related services.
`void`	`disconnect()` Disconnect from other related services.
`ChannelEndpoint`	`getChannelEndpoint()` Returns an a new ChannelEndpoint instance - identifying the channel by the channel id.
`ChannelFeedEndpoint`	`getChannelFeedEndpoint()` Deprecated. Twitch removes Channel Feeds and Pulse. More info here.
`ChatEndpoint`	`getChatEndpoint()` Returns a new ChatEndpoint instance.
`CommunityEndpoint`	`getCommunityEndpoint()` Returns an a new CommunityEndpoint instance.
`GameEndpoint`	`getGameEndpoint()` Returns an a new GameEndpoint instance.
`IngestEndpoint`	`getIngestEndpoint()` Returns an a new IngestEndpoint instance.
`KrakenEndpoint`	`getKrakenEndpoint()` Returns an a new KrakenEndpoint instance.
`SearchEndpoint`	`getSearchEndpoint()` Returns an a new SearchEndpoint instance.
`StreamEndpoint`	`getStreamEndpoint()` Returns an a new StreamEndpoint instance.
`TeamEndpoint`	`getTeamEndpoint()` Returns an a new TeamEndpoint instance.
`TMIEndpoint`	`getTMIEndpoint()` Returns an a new TMIEndpoint instance.
`UnofficialEndpoint`	`getUnofficialEndpoint()` Returns an a new UnofficialEndpoint instance.
`UserEndpoint`	`getUserEndpoint()` Returns an a new UserEndpoint instance.
`VideoEndpoint`	`getVideoEndpoint()` Returns an a new VideoEndpoint instance.
`void`	`reconnect()` Reconnect to other related services.

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

- Field Detail
  - twitchEndpointVersion
```
public final int twitchEndpointVersion
```
    Twitch API Version
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TwitchClient
```
public TwitchClient(java.lang.String clientId,
                    java.lang.String clientSecret)
```
    Class Constructor - Creates a new TwitchClient Instance for the provided app.
    This will also initialize the rest interceptors, that provide oauth tokens/get/post parameters on the fly to easily build the rest requests.
    
    Parameters:
    
    clientId - Twitch Application - Id
    
    clientSecret - Twitch Application - Secret
- Method Detail
  - connect
```
public void connect()
```
    Connect to other related services.
    This methods opens the connection to the twitch irc server and the pubsub endpoint. Connect needs to be called after initalizing the CredentialManager.
  - disconnect
```
public void disconnect()
```
    Disconnect from other related services.
    This methods closes the connection to the twitch irc server and the pubsub endpoint.
  - reconnect
```
public void reconnect()
```
    Reconnect to other related services.
    This methods reconnects to the twitch irc server and the pubsub endpoint.
  - getKrakenEndpoint
```
public KrakenEndpoint getKrakenEndpoint()
```
    Returns an a new KrakenEndpoint instance.
    The Kraken Endpoint is the root of the twitch api. Querying the Kraken Endpoint gives information about the currently used token.
    
    Returns:
    
    a new instance of KrakenEndpoint
  - getChannelFeedEndpoint
```
@Deprecated
public ChannelFeedEndpoint getChannelFeedEndpoint()
```
    Deprecated. Twitch removes Channel Feeds and Pulse. More info here.
    
    Returns an a new ChannelFeedEndpoint instance.
    
    Returns:
    
    a new instance of ChannelFeedEndpoint
  - getChannelEndpoint
```
public ChannelEndpoint getChannelEndpoint()
```
    Returns an a new ChannelEndpoint instance - identifying the channel by the channel id.
    The Channel Endpoint instances allow you the query or set data for a specific channel, therefore you need to provide information to identify a unique channel.
    
    Returns:
    
    a new instance of ChannelEndpoint
    
    See Also:
    
    Channel
  - getGameEndpoint
```
public GameEndpoint getGameEndpoint()
```
    Returns an a new GameEndpoint instance.
    The Game Endpoint instance allows you to access information about the all available games on twitch.
    
    Returns:
    
    a new instance of GameEndpoint
    
    See Also:
    
    Game
  - getStreamEndpoint
```
public StreamEndpoint getStreamEndpoint()
```
    Returns an a new StreamEndpoint instance.
    The Stream Endpoint provides information about all current live streams and related metadata. For more information about the data, check out the Stream model.
    
    Returns:
    
    a new instance of StreamEndpoint
    
    See Also:
    
    Stream
  - getUserEndpoint
```
public UserEndpoint getUserEndpoint()
```
    Returns an a new UserEndpoint instance.
    The User Endpoint provides access to user-related informations and actions. For more information about the available methods, check out the UserEndpoint.
    
    Returns:
    
    a new instance of UserEndpoint
    
    See Also:
    
    User
  - getCommunityEndpoint
```
public CommunityEndpoint getCommunityEndpoint()
```
    Returns an a new CommunityEndpoint instance.
    The Community Endpoint allows you to fetch information or manage your communities using the api. The community methods usually return a Community model.
    
    Returns:
    
    a new instance of CommunityEndpoint
    
    See Also:
    
    Community
  - getIngestEndpoint
```
public IngestEndpoint getIngestEndpoint()
```
    Returns an a new IngestEndpoint instance.
    The Ingest Endpoint allows you to fetch a list of the twitch ingest servers.
    
    Returns:
    
    a new instance of IngestEndpoint
    
    See Also:
    
    Ingest
  - getSearchEndpoint
```
public SearchEndpoint getSearchEndpoint()
```
    Returns an a new SearchEndpoint instance.
    The Search Endpoint allows you to search for Channels, Games or Streams.
    
    Returns:
    
    a new instance of SearchEndpoint
    
    See Also:
    
    Stream, Game, Channel
  - getTeamEndpoint
```
public TeamEndpoint getTeamEndpoint()
```
    Returns an a new TeamEndpoint instance.
    The Team Endpoint provides a list of all teams and detailed information about single teams.
    
    Returns:
    
    a new instance of TeamEndpoint
    
    See Also:
    
    Team
  - getVideoEndpoint
```
public VideoEndpoint getVideoEndpoint()
```
    Returns an a new VideoEndpoint instance.
    The Video Endpoint provides access to videos that twitch users recoded.
    
    Returns:
    
    a new instance of VideoEndpoint
    
    See Also:
    
    Video
  - getTMIEndpoint
```
public TMIEndpoint getTMIEndpoint()
```
    Returns an a new TMIEndpoint instance.
    The Twitch Messaging Service (TMI) is the chat service used in twitch. This is an unofficial api and can break at any point without any notice.
    
    Returns:
    
    a new instance of TMIEndpoint
  - getUnofficialEndpoint
```
public UnofficialEndpoint getUnofficialEndpoint()
```
    Returns an a new UnofficialEndpoint instance.
    
    Returns:
    
    a new instance of UnofficialEndpoint
  - getChatEndpoint
```
public ChatEndpoint getChatEndpoint()
```
    Returns a new ChatEndpoint instance.
    
    Returns:
    
    a new instance of ChatEndpoint

Class TwitchClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

twitchEndpointVersion

Constructor Detail

TwitchClient

Method Detail

connect

disconnect

reconnect

getKrakenEndpoint

getChannelFeedEndpoint

getChannelEndpoint

getGameEndpoint

getStreamEndpoint

getUserEndpoint

getCommunityEndpoint

getIngestEndpoint

getSearchEndpoint

getTeamEndpoint

getVideoEndpoint

getTMIEndpoint

getUnofficialEndpoint

getChatEndpoint