blue.starry.penicillin.core.request

class ApiRequest(val client: ApiClient, val builder: ApiRequestBuilder)

Represents api request methods.

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

The builder class to construct api request.

EndpointHost

data class EndpointHost( val domain: String, val domainForSigning: String? = null, val protocol: URLProtocol = URLProtocol.HTTPS, val port: Int = protocol.defaultPort)

Represents endpoint host.

EnumRequestParameter

interface EnumRequestParameter

Represents an enum class can be serialized with "value" property.

append

fun FormBuilder.append(vararg pairs: Pair<String, Any?>)

Appends pairs.

formBody

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

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

header

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

Adds existing Headers instance to headers.

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

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

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.

JsonObjectContent

fun JsonObjectContent(json: JsonObject): TextContent

The OutgoingContent.WriteChannelContent which provides "application/json".

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.

url

val ApiRequestBuilder.url: String

Url string.

Package blue.starry.penicillin.core.request

Types

Functions

Properties