OperationsRequestBuilder class
Builds requests connected to operations. Operations are objects that represent a desired change to the ledger: payments, offers to exchange currency, changes made to account options, etc. Operations are submitted to the Stellar network grouped in a Transaction. See: Operations
- Inheritance
-
- Object
- RequestBuilder
- OperationsRequestBuilder
Constructors
- OperationsRequestBuilder(Client httpClient, Uri serverURI)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpClient ↔ Client
-
getter/setter pairinherited
-
queryParameters
↔ Map<
String, String> -
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uriBuilder ↔ Uri
-
getter/setter pairinherited
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
-
encodeAssets(
List< Asset> assets) → String -
inherited
-
execute(
) → Future< Page< OperationResponse> > - Build and execute request.
-
forAccount(
String accountId) → OperationsRequestBuilder -
Returns successful operations for a given account identified by
accountId. See: Operations for Account -
forClaimableBalance(
String claimableBalanceId) → OperationsRequestBuilder -
Returns successful operations for a given claimable balance by
claimableBalanceId. See: Operations for claimable balance -
forLedger(
int ledgerSeq) → OperationsRequestBuilder -
Returns successful operations in a specific ledger identified by
ledgerSeq. See: Operations for Ledger -
forLiquidityPool(
String liquidityPoolId) → OperationsRequestBuilder -
forTransaction(
String transactionId) → OperationsRequestBuilder -
Returns successful operations for a specific transaction identiefied 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 nonexistent method or property is accessed.
inherited
-
operation(
int operationId) → Future< OperationResponse> -
Provides information about a specific operation given by
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: 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< OperationResponse> > -
Requests specific
uriand returns Page of OperationResponse. This method is helpful for getting the next set of results.