StrictReceivePathsRequestBuilder class

Builds requests connected to finding paths. Paths provide information about potential path payments. A path can be used to populate the necessary fields for a path payment operation. The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books. See: Paths See: List Strict Receive Payment Paths

Inheritance

Constructors

StrictReceivePathsRequestBuilder(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 cursor) RequestBuilder
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.
inherited
destinationAmount(String amount) StrictReceivePathsRequestBuilder
Sets the destination amount. The amount of the destination asset that should be received. See: List Strict Receive Payment Paths
destinationAsset(Asset asset) StrictReceivePathsRequestBuilder
Sets the destination asset. See: List Strict Receive Payment Paths
encodeAsset(Asset asset) String
inherited
encodeAssets(List<Asset> assets) String
inherited
execute() Future<Page<PathResponse>>
limit(int number) RequestBuilder
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.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
order(RequestBuilderOrder direction) RequestBuilder
Sets order parameter on the request.
inherited
setSegments(List<String> segments) RequestBuilder
inherited
sourceAccount(String accountId) StrictReceivePathsRequestBuilder
Sets the source account. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. See: List Strict Receive Payment Paths
sourceAssets(List<Asset> sourceAssets) StrictReceivePathsRequestBuilder
Sets the source assets. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. See: List Strict Receive Payment Paths
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<PathResponse>>