core/dev.fritz2.remote/Request

Request

open class Request(baseUrl: String, headers: Map<String, String>, body: dynamic, referrer: String?, referrerPolicy: dynamic, mode: RequestMode?, credentials: RequestCredentials?, cache: RequestCache?, redirect: RequestRedirect?, integrity: String?, keepalive: Boolean?, reqWindow: Any?, authentication: Authentication?)

Represents the common fields an attributes of a given set of http requests.

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

js

fun Request(baseUrl: 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, authentication: Authentication? = null)

Functions

accept

js

fun accept(value: String): Request

adds the given Accept value to the http headers, e.

acceptJson

js

fun acceptJson(): Request

adds a header to accept JSON as response

append

js

fun append(subUrl: String): Request

appends the given subUrl to the baseUrl

arrayBuffer

js

fun arrayBuffer(content: ArrayBuffer): Request

sets the ArrayBuffer content to the request

authentication

js

fun authentication(auth: Authentication): Request

sets the general Authentication mechanism of the Request

basicAuth

js

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

adds the basic Authorization header for the given username and password

blob

js

fun blob(content: Blob): Request

sets the Blob content to the request

body

js

fun body(content: String): Request

sets the body content to the request

cache

js

fun cache(value: RequestCache): Request

sets the cache property of the Request

cacheControl

js

fun cacheControl(value: String): Request

adds the given Cache-Control value to the http headers

connect

js

suspend fun connect(subUrl: String = ""): Response

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

contentType

js

fun contentType(value: String): Request

adds the given Content-Type value to the http headers

credentials

js

fun credentials(value: RequestCredentials): Request

sets the credentials property of the Request

delete

js

open suspend fun delete(subUrl: String = ""): Response

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

equals

js

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

formData

js

fun formData(content: FormData): Request

sets the FormData content to the request

get

js

suspend fun get(subUrl: String = ""): Response

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

hashCode

js

open fun hashCode(): Int

head

js

suspend fun head(subUrl: String = ""): Response

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

header

js

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

adds the given http header to the request

integrity

js

fun integrity(value: String): Request

sets the integrity property of the Request

keepalive

js

fun keepalive(value: Boolean): Request

sets the keepalive property of the Request

options

js

suspend fun options(subUrl: String = ""): Response

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

patch

js

suspend fun patch(subUrl: String = ""): Response

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

post

js

suspend fun post(subUrl: String = ""): Response

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

put

js

suspend fun put(subUrl: String = ""): Response

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

redirect

js

fun redirect(value: RequestRedirect): Request

sets the redirect property of the Request

referrer

js

fun referrer(value: String): Request

sets the referrer property of the Request

referrerPolicy

js

fun referrerPolicy(value: dynamic): Request

sets the referrerPolicy property of the Request

requestMode

js

fun requestMode(value: RequestMode): Request

sets the requestMode property of the Request

reqWindow

js

fun reqWindow(value: Any): Request

sets the reqWindow property of the Request

toString

js

open fun toString(): String