penicillin/blue.starry.penicillin.extensions.cursor

Package blue.starry.penicillin.extensions.cursor

Functions

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

New ApiAction with specified cursor.

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

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

Retrieves all the responses with current ApiAction.

fun JsonArrayApiAction<Status>.untilLast(count: Int = 200, vararg options: Option): Flow<Status>

Retrieves all the statuses until last from current action. This operation is sequence.

Properties

val CursorJsonObjectResponse<*, *>.hasNext: Boolean

If true, next cursor exists.

val PremiumSearchJsonObjectResponse<PremiumSearchModel>.hasNext: Boolean

Whether current search result has next.

val JsonObjectResponse<Search>.hasNext: Boolean

Whether if current search result has next page.

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.

val JsonObjectResponse<Search>.next: JsonObjectApiAction<Search>

Creates next page api action.

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.

val CursorJsonObjectResponse<*, *>.previousCursor: Long

Previous cursor value.

val JsonObjectResponse<Search>.refresh: JsonObjectApiAction<Search>

Creates refreshed page api action.

val JsonObjectResponse<Search>.refreshable: Boolean

Whether if current search result is refreshable.