penicillin/blue.starry.penicillin.core.response/CursorJsonObjectResponse

CursorJsonObjectResponse

data class CursorJsonObjectResponse<M : PenicillinCursorModel<T>, T : Any>( val client: ApiClient, val result: M, val request: HttpRequest, val response: HttpResponse, val content: String, val action: ApiAction<CursorJsonObjectResponse<M, T>>) : ApiResponse<CursorJsonObjectResponse<M, T>> , JsonResponse<M, JsonObject> , CompletedResponse

The ApiResponse that provides parsed json object with json model. This class supports cursor api operation.

Constructors

fun <M : PenicillinCursorModel<T>, T : Any> CursorJsonObjectResponse( client: ApiClient, result: M, request: HttpRequest, response: HttpResponse, content: String, action: ApiAction<CursorJsonObjectResponse<M, T>>)

Properties

action

open override val action: ApiAction<CursorJsonObjectResponse<M, T>>

Executed ApiAction instance.

client

open override val client: ApiClient

Current ApiClient instance.

content

open override val content: String

Text response.

json

open override val json: JsonObject

Json element.

request

open override val request: HttpRequest

Http request object.

response

open override val response: HttpResponse

Http response object.

result

val result: M

Result of response.

Extensions

byCursor

fun <M : PenicillinCursorModel<T>, T : Any> CursorJsonObjectResponse<M, T>.byCursor(cursor: Long, vararg options: Option): CursorJsonObjectApiAction<M, T>

New ApiAction with specified cursor.

hasNext

val CursorJsonObjectResponse<*, *>.hasNext: Boolean

If true, next cursor exists.

hasPrevious

val CursorJsonObjectResponse<*, *>.hasPrevious: Boolean

If true, previous cursor exists.

val <M : PenicillinCursorModel<T>, T : Any> CursorJsonObjectResponse<M, T>.next: CursorJsonObjectApiAction<M, T>

New ApiAction with next cursor.

nextCursor

val CursorJsonObjectResponse<*, *>.nextCursor: Long

Next cursor value.

val <M : PenicillinCursorModel<T>, T : Any> CursorJsonObjectResponse<M, T>.previous: CursorJsonObjectApiAction<M, T>

New ApiAction with previous cursor.

previousCursor

val CursorJsonObjectResponse<*, *>.previousCursor: Long

Previous cursor value.

untilLast

fun <M : PenicillinCursorModel<T>, T : Any> CursorJsonObjectResponse<M, T>.untilLast(vararg options: Option): Flow<T>

Retrieves all the responses with current ApiAction.