Package io.github.jtwitch.socket

Class TwitchBot

java.lang.Object

io.github.jtwitch.socket.TwitchBot

public class TwitchBot
extends Object

Represent a twitch bot before it is connected.

Constructor Summary

Constructors

Constructor	Description
TwitchBot(String botAccount, String token)	The only constructor.

Method Summary

Modifier and Type	Method	Description
ConnectedTwitchBot	connect()	connect the bot to the twitch socket.
TwitchBot	secureConnection()	trigger the socket to connect to the SSL connection of twitch
TwitchBot	withActionOnMessage(MessageAction messageAction)	add an action triggered by a message
TwitchBot	withScheduleAction(int periodInSecond, ScheduleAction.Action action)	add an action

Methods inherited from class java.lang.Object

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

Constructor Details

TwitchBot

public TwitchBot(String botAccount,
 String token)

The only constructor.

Parameters:

botAccount - the name of the bot account. for instance, if your bot account is nightbot, the botAccount is nightbot

token - the connection token the you generate here

Method Details

secureConnection

public TwitchBot secureConnection()

trigger the socket to connect to the SSL connection of twitch

Returns:

the TwitchBot builder with a secure connection.

withActionOnMessage

public TwitchBot withActionOnMessage(MessageAction messageAction)

add an action triggered by a message

Parameters:

messageAction - action triggered by a message

Returns:

the TwitchBot builder

withScheduleAction

public TwitchBot withScheduleAction(int periodInSecond,
 ScheduleAction.Action action)

add an action

Parameters:

periodInSecond - time when you trigger an action

action - the schedule action

Returns:

the TwitchBot builder

connect

public ConnectedTwitchBot connect()
                           throws InterruptedException,
URISyntaxException

connect the bot to the twitch socket.

Returns:

the ConnectedTwitchBot with all de configured action.

Throws:

InterruptedException - if the socket connection stop

URISyntaxException - if the socket change address