ApiFormRequest

An extension of ApiRequest for requests that include form parameters in the body.

Functions

Link copied to clipboard
abstract fun contentType(): String

The MIME type of the request body (e.g., application/x-www-form-urlencoded).

Link copied to clipboard
abstract fun formParameters(): Map<String, List<String>>

Returns a map of form parameters to be sent as the request body with a application/x-www-form-urlencoded content type.

Link copied to clipboard
abstract fun headers(): Map<String, List<String>>

Returns a map of HTTP headers to be included with the request.

Link copied to clipboard
abstract fun method(): ApiRequestMethod

The HTTP method to be used for the request (e.g., GET, POST).

Link copied to clipboard
open fun query(): Map<String, String>?

Returns a map of URL query parameters to be appended to the request URI.

Link copied to clipboard
abstract fun url(): String

Returns the complete URL for the request, including the scheme, host, and path.