simplecoreapi/cl.franciscosolis.simplecoreapi.global.modules.networkingmodule.models/Request

Request

Represents a request builder Example usage:

Request()
   .protocol(RequestProtocol.HTTPS)
   .host("google.com")
   .path("/search")
   .parameter("q", "Hello World")
   .send()

Request("https://google.com/search?q=Hello%20World")
   .send()

Constructors

Request

constructor(url: String)

Properties

body

var body: ByteArray?

The body of the request Default: null (No body is sent)

followRedirects

var followRedirects: Boolean

Follow redirects Default: true

headers

var headers: MutableMap<String, String>

The headers of the request Default: User-Agent, Accept

host

var host: String

The host of the server

maxRedirects

var maxRedirects: Int

The maximum number of redirects to follow Default: -1

method

var method: RequestMethod

The request method Default: GET

parameters

var parameters: MutableMap<String, String>

The parameters of the request Default: Empty map

path

var path: String?

The path of the request Default: null (No path)

port

var port: Int?

The port of the server Default: null (No port)

protocol

var protocol: RequestProtocol

The protocol to use (http, https) Default: https

readTimeout

var readTimeout: Int

The timeout for reading the response in millisecond Default: 0 (No timeout)

timeout

var timeout: Int

The timeout of the request in millisecond Default: 0 (No timeout)

Functions

addHeader

fun addHeader(key: String, value: String): Request

Adds a header to the request, it doesn't override the value if the key already exists

addHeaders

fun addHeaders(headers: Map<String, String>): Request

Adds the given headers to the request, it doesn't override the value if the key already exists

addParameter

fun addParameter(key: String, value: String): Request

Adds a parameter to the request, it doesn't override the value if the key already exists

addParameters

fun addParameters(parameters: Map<String, String>): Request

Adds the given parameters to the request, it doesn't override the value if the key already exists

body

fun body(body: ByteArray): Request

fun body(body: String): Request

Sets the body of the request

delete

fun delete(): Response

Sets the request method to 'DELETE' and sends the request

equals

open operator override fun equals(other: Any?): Boolean

Checks if this request is equal to another request

followRedirects

fun followRedirects(followRedirects: Boolean): Request

Sets the follow redirects option

formBody

fun formBody(body: Map<String, String>): Request

Sets the form body of the request

get

fun get(): Response

Sets the request method to 'GET' and sends the request

hashCode

open override fun hashCode(): Int

Returns the hash code of this request

head

fun head(): Response

Sets the request method to 'HEAD' and sends the request

header

fun header(key: String, value: String): Request

Sets a header to the request, it also overrides the value if the key already exists

headers

fun headers(headers: Map<String, String>): Request

Sets the given headers to the request, it also overrides the value if the key already exists

host

fun host(host: String): Request

Sets the host of the request

jsonBody

fun jsonBody(body: JsonElement): Request

Sets the json body of the request

maxRedirects

fun maxRedirects(maxRedirects: Int): Request

Sets the maximum amount of redirects to follow

method

fun method(method: RequestMethod): Request

Sets the request method

options

fun options(): Response

Sets the request method to 'OPTIONS' and sends the request

parameter

fun parameter(key: String, value: String): Request

Sets a parameter to the request, it also overrides the value if the key already exists

parameters

fun parameters(parameters: Map<String, String>): Request

Sets the given parameters to the request, it also overrides the value if the key already exists

patch

fun patch(): Response

Sets the request method to 'PATCH' and sends the request

path

fun path(path: String): Request

Sets the path of the request

port

fun port(port: Int): Request

Sets the port of the request

post

fun post(): Response

Sets the request method to 'POST' and sends the request

protocol

fun protocol(protocol: RequestProtocol): Request

Sets the protocol of the request

put

fun put(): Response

Sets the request method to 'PUT' and sends the request

readTimeout

fun readTimeout(readTimeout: Int): Request

Sets the read timeout of the request

sendRequest

fun sendRequest(): Response

Sends the request

timeout

fun timeout(timeout: Int): Request

Sets the timeout of the request

toString

open override fun toString(): String

toUrlString

fun toUrlString(): String

Turns this request information (protocol, host, port, path and params) into a url string