Package com.treescrub.spedran.requests.builders.user

Class UsersRequest

java.lang.Object

com.treescrub.spedran.ResourceCollectionRequest<User>

com.treescrub.spedran.requests.builders.user.UsersRequest

public class UsersRequest
extends ResourceCollectionRequest<User>

A request builder to get all Users matching the set filters.

Constructor Summary

Constructors

Constructor	Description
UsersRequest()

Method Summary

Modifier and Type	Method	Description
UsersRequest	hitbox(String hitbox)	Searches for a single User with the given Hitbox username.
UsersRequest	lookup(String name)	Searches for a single User with the given name.
UsersRequest	name(String name)	Searches for Users with a name that contains the given string.
UsersRequest	sortByInternationalName()	Sorts the results alphanumerically by the international name of the users.
UsersRequest	sortByJapaneseName()	Sorts the results alphanumerically by the Japanese name of the users.
UsersRequest	sortByRole()	Sorts the results by the user's role on SRC.
UsersRequest	sortBySignupDate()	Sorts the results by the user's signup time.
UsersRequest	sortDirection(SortDirection direction)	Sets the direction (ascending or descending) of the sorting.
UsersRequest	speedrunsLive(String speedrunsLive)	Searches for a single User with the given SpeedRunsLive username.
UsersRequest	twitch(String twitch)	Searches for a single User with the given Twitch username.
UsersRequest	twitter(String twitter)	Searches for a single User with the given Twitter handle.

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest

complete

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersRequest

public UsersRequest()

Method Detail

lookup

public UsersRequest lookup(String name)

Searches for a single User with the given name.
Search is case-insensitive and must match exactly with an existing user.

Parameters:

name - the name to search for

Returns:

this UsersRequest builder

name

public UsersRequest name(String name)

Searches for Users with a name that contains the given string.
Search is case-insensitive.

Parameters:

name - the substring to search for, must be at least 3 characters long

Returns:

this UsersRequest builder

twitch

public UsersRequest twitch(String twitch)

Searches for a single User with the given Twitch username.
Search is case-insensitive and must match exactly with a linked Twitch account name.

Parameters:

twitch - the Twitch username

Returns:

this UsersRequest builder

hitbox

public UsersRequest hitbox(String hitbox)

Searches for a single User with the given Hitbox username.
Search is case-insensitive and must match exactly with a linked Hitbox account name.

Parameters:

hitbox - the Hitbox username

Returns:

this UsersRequest builder

twitter

public UsersRequest twitter(String twitter)

Searches for a single User with the given Twitter handle.
Search is case-insensitive and must match exactly with a linked Twitch account name.

Parameters:

twitter - the Twitter handle

Returns:

this UsersRequest builder

speedrunsLive

public UsersRequest speedrunsLive(String speedrunsLive)

Searches for a single User with the given SpeedRunsLive username.
Search is case-insensitive and must match exactly with a linked SpeedRunsLive account name.

Parameters:

speedrunsLive - the SpeedRunsLive username

Returns:

this UsersRequest builder

sortByInternationalName

public UsersRequest sortByInternationalName()

Sorts the results alphanumerically by the international name of the users.

Returns:

this UsersRequest builder

sortByJapaneseName

public UsersRequest sortByJapaneseName()

Sorts the results alphanumerically by the Japanese name of the users.

Returns:

this UsersRequest builder

sortBySignupDate

public UsersRequest sortBySignupDate()

Sorts the results by the user's signup time.

Returns:

this UsersRequest builder

sortByRole

public UsersRequest sortByRole()

Sorts the results by the user's role on SRC.

The order is determined by privilege/access level, not alphanumerically.

Returns:

this UsersRequest builder

sortDirection

public UsersRequest sortDirection(SortDirection direction)

Sets the direction (ascending or descending) of the sorting.

Parameters:

direction - the sort direction

Returns:

this UsersRequest builder