PaymentsRequestBuilder class

Builds requests connected to payments.

Inheritance

Constructors

PaymentsRequestBuilder(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) PaymentsRequestBuilder
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) PaymentsRequestBuilder
Returns successful payments for a given account identified by accountId. See: Payments for Account
forLedger(int ledgerSeq) PaymentsRequestBuilder
Returns all payment-related operations in a specific ledger identified by ledgerSeq. See: Payments for Ledger
forTransaction(String transactionId) PaymentsRequestBuilder
Returns the payments of a given transaction by transactionId. See: Payments for Transaction
limit(int number) PaymentsRequestBuilder
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
order(RequestBuilderOrder direction) PaymentsRequestBuilder
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 uri and returns Page of OperationResponse. This method is helpful for getting the next set of results.