net.wildfyre.api

Class WildFyre

java.lang.Object

net.wildfyre.api.WildFyre

public class WildFyre
extends java.lang.Object

The primary means of interaction with the API.

Constructor Summary

Constructors

Constructor and Description
WildFyre()

Method Summary

Modifier and Type	Method and Description
static LoggedUser	connect(java.lang.String token) Connects to the server with the specified token.
static LoggedUser	connect(java.lang.String username, java.lang.String password) Connects to the server with the specified user.
static void	disconnect() Disconnects the API from the currently-logged-in user.
static LoggedUser	getMe() Returns the logged-in user of the API, that is, the user corresponding to the saved-token.
static boolean	isConnected() Is the user connected?

Methods inherited from class java.lang.Object

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

Constructor Detail

WildFyre

public WildFyre()

Method Detail

connect

public static LoggedUser connect(java.lang.String username,
                                 java.lang.String password)
                          throws Request.CantConnectException

Connects to the server with the specified user. This method is NOT executed concurrently, because no action can be taken by the client while the cache is empty anyway.

Parameters:

username - the user's username

password - the user's password

Returns:

Your own user. See also getMe().

Throws:

Request.CantConnectException

connect

public static LoggedUser connect(java.lang.String token)
                          throws Request.CantConnectException

Connects to the server with the specified token. This method is NOT executed concurrently, because no action can be taken by the client while the cache is empty anyway.

Parameters:

token - the token

Returns:

Your own user. See also getMe().

Throws:

Request.CantConnectException

disconnect

public static void disconnect()

Disconnects the API from the currently-logged-in user.

getMe

public static LoggedUser getMe()

Returns the logged-in user of the API, that is, the user corresponding to the saved-token.

Returns:

The logged-in user.

isConnected

public static boolean isConnected()

Is the user connected?

Note that this method does not specify whether the connection is still valid, it only specifies whether either methods connect(token) or connect(username, password) where successful.

Returns:

true if the user is registered.