Package org.xrpl.xrpl4j.model.client.accounts

Interface AccountOffersRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableAccountOffersRequestParams

@Immutable
public interface AccountOffersRequestParams
extends XrplRequestParams

Request parameters for the account_offers rippled method.

Method Summary

Modifier and Type	Method	Description
Address	account()	A unique identifier for the account, most commonly the account's Address.
static ImmutableAccountOffersRequestParams.Builder	builder()
Optional<Hash256>	ledgerHash()	Deprecated. Ledger hash should be specified in ledgerSpecifier().
LedgerIndex	ledgerIndex()	Deprecated. Ledger index and any shortcut values should be specified in ledgerSpecifier().
default LedgerSpecifier	ledgerSpecifier()	Specifies the ledger version to request.
Optional<com.google.common.primitives.UnsignedInteger>	limit()	Limit the number of transactions to retrieve.
Optional<Marker>	marker()	Value from a previous paginated response.
default boolean	strict()	A boolean indicating if the account() field only accepts a public key or XRP Ledger Address.

Method Detail

builder

static ImmutableAccountOffersRequestParams.Builder builder()

account

Address account()

A unique identifier for the account, most commonly the account's Address.

Returns:

The Address for the account.

ledgerHash

@Deprecated
@Auxiliary
Optional<Hash256> ledgerHash()

Deprecated.

Ledger hash should be specified in ledgerSpecifier().

A 20-byte hex string for the ledger version to use.

Returns:

An optionally-present Hash256.

ledgerIndex

@Deprecated
@Nullable
@Auxiliary
LedgerIndex ledgerIndex()

Deprecated.

Ledger index and any shortcut values should be specified in ledgerSpecifier().

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

Returns:

A LedgerIndex. Defaults to LedgerIndex.CURRENT.

ledgerSpecifier

@Default
default LedgerSpecifier ledgerSpecifier()

Specifies the ledger version to request. A ledger version can be specified by ledger hash, numerical ledger index, or a shortcut value.

Returns:

A LedgerSpecifier specifying the ledger version to request.

strict

@Derived
default boolean strict()

A boolean indicating if the account() field only accepts a public key or XRP Ledger Address. Always true, as account() is always an Address.

Returns:

true if the account field only accepts a public key or XRP Ledger address, otherwise false. Defaults to true.

limit

Optional<com.google.common.primitives.UnsignedInteger> limit()

Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. The server is not required to honor this value and the default varies.

Returns:

An optionally-present UnsignedInteger.

marker

Optional<Marker> marker()

Value from a previous paginated response. Resume retrieving data where that response left off.

Returns:

An optionally-present String.