discord4j.rest.request

Class DiscordRequest<T>

java.lang.Object

discord4j.rest.request.DiscordRequest<T>

Type Parameters:

T - The response type.

public class DiscordRequest<T>
extends Object

Template encoding all of the needed information to make an HTTP request to Discord.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
DiscordRequest(Route<T> route, Object... uriVars) Create a new DiscordRequest template based on a Route and its compiled URI.

Method Summary

Modifier and Type	Method and Description
DiscordRequest<T>	body(Object body) Set the given synchronous Object as the body for the request.
Mono<T>	exchange(Router router) Exchange this request through the given Router.
Object	getBody() Return the body of this request, if present.
String	getCompleteUri() Return the compiled URI of this request.
Map<String,Set<String>>	getHeaders() Return the request headers, if present.
Map<String,Object>	getQueryParams() Return the query parameters saved in this request, if present.
Route<T>	getRoute() Return the API endpoint targeted by this request.
DiscordRequest<T>	header(String key, String value) Adds the given key and value to the headers of this request.
DiscordRequest<T>	optionalHeader(String key, String value) Adds the given key and value to the headers of this request if and only if value is not null.
DiscordRequest<T>	query(Map<String,Object> params) Adds the given names and values as request query parameters.
DiscordRequest<T>	query(String key, Object value) Add the given name and value as a request query parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscordRequest

public DiscordRequest(Route<T> route,
                      Object... uriVars)

Create a new DiscordRequest template based on a Route and its compiled URI.

Parameters:

route - the API resource targeted by this request

uriVars - the values to expand each template parameter

Method Detail

getRoute

public Route<T> getRoute()

Return the API endpoint targeted by this request.

Returns:

the Route of this DiscordRequest

getCompleteUri

public String getCompleteUri()

Return the compiled URI of this request.

Returns:

the compiled URI, containing the actual path variables

getBody

@Nullable
public Object getBody()

Return the body of this request, if present.

Returns:

the body of this request, or null if this request carries no HTTP body

getQueryParams

@Nullable
public Map<String,Object> getQueryParams()

Return the query parameters saved in this request, if present.

Returns:

a map representing query parameters, or null if none are defined

getHeaders

@Nullable
public Map<String,Set<String>> getHeaders()

Return the request headers, if present.

Returns:

a map representing HTTP headers, or null if none are defined

body

public DiscordRequest<T> body(Object body)

Set the given synchronous Object as the body for the request.

Parameters:

body - the object to set as request body

Returns:

this request

query

public DiscordRequest<T> query(String key,
                               Object value)

Add the given name and value as a request query parameter.

Parameters:

key - the query parameter name

value - the query parameter value

Returns:

this request

query

public DiscordRequest<T> query(Map<String,Object> params)

Adds the given names and values as request query parameters.

Parameters:

params - a map of query parameter names to values

Returns:

this request

header

public DiscordRequest<T> header(String key,
                                String value)

Adds the given key and value to the headers of this request.

Parameters:

key - the header key

value - the header value

Returns:

this request

optionalHeader

public DiscordRequest<T> optionalHeader(String key,
                                        @Nullable
                                        String value)

Adds the given key and value to the headers of this request if and only if value is not null.

Parameters:

key - the header key

value - the header value

Returns:

this request

exchange

public Mono<T> exchange(Router router)

Exchange this request through the given Router.

Parameters:

router - a router that performs this request

Returns:

the result of this request

toString

public String toString()

Overrides:

toString in class Object