LedgersRequestBuilder class
Builds requests connected to ledgers. Each ledger stores the state of the network at a point in time and contains all the changes - transactions, operations, effects, etc. - to that state. See: Ledgers
- Inheritance
-
- Object
- RequestBuilder
- LedgersRequestBuilder
Constructors
- LedgersRequestBuilder(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) → LedgersRequestBuilder -
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< LedgerResponse> > - Build and execute request.
-
ledger(
int ledgerSeq) → Future< LedgerResponse> -
Provides information on a specific ledger given by
ledgerSeq. See: Ledger Details -
ledgerURI(
Uri uri) → Future< LedgerResponse> - Requests specific uri and returns LedgerResponse. This method is helpful for getting the links.
-
limit(
int number) → LedgersRequestBuilder -
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) → LedgersRequestBuilder -
Sets order parameter on the request.
override
-
setSegments(
List< String> segments) → RequestBuilder -
inherited
-
stream(
) → Stream< LedgerResponse> - 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< LedgerResponse> > - Requests specific uri and returns Page of LedgerResponse. This method is helpful for getting the next set of results.