penicillin/blue.starry.penicillin.core.request.action/ApiAction

ApiAction

interface ApiAction<R>

Represents lazy ApiRequest invoker.

Functions

abstract suspend fun execute(): R

Executes ApiAction and returns its result. This function is suspendable.

Properties

abstract val client: ApiClient

Current ApiClient instance.

abstract val request: ApiRequest

Current lazy ApiRequest instance.

Inheritors

CursorJsonObjectApiAction

JsonArrayApiAction

JsonObjectApiAction

PremiumSearchJsonObjectApiAction

Extensions

fun <R : Any> ApiAction<R>.edit(block: ApiRequestBuilder.() -> Unit): ApiAction<R>

Modifies current ApiRequestBuilder with the block.

executeWithTimeout

suspend fun <R : Any> ApiAction<R>.executeWithTimeout(timeout: Duration): R?

Awaits api execution and returns its result with timeout. This function is suspend-function.

val ApiAction<*>.session: Session

Shorthand extension to ApiClient.