BasicRequest class

An HttpRequest with a JSON body.

Inheritance

Constructors

BasicRequest(HttpRoute route, {String? body, String method = 'GET', Map<String, String> queryParameters = const {}, bool applyGlobalRateLimit = true, String? auditLogReason, bool authenticated = true, Map<String, String> headers = const {}})
Create a new BasicRequest.

Properties

applyGlobalRateLimit → bool
Whether to apply the global rate limit to this request.
finalinherited
auditLogReason → String?
The audit log reason for this request.
finalinherited
authenticated → bool
Whether to add authentication to this request when sending it.
finalinherited
body → String?
The JSON-encoded body of this request.
final
hashCode → int
The hash code for this object.
no setterinherited
headers → Map<String, String>
The headers for this request.
finalinherited
method → String
The method for this request.
finalinherited
queryParameters → Map<String, String>
The query parameters for this request.
finalinherited
rateLimitId → String
The identifier for the rate limit bucket for this request.
no setterinherited
route → HttpRoute
The route for this request.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
prepare(Nyxx client) → Request
Transform this HttpRequest into a BaseRequest to be sent.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

jsonContentTypeHeader → const Map<String, String>
The Content-Type header for JSON requests.