EffectsRequestBuilder class

Builds requests connected to effects from horizon.

Inheritance

Constructors

EffectsRequestBuilder(Client httpClient, Uri serverURI)

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
httpClient Client
read / write, inherited
queryParameters Map<String, String>
read / write, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
uriBuilder Uri
read / write, inherited

Methods

buildUri() Uri
inherited
cursor(String token) EffectsRequestBuilder
Sets 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.
override
encodeAsset(Asset asset) String
inherited
encodeAssets(List<Asset> assets) String
inherited
execute() Future<Page<EffectResponse>>
Build and execute request.
forAccount(String accountId) EffectsRequestBuilder
Effects request builder of a specific account given by accountId. See: Effects for Account
forLedger(int ledgerSeq) EffectsRequestBuilder
Effects request builder of a specific ledger given by ledgerSeq. See: Effects for Ledger
forOperation(int operationId) EffectsRequestBuilder
Effects request builder of a specific operation given by operationId. See: Effect for Operation
forTransaction(String transactionId) EffectsRequestBuilder
Effects request builder of a specific transaction given by transactionId. See: Effect for Transaction
limit(int number) EffectsRequestBuilder
Sets limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
order(RequestBuilderOrder direction) EffectsRequestBuilder
Sets order parameter on the request.
override
setSegments(List<String> segments) RequestBuilder
inherited
stream() Stream<EffectResponse>
Allows to stream SSE events from horizon. Certain endpoints in Horizon can be called in streaming mode using Server-Sent Events. This mode will keep the connection to horizon open and horizon will continue to return responses as ledgers close. See: Streaming
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited

Static Methods

requestExecute(Client httpClient, Uri uri) Future<Page<EffectResponse>>
Requests specific uri and returns Page of EffectResponse. This method is helpful for getting the next set of results.