Package masecla.modrinth4j.endpoints.project

Class CheckSlugAvailability

java.lang.Object

masecla.modrinth4j.endpoints.generic.Endpoint<CheckSlugAvailability.CheckSlugAvailabilityResponse,EmptyRequest>

masecla.modrinth4j.endpoints.project.CheckSlugAvailability

public class CheckSlugAvailability
extends Endpoint<CheckSlugAvailability.CheckSlugAvailabilityResponse,EmptyRequest>

This endpoint is used to check if a slug is available.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckSlugAvailability.CheckSlugAvailabilityResponse	This class is used to represent the response.

Constructor Summary

Constructors

Constructor	Description
CheckSlugAvailability(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<EmptyRequest>	getRequestClass()	Returns the request class.
com.google.gson.reflect.TypeToken<CheckSlugAvailability.CheckSlugAvailabilityResponse>	getResponseClass()	Returns the response class.
boolean	requiresBody()	Returns if the endpoint requires a body.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

CheckSlugAvailability

public CheckSlugAvailability(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<CheckSlugAvailability.CheckSlugAvailabilityResponse,EmptyRequest>

Returns:

- The endpoint of the request.

getRequestClass

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

Returns the request class.

Specified by:

getRequestClass in class Endpoint<CheckSlugAvailability.CheckSlugAvailabilityResponse,EmptyRequest>

Returns:

- The TypeToken for the response.

getResponseClass

public com.google.gson.reflect.TypeToken<CheckSlugAvailability.CheckSlugAvailabilityResponse> getResponseClass()

Returns the response class.

Specified by:

getResponseClass in class Endpoint<CheckSlugAvailability.CheckSlugAvailabilityResponse,EmptyRequest>

Returns:

- The TypeToken for the response.

requiresBody

public boolean requiresBody()

Returns if the endpoint requires a body.

Overrides:

requiresBody in class Endpoint<CheckSlugAvailability.CheckSlugAvailabilityResponse,EmptyRequest>

Returns:

- Whether or not the request requires a body.