stellar-sdk/com.soneso.stellar.sdk.horizon.requests/EffectsRequestBuilder

EffectsRequestBuilder

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

Builds requests connected to effects.

Effects represent specific changes that occur in the ledger as a result of successful operations.

Constructors

constructor(httpClient: HttpClient, serverUri: Url)

Functions

cursor

open override fun cursor(cursor: String): EffectsRequestBuilder

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.

execute

suspend fun execute(): Page<EffectResponse>

Build and execute request.

forAccount

fun forAccount(account: String): EffectsRequestBuilder

Builds request to GET /accounts/{account}/effects

forClaimableBalance

fun forClaimableBalance(claimableBalanceId: String): EffectsRequestBuilder

Builds request to GET /claimable_balances/{claimableBalanceId}/effects

forLedger

fun forLedger(ledgerSeq: Long): EffectsRequestBuilder

Builds request to GET /ledgers/{ledgerSeq}/effects

forLiquidityPool

fun forLiquidityPool(liquidityPoolId: String): EffectsRequestBuilder

Builds request to GET /liquidity_pools/{poolId}/effects

forOperation

fun forOperation(operationId: Long): EffectsRequestBuilder

Builds request to GET /operations/{operationId}/effects

forTransaction

fun forTransaction(transactionId: String): EffectsRequestBuilder

Builds request to GET /transactions/{transactionId}/effects

limit

open override fun limit(number: Int): EffectsRequestBuilder

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.

order

open override fun order(direction: RequestBuilder.Order): EffectsRequestBuilder

Sets the order parameter on the request.

stream

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.

EffectsRequestBuilder

See also

Constructors

Functions