Constructors

Link copied to clipboard
constructor(httpClient: HttpClient, serverUri: Url, defaultSegment: String? = null)

Types

Link copied to clipboard

Represents possible order parameter values.

Functions

Link copied to clipboard
open fun cursor(cursor: String): RequestBuilder

Sets the cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

Link copied to clipboard
open fun limit(number: Int): RequestBuilder

Sets the limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

Link copied to clipboard

Sets the order parameter on the request.

Link copied to clipboard
fun <T : Response> stream(serializer: KSerializer<T>, listener: EventListener<T>, reconnectTimeout: Duration = SSEStream.DEFAULT_RECONNECT_TIMEOUT): SSEStream<T>

Creates a Server-Sent Events (SSE) stream for this request. The stream will automatically reconnect on connection loss and resume from the last received event.