StrictSendPathsRequestBuilder 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 to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. See: Paths See: List Strict Send Payment Paths
- Inheritance
-
- Object
- RequestBuilder
- StrictSendPathsRequestBuilder
Constructors
- StrictSendPathsRequestBuilder(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
cursorparameter 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 -
destinationAccount(
String accountId) → StrictSendPathsRequestBuilder - Sets the destination account.For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned. See: List Strict Send Payment Paths
-
destinationAssets(
List< Asset> destinationAssets) → StrictSendPathsRequestBuilder - Sets the destination assets. For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned. See: List Strict Send 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
-
sourceAmount(
String amount) → StrictSendPathsRequestBuilder - Sets the source amount. See: List Strict Send Payment Paths
-
sourceAsset(
Asset asset) → StrictSendPathsRequestBuilder - Sets the source asset. See: List Strict Send 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> >