org.sobotics.chatexchange.chat

Class StackExchangeClient

java.lang.Object

org.sobotics.chatexchange.chat.StackExchangeClient

All Implemented Interfaces:

AutoCloseable

public class StackExchangeClient
extends Object
implements AutoCloseable

Client used to authenticate with Stack Exchange. To properly dispose of this client once created, it is expected to be closed by invoking the close() method.

Author:

Tunaki

Constructor Summary

Constructors

Constructor and Description
StackExchangeClient(String email, String password) Constructs the client with the provided credentials.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client by making the logged-in user leave all the chat rooms they joined.
boolean	getAutoCreateAccount() true, if the account for a user should automatically be created when logging in to a new site
Room	joinRoom(ChatHost host, int roomId) Joins the given room for the given chat host.
void	setAutoCreateAccount(boolean autoCreateAccount) Controls, if the account for a user should automatically be created when logging in to a new site

Methods inherited from class java.lang.Object

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

Constructor Detail

StackExchangeClient

public StackExchangeClient(String email,
                           String password)

Constructs the client with the provided credentials. Those will be the credentials used to send messages.

Parameters:

email - Email of the account to connect with.

password - Password of the account to connect with.

Method Detail

joinRoom

public Room joinRoom(ChatHost host,
                     int roomId)

Joins the given room for the given chat host.

Trying to join a room in which you are already in results in a ChatOperationException.

Parameters:

host - Host of the chat room to join.

roomId - Id of the room to join.

Returns:

Room joined.

getAutoCreateAccount

public boolean getAutoCreateAccount()

true, if the account for a user should automatically be created when logging in to a new site

setAutoCreateAccount

public void setAutoCreateAccount(boolean autoCreateAccount)

Controls, if the account for a user should automatically be created when logging in to a new site

Parameters:

autoCreateAccount - new value

close

public void close()

Closes this client by making the logged-in user leave all the chat rooms they joined.

Multiple invocations of this method has no further effect.

Specified by:

close in interface AutoCloseable