xyz.lamergameryt.allen4j

Class AllenAPI

java.lang.Object

xyz.lamergameryt.allen4j.AllenAPI

public class AllenAPI
extends Object

The AllenAPI class is the main class of Allen's API Wrapper. Used to perform most of the requests.

Constructor Summary

Constructors

Constructor and Description
AllenAPI(String baseURL, String authorization)

Method Summary

Modifier and Type	Method and Description
SelfProfileResponse	getSelfProfile(SelfProfileRequest request) Get your own profile
NameSearchResponse	searchByName(NameSearchRequest request) Search for a user by name

Methods inherited from class java.lang.Object

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

Constructor Detail

AllenAPI

public AllenAPI(String baseURL,
                String authorization)

Parameters:

baseURL - The url of Allen's API.

authorization - The authorization token used to send requests with.

Method Detail

searchByName

public NameSearchResponse searchByName(NameSearchRequest request)
                                throws IOException,
                                       URISyntaxException

Search for a user by name

Parameters:

request - The request used to search for a user. Created by NameSearchRequest.build(String, int) function.

Returns:

Instance of NameSearchResponse

Throws:

IOException - The connection could not be established.

URISyntaxException - This will most likely be thrown when the baseURL is invalid.

getSelfProfile

public SelfProfileResponse getSelfProfile(SelfProfileRequest request)
                                   throws IOException,
                                          URISyntaxException

Get your own profile

Parameters:

request - The request used to get your own profile. Created by SelfProfileRequest.build() function.

Returns:

Instance of SelfProfileResponse

Throws:

IOException - The connection could not be established.

URISyntaxException - This will most likely be thrown when the baseURL is invalid.