Package masecla.modrinth4j.endpoints.user

Class GetUsers

java.lang.Object

masecla.modrinth4j.endpoints.generic.Endpoint<List<ModrinthUser>,GetUsers.GetUsersRequest>

masecla.modrinth4j.endpoints.user.GetUsers

public class GetUsers
extends Endpoint<List<ModrinthUser>,GetUsers.GetUsersRequest>

This endpoint is used to get a list of users.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetUsers.GetUsersRequest	This class is used to represent the request.

Constructor Summary

Constructors

Constructor	Description
GetUsers(HttpClient client, com.google.gson.Gson gson)	Creates a new instance of the endpoint.

Method Summary

Modifier and Type	Method	Description
String	getEndpoint()	Returns the endpoint.
com.google.gson.reflect.TypeToken<GetUsers.GetUsersRequest>	getRequestClass()	Returns the request class.
com.google.gson.reflect.TypeToken<List<ModrinthUser>>	getResponseClass()	Returns the response class.
boolean	isJsonBody()	Returns whether or not the request is a json body.

Methods inherited from class masecla.modrinth4j.endpoints.generic.Endpoint

checkBodyForErrors, executeRequest, getMethod, getReplacedUrl, readFile, readStream, requiresBody, sendRequest, sendRequest

Methods inherited from class java.lang.Object

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

Constructor Details

GetUsers

public GetUsers(HttpClient client,
 com.google.gson.Gson gson)

Creates a new instance of the endpoint.

Parameters:

client - The client to use.

gson - The gson instance to use.

Method Details

getEndpoint

public String getEndpoint()

Returns the endpoint.

Specified by:

getEndpoint in class Endpoint<List<ModrinthUser>,GetUsers.GetUsersRequest>

Returns:

- The endpoint of the request.

getRequestClass

public com.google.gson.reflect.TypeToken<GetUsers.GetUsersRequest> getRequestClass()

Returns the request class.

Specified by:

getRequestClass in class Endpoint<List<ModrinthUser>,GetUsers.GetUsersRequest>

Returns:

- The TypeToken for the response.

getResponseClass

public com.google.gson.reflect.TypeToken<List<ModrinthUser>> getResponseClass()

Returns the response class.

Specified by:

getResponseClass in class Endpoint<List<ModrinthUser>,GetUsers.GetUsersRequest>

Returns:

- The TypeToken for the response.

isJsonBody

public boolean isJsonBody()

Returns whether or not the request is a json body.

Overrides:

isJsonBody in class Endpoint<List<ModrinthUser>,GetUsers.GetUsersRequest>

Returns:

- Whether or not the request body should be JSON.