core/dev.fritz2.remote/Request

Request

open class Request(val url: String = "", val method: String = "", val headers: Map<String, String> = emptyMap(), val body: dynamic = undefined, val referrer: String? = undefined, val referrerPolicy: dynamic = undefined, val mode: RequestMode? = undefined, val credentials: RequestCredentials? = undefined, val cache: RequestCache? = undefined, val redirect: RequestRedirect? = undefined, val integrity: String? = undefined, val keepalive: Boolean? = undefined, val reqWindow: Any? = undefined, val middlewares: List<Middleware> = emptyList())

Represents the common fields and attributes of an HTTP request.

Use it to define common headers, error-handling, base url, etc. for a specific API for example. By calling one of the executing methods like get or post a specific request is built from the template and send to the server.

Constructors

Request

constructor(url: String = "", method: String = "", headers: Map<String, String> = emptyMap(), body: dynamic = undefined, referrer: String? = undefined, referrerPolicy: dynamic = undefined, mode: RequestMode? = undefined, credentials: RequestCredentials? = undefined, cache: RequestCache? = undefined, redirect: RequestRedirect? = undefined, integrity: String? = undefined, keepalive: Boolean? = undefined, reqWindow: Any? = undefined, middlewares: List<Middleware> = emptyList())

Properties

body

val body: dynamic

cache

val cache: RequestCache?

credentials

val credentials: RequestCredentials?

headers

val headers: Map<String, String>

integrity

val integrity: String?

keepalive

val keepalive: Boolean?

method

val method: String

middlewares

val middlewares: List<Middleware>

mode

val mode: RequestMode?

redirect

val redirect: RequestRedirect?

referrer

val referrer: String?

referrerPolicy

val referrerPolicy: dynamic

reqWindow

val reqWindow: Any?

url

val url: String

Functions

fun accept(value: String): Request

adds the given Accept value to the http headers, e.g "application/pdf"

acceptJson

fun acceptJson(): Request

adds a header to accept JSON as response

append

fun append(subUrl: String): Request

appends the given subUrl to the url

arrayBuffer

fun arrayBuffer(content: ArrayBuffer): Request

sets the ArrayBuffer content to the request

basicAuth

fun basicAuth(username: String, password: String): Request

adds the basic Authorization header for the given username and password

blob

fun blob(content: Blob): Request

sets the Blob content to the request

body

fun body(content: String): Request

sets the body content to the request

cache

fun cache(value: RequestCache): Request

sets the cache property of the Request

cacheControl

fun cacheControl(value: String): Request

adds the given Cache-Control value to the http headers

connect

suspend fun connect(subUrl: String? = null): Response

issues a connect request returning a flow of it's response

contentType

fun contentType(value: String): Request

adds the given Content-Type value to the http headers

copy

open fun copy(url: String = this.url, method: String = this.method, headers: Map<String, String> = this.headers, body: dynamic = this.body, referrer: String? = this.referrer, referrerPolicy: dynamic = this.referrerPolicy, mode: RequestMode? = this.mode, credentials: RequestCredentials? = this.credentials, cache: RequestCache? = this.cache, redirect: RequestRedirect? = this.redirect, integrity: String? = this.integrity, keepalive: Boolean? = this.keepalive, reqWindow: Any? = this.reqWindow, middlewares: List<Middleware> = this.middlewares): Request

creates a copy of the Request.

credentials