Package io.github.jtwitch.socket.connection

Class ConnectionOption

java.lang.Object

io.github.jtwitch.socket.connection.ConnectionOption

public class ConnectionOption
extends Object

Describe options to create a socket connection through the twitch IRC socket.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getConnectionUrl()
String	getToken()
String	getUser()
void	secureConnection()	trigger the socket to connect to the SSL connection of twitch

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionOption

public ConnectionOption(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 void secureConnection()

trigger the socket to connect to the SSL connection of twitch

getConnectionUrl

public String getConnectionUrl()

Returns:

the formatted url connection

getUser

public String getUser()

Returns:

userName credential

getToken

public String getToken()

Returns:

the token to connection to the twitch IRC socket.