OffersRequestBuilder class
Builds requests connected to offers. Offers are statements about how much of an asset an account wants to buy or sell. See: Offers
- Inheritance
-
- Object
- RequestBuilder
- OffersRequestBuilder
Constructors
- OffersRequestBuilder(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) → OffersRequestBuilder -
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< OfferResponse> > - Build and execute request.
-
forAccount(
String accountId) → OffersRequestBuilder - Returns all offers a given account has currently open. See: Offers for Account
-
forBuyingAsset(
Asset asset) → OffersRequestBuilder -
Returns all offers buying an
asset. See Offers -
forSeller(
String seller) → OffersRequestBuilder - Returns all offers where the given account is the seller. See Offers
-
forSellingAsset(
Asset asset) → OffersRequestBuilder -
Returns all selling buying an
asset. See Offers -
forSponsor(
String sponsorAccountId) → OffersRequestBuilder - Returns all offers sponsored by a given sponsor. See Offers
-
limit(
int number) → OffersRequestBuilder -
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
-
offer(
String offerId) → Future< OfferResponse> -
The offer details endpoint provides information on a single offer given by
offerId. See: Retrieve an Offer -
offersURI(
Uri uri) → Future< OfferResponse> -
Requests specific
uriand returns OfferResponse. This method is helpful for getting the links. -
order(
RequestBuilderOrder direction) → OffersRequestBuilder -
Sets order parameter on the request.
override
-
setSegments(
List< String> segments) → RequestBuilder -
inherited
-
stream(
) → Stream< OfferResponse> - 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< OfferResponse> > - Requests specific uri and returns Page of OfferResponse. This method is helpful for getting the next set of results.