penicillin/blue.starry.penicillin.core.session/Session

Session

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.

Constructors

Session

fun Session( client: ApiClient, httpClient: HttpClient, credentials: Credentials, option: ApiConfig, shouldCloseHttpClient: Boolean)

Functions

open override fun close()

Closes HttpClient if shouldCloseHttpClient is true.

Properties

client

val client: ApiClient

ApiClient instance.

credentials

val credentials: Credentials

Account credentials.

httpClient

val httpClient: HttpClient

Ktor HttpClient instance.

option

val option: ApiConfig

Api configurations.

Extensions

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.