penicillin/blue.starry.penicillin.core.session

Package blue.starry.penicillin.core.session

Types

interface ApiClient : Closeable

Penicillin Api Endpoints controller.

data class Session( val client: ApiClient, val httpClient: HttpClient, val credentials: Credentials, val option: ApiConfig, shouldCloseHttpClient: Boolean) : Closeable

Penicillin Session instance. Provides HttpClient, credentials, options.

SessionBuilder

class SessionBuilder(client: ApiClient)

The builder class that corresponds with Session.

Functions

delete

fun Session.delete( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates DELETE api request.

get

fun Session.get( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates GET api request.

head

fun Session.head( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates HEAD api request.

options

fun Session.options( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates OPTIONS api request.

patch

fun Session.patch( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates PATCH api request.

post

fun Session.post( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates POST api request.

put

fun Session.put( path: String, host: EndpointHost = EndpointHost.Default, builder: ApiRequestBuilder.() -> Unit = {}): ApiRequest

Creates PUT api request.