penicillin/blue.starry.penicillin.core.request/ApiRequestBuilder

ApiRequestBuilder

data class ApiRequestBuilder( val client: ApiClient, val httpMethod: HttpMethod, val host: EndpointHost, val path: String)

The builder class to construct api request.

Constructors

ApiRequestBuilder

fun ApiRequestBuilder( client: ApiClient, httpMethod: HttpMethod, host: EndpointHost, path: String)

Properties

authorizationType

var authorizationType: AuthorizationType

Authorization type.

body

var body: () -> Any

Request body.

client

val client: ApiClient

Current ApiClient.

emulationModes

val emulationModes: MutableSet<EmulationMode>

Required EmulationMode.

forms

val forms: ParametersBuilder

Request form parameters.

headers

val headers: HeadersBuilder

Request headers.

host

val host: EndpointHost

Request host.

httpMethod

val httpMethod: HttpMethod

Request HTTP method.

oauthCallbackUrl

var oauthCallbackUrl: String? = null

OAuth callback url ("oauth_callback").

parameters

val parameters: ParametersBuilder

Request url parameters.

path

val path: String

Request path.

Extensions

formBody

fun ApiRequestBuilder.formBody(vararg pairs: Pair<String, Any?>, mode: EmulationMode? = null)

Creates "application/x-www-form-urlencoded" content.

header

fun ApiRequestBuilder.header( key: String, value: Any?, mode: EmulationMode? = null)

Sets a header key with value, or update existing one with value.

fun ApiRequestBuilder.header(headers: Headers, mode: EmulationMode? = null)

Adds existing Headers instance to headers.

headers

fun ApiRequestBuilder.headers(vararg pairs: Pair<String, Any?>, mode: EmulationMode? = null)

Sets header keys with value, or update existing one with value.

jsonBody

fun ApiRequestBuilder.jsonBody(vararg pairs: Pair<String, Any?>, mode: EmulationMode? = null)

fun ApiRequestBuilder.jsonBody(json: JsonObject, mode: EmulationMode? = null)

Creates "application/json" content.

multiPartBody

fun ApiRequestBuilder.multiPartBody(mode: EmulationMode? = null, block: FormBuilder.() -> Unit)

Creates "multipart/form-data" content.

parameter

fun ApiRequestBuilder.parameter( key: String, value: Any?, mode: EmulationMode? = null)

Sets a parameter key with value, or update existing one with value.

parameters

fun ApiRequestBuilder.parameters(vararg pairs: Pair<String, Any?>, mode: EmulationMode? = null)

Sets parameter keys with value, or update existing one with value.

session

val ApiRequestBuilder.session: Session

Shorthand extension to ApiClient.

url

val ApiRequestBuilder.url: String

Url string.