ClaimableBalancesRequestBuilder class
- Inheritance
- Object
- RequestBuilder
- ClaimableBalancesRequestBuilder
Constructors
-
ClaimableBalancesRequestBuilder(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
-
claimableBalance(
Uri uri ) → Future< ClaimableBalanceResponse> -
Requests specific
uri
and returns ClaimableBalancesResponse. This method is helpful for getting the links. -
cursor(
String token ) → ClaimableBalancesRequestBuilder -
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< ClaimableBalanceResponse> > - Build and execute request.
-
forAsset(
Asset asset ) → ClaimableBalancesRequestBuilder - Returns all claimable balances for an asset. See: Claimable Balances
-
forBalanceId(
String balanceId ) → Future< ClaimableBalanceResponse> -
Requests details about the claimable balance to fetch by
balanceId
. See Claimable Balances -
forClaimant(
String claimantAccountId ) → ClaimableBalancesRequestBuilder - Returns all claimable balances for the accountId of a claimant. See: Claimable Balances
-
forSponsor(
String signerAccountId ) → ClaimableBalancesRequestBuilder - Returns all claimable balances for the account id of the sponsor who is paying the reserves for this claimable balances. See: Claimable Balances
-
limit(
int number ) → ClaimableBalancesRequestBuilder -
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
-
order(
RequestBuilderOrder direction ) → ClaimableBalancesRequestBuilder -
Sets order parameter on the request.
override
-
setSegments(
List< String> segments) → RequestBuilder -
inherited
-
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< ClaimableBalanceResponse> > - Requests specific uri and returns Page of ClaimableBalanceResponse. This method is helpful for getting the next set of results.
Constants
- ASSET_PARAMETER_NAME → const String
-
"asset"
- CLAIMANT_PARAMETER_NAME → const String
-
"claimant"
- SPONSOR_PARAMETER_NAME → const String
-
"sponsor"