OrderBookRequestBuilder class

Builds requests connected to the order book. An order book is a collections of offers for a specific pair of assets. See: Order books

Inheritance

Constructors

OrderBookRequestBuilder(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
buyingAsset(Asset asset) → OrderBookRequestBuilder
Sets the asset being bought (counter asset). See: Order books
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
encodeAsset(Asset asset) → String
inherited
encodeAssets(List<Asset> assets) → String
inherited
execute() → Future<OrderBookResponse>
limit(int number) → OrderBookRequestBuilder
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) → RequestBuilder
Sets order parameter on the request.
inherited
sellingAsset(Asset asset) → OrderBookRequestBuilder
Sets the asset being sold (base asset). See: Order books
setSegments(List<String> segments) → RequestBuilder
inherited
stream() → Stream<OrderBookResponse>
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<OrderBookResponse>
Requests specific uri and returns Page of OrderBookResponse. This method is helpful for getting the next set of results.