Package io.github.bbobbogi.stream4j.chzzk

Class Chzzk

java.lang.Object

io.github.bbobbogi.stream4j.chzzk.Chzzk

public class Chzzk
extends Object

Chzzk (CHZZK) API client class.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_URL	CHZZK API URL
static String	GAME_API_URL	NAVER game API URL.
boolean	isDebug	Whether debug mode is enabled.

Method Summary

Modifier and Type	Method	Description
ChzzkChatBuilder	chat(String channelId)	Get new an instance of ChzzkChat with this Chzzk.
void	close()
ChzzkChannelInfo	getChannel(String channelId)	Get ChzzkChannelInfo by the channel id.
ChzzkChannelRules	getChannelChatRules(String channelId)	Get channel's ChzzkChannelRules by the channel id.
ChzzkChannelEmotePackData	getChannelEmotePackData(String channelId)	Gets emote pack data for the channel.
ChzzkChannelFollowingData	getFollowingStatus(String channelId)	Get following status about channel.
okhttp3.OkHttpClient	getHttpClient()	Returns the HTTP client.
@NotNull ChzzkLiveDetail	getLiveDetail(@NotNull String channelId)	Get ChzzkLiveDetail by the channel id.
@NotNull ChzzkLiveInfo	getLiveStatus(@NotNull String channelId)	Get ChzzkLiveInfo by the channel id.
ChzzkUser	getLoggedUser()	Get ChzzkUser that the Chzzk logged in.
ChzzkRecommendationChannels	getRecommendationChannels()	Get ChzzkRecommendationChannels
boolean	isLoggedIn()	Get this Chzzk logged in.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

API_URL

public static String API_URL

CHZZK API URL

GAME_API_URL

public static String GAME_API_URL

NAVER game API URL.

isDebug

public boolean isDebug

Whether debug mode is enabled.

Method Details

isLoggedIn

public boolean isLoggedIn()

Get this Chzzk logged in.

Returns:

true if logged in, otherwise false

chat

public ChzzkChatBuilder chat(String channelId)

Get new an instance of ChzzkChat with this Chzzk.

Parameters:

channelId - channel ID

Returns:

a ChzzkChatBuilder instance

getHttpClient

public okhttp3.OkHttpClient getHttpClient()

Returns the HTTP client.

Returns:

an OkHttpClient instance

close

public void close()

getChannel

public ChzzkChannelInfo getChannel(String channelId)
                            throws IOException,
ChannelNotExistsException

Get ChzzkChannelInfo by the channel id.

Parameters:

channelId - ID of ChzzkChannelInfo that to get.

Returns:

ChzzkChannelInfo to get

Throws:

IOException - if the request to API failed

ChannelNotExistsException - if the channel doesn't exists

getLiveStatus

@NotNull
public @NotNull ChzzkLiveInfo getLiveStatus(@NotNull
 @NotNull String channelId)
                                     throws IOException

Get ChzzkLiveInfo by the channel id.

Parameters:

channelId - ID of ChzzkChannelInfo

Returns:

ChzzkLiveInfo of the channel

Throws:

IOException - if the request to API failed

getLiveDetail

@NotNull
public @NotNull ChzzkLiveDetail getLiveDetail(@NotNull
 @NotNull String channelId)
                                       throws IOException

Get ChzzkLiveDetail by the channel id.

Parameters:

channelId - ID of ChzzkChannelInfo

Returns:

ChzzkLiveDetail of the channel

Throws:

IOException - if the request to API failed

getChannelChatRules

public ChzzkChannelRules getChannelChatRules(String channelId)
                                      throws IOException,
NotExistsException

Get channel's ChzzkChannelRules by the channel id.

Parameters:

channelId - ID of ChzzkChannelInfo

Returns:

ChzzkChannelRules of the channel

Throws:

IOException - if the request to API failed

NotExistsException - if the channel doesn't exists or the rules of the channel doesn't available

getChannelEmotePackData

public ChzzkChannelEmotePackData getChannelEmotePackData(String channelId)
                                                  throws IOException

Gets emote pack data for the channel.

Parameters:

channelId - channel ID

Returns:

ChzzkChannelEmotePackData emote pack data

Throws:

IOException - if the API request fails

getFollowingStatus

public ChzzkChannelFollowingData getFollowingStatus(String channelId)
                                             throws IOException,
NotLoggedInException,
ChannelNotExistsException

Get following status about channel.

Parameters:

channelId - ID of ChzzkChannelInfo to get following status

Returns:

user's ChzzkChannelFollowingData of the channel

Throws:

IOException - if the request to API failed

NotLoggedInException - if this Chzzk didn't log in

ChannelNotExistsException - if the channel doesn't exists

getRecommendationChannels

public ChzzkRecommendationChannels getRecommendationChannels()
                                                      throws IOException

Get ChzzkRecommendationChannels

Returns:

recommendation channels - ChzzkRecommendationChannels

Throws:

IOException - if the request to API failed

getLoggedUser

public ChzzkUser getLoggedUser()
                        throws IOException,
NotLoggedInException

Get ChzzkUser that the Chzzk logged in.

Returns:

ChzzkUser that current logged in

Throws:

IOException - if the request to API failed

NotLoggedInException - if this Chzzk didn't log in