OperationsRequestBuilder

class OperationsRequestBuilder(httpClient: HttpClient, serverUri: Url) : RequestBuilder

Builds requests connected to operations.

See also

Constructors

Link copied to clipboard
constructor(httpClient: HttpClient, serverUri: Url)

Functions

Link copied to clipboard
open override fun cursor(cursor: String): OperationsRequestBuilder

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

Build and execute request.

Link copied to clipboard

Builds request to GET /accounts/{account}/operations Returns all operations for a specific account.

Link copied to clipboard

Builds request to GET /claimable_balances/{claimable_balance_id}/operations Returns all operations for a specific claimable balance.

Link copied to clipboard

Builds request to GET /ledgers/{ledgerSeq}/operations Returns all operations in a specific ledger.

Link copied to clipboard

Builds request to GET /liquidity_pools/{liquidity_pool_id}/operations Returns all operations for a specific liquidity pool.

Link copied to clipboard

Builds request to GET /transactions/{transactionId}/operations Returns all operations in a specific transaction.

Link copied to clipboard

Adds a parameter defining whether to include operations of failed transactions. By default only operations of successful transactions are returned.

Link copied to clipboard

Adds a parameter defining whether to include transactions in the response. By default transaction data is not included.

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

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
suspend fun operation(operationId: Long): OperationResponse

Requests a specific operation by ID.

Link copied to clipboard
open override fun order(direction: RequestBuilder.Order): OperationsRequestBuilder

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.