A B E G H I N P R S T U V X

A

AllenAPI - Class in xyz.lamergameryt.allen4j

The AllenAPI class is the main class of Allen's API Wrapper.

AllenAPI(String, String) - Constructor for class xyz.lamergameryt.allen4j.AllenAPI

APIEndpoint - Enum in xyz.lamergameryt.allen4j

The APIEndpoint enum contains all the endpoints that the Allen API has.

B

build(String, int) - Static method in class xyz.lamergameryt.allen4j.namesearch.NameSearchRequest

Builds an instance of the NameSearchRequest class.

build() - Static method in class xyz.lamergameryt.allen4j.profile.SelfProfileRequest

E

endpoint - Variable in class xyz.lamergameryt.allen4j.Request

The endpoint of the request that will be accessed.

G

getBatchId() - Method in class xyz.lamergameryt.allen4j.Student

getCourseName() - Method in class xyz.lamergameryt.allen4j.Student

getEndpoint() - Method in class xyz.lamergameryt.allen4j.Request

Returns the API endpoint of the request.

getFormNumber() - Method in class xyz.lamergameryt.allen4j.Student

getFromJSONObject(JSONObject) - Static method in class xyz.lamergameryt.allen4j.Student

Get an instance of the Student class.

getFullName() - Method in class xyz.lamergameryt.allen4j.Student

getJSONFromEntity(HttpEntity) - Static method in class xyz.lamergameryt.allen4j.Utils

Read the response received from the API and converts it into a JSONObject object.

getParams() - Method in class xyz.lamergameryt.allen4j.Request

Get the parameters to include with the request.

getPic() - Method in class xyz.lamergameryt.allen4j.Student

getProfile() - Method in class xyz.lamergameryt.allen4j.profile.SelfProfileResponse

getRequest(String, HashMap<String, String>, String) - Static method in class xyz.lamergameryt.allen4j.Utils

Creates an instance of HttpGet containing the endpoint, the parameters and user authorization.

getSelfProfile(SelfProfileRequest) - Method in class xyz.lamergameryt.allen4j.AllenAPI

Get your own profile

getStudents() - Method in class xyz.lamergameryt.allen4j.namesearch.NameSearchResponse

getTotalResults() - Method in class xyz.lamergameryt.allen4j.namesearch.NameSearchResponse

getUserType() - Method in class xyz.lamergameryt.allen4j.Student

H

hasFormNumber() - Method in class xyz.lamergameryt.allen4j.Student

Check if the student's email is his form number of not.

I

isStudent() - Method in class xyz.lamergameryt.allen4j.Student

Check if the student received is actually student or some other faculty member.

N

NameSearchRequest - Class in xyz.lamergameryt.allen4j.namesearch

The NameSearchRequest class is used to perform a request that searches for a student based on his name.

NameSearchResponse - Class in xyz.lamergameryt.allen4j.namesearch

The response received after searching for a student by his name.

NameSearchResponse(JSONObject) - Constructor for class xyz.lamergameryt.allen4j.namesearch.NameSearchResponse

Parse the json response received from the server.

P

params - Variable in class xyz.lamergameryt.allen4j.Request

The parameters used with the request.

R

Request - Class in xyz.lamergameryt.allen4j

Request() - Constructor for class xyz.lamergameryt.allen4j.Request

S

searchByName(NameSearchRequest) - Method in class xyz.lamergameryt.allen4j.AllenAPI

Search for a user by name

SelfProfileRequest - Class in xyz.lamergameryt.allen4j.profile

SelfProfileResponse - Class in xyz.lamergameryt.allen4j.profile

SelfProfileResponse(JSONObject) - Constructor for class xyz.lamergameryt.allen4j.profile.SelfProfileResponse

Parses the json response received from the server.

Student - Class in xyz.lamergameryt.allen4j

The Student class contains most of the data of the student which is sent by Allen's API.

T

toString() - Method in enum xyz.lamergameryt.allen4j.APIEndpoint

Returns the enum, converted to api endpoint url.

U

Utils - Class in xyz.lamergameryt.allen4j

Utils() - Constructor for class xyz.lamergameryt.allen4j.Utils

V

valueOf(String) - Static method in enum xyz.lamergameryt.allen4j.APIEndpoint

Returns the enum constant of this type with the specified name.

values() - Static method in enum xyz.lamergameryt.allen4j.APIEndpoint

Returns an array containing the constants of this enum type, in the order they are declared.

X

xyz.lamergameryt.allen4j - package xyz.lamergameryt.allen4j

xyz.lamergameryt.allen4j.namesearch - package xyz.lamergameryt.allen4j.namesearch

xyz.lamergameryt.allen4j.profile - package xyz.lamergameryt.allen4j.profile

A B E G H I N P R S T U V X