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

Interface AccountInfoRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableAccountInfoRequestParams

@Immutable
public interface AccountInfoRequestParams
extends XrplRequestParams

Request parameters for the "account_info" API method.

Method Summary

Modifier and Type	Method	Description
Address	account()	A unique Address for the account.
static ImmutableAccountInfoRequestParams.Builder	builder()	Construct a builder for this class.
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.
static AccountInfoRequestParams	of(Address account)	Constructs an AccountInfoRequestParams for a specified account, with all other fields set to their defaults.
default boolean	queue()	If true, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account.
default boolean	signerLists()	If true, and the MultiSign amendment is enabled, also returns any SignerListObjects associated with this account.
default boolean	strict()	A boolean indicating if the account() field only accepts a public key or XRP Ledger Address.

Method Detail

builder

static ImmutableAccountInfoRequestParams.Builder builder()

Construct a builder for this class.

Returns:

An ImmutableAccountInfoRequestParams.Builder.

of

static AccountInfoRequestParams of(Address account)

Constructs an AccountInfoRequestParams for a specified account, with all other fields set to their defaults.

Parameters:

account - The Address of the account.

Returns:

An AccountInfoRequestParams for the specified account.

account

Address account()

A unique Address for the account.

Returns:

The Address of 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.

queue

@Default
default boolean queue()

If true, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger.

Returns:

true if queue transactions should be returned in the response, false if not. Defaults to false.

signerLists

@Default
default boolean signerLists()

If true, and the MultiSign amendment is enabled, also returns any SignerListObjects associated with this account.

Returns:

true if signer lists should be returns, false if not. Defaults to true.