OperationsRequestBuilder class

Builds requests connected to operations.

Inheritance

Constructors

OperationsRequestBuilder(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) OperationsRequestBuilder
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
execute() Future<Page<OperationResponse>>
Build and execute request.
forAccount(String accountId) OperationsRequestBuilder
Returuns the operations for a given account represented by accountId. See: Operations for Account
forLedger(int ledgerSeq) OperationsRequestBuilder
Returns the operations for a given Ledger represented by ledgerSeq. See: Operations for Ledger
forTransaction(String transactionId) OperationsRequestBuilder
Returns the operations for a given transaction represented by transactionId. See: Operations for Transaction
includeFailed(bool value) OperationsRequestBuilder
Adds a parameter defining whether to include operations of failed transactions. By default only operations of successful transactions are returned.
limit(int number) OperationsRequestBuilder
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
operation(int operationId) Future<OperationResponse>
Returns the operation for a given operationId. See: Operation Details
operationURI(Uri uri) Future<OperationResponse>
Requests specific uri and returns OperationResponse. This method is helpful for getting the links.
order(RequestBuilderOrder direction) OperationsRequestBuilder
Sets order parameter on the request.
override
setSegments(List<String> segments) RequestBuilder
inherited
stream() Stream<OperationResponse>
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: Server-Sent Events
toString() String
Returns a string representation of this object.
inherited

Operators

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

Static Methods

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