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

Interface AccountCurrenciesRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableAccountCurrenciesRequestParams

@Immutable
public interface AccountCurrenciesRequestParams
extends XrplRequestParams

Request parameters for the account_currencies rippled method.

Method Summary

Modifier and Type	Method	Description
Address	account()	A unique identifier for the account, most commonly the account's Address.
static ImmutableAccountCurrenciesRequestParams.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.
default boolean	strict()	A boolean indicating if the account() field only accepts a public key or XRP Ledger Address.

Method Detail

builder

static ImmutableAccountCurrenciesRequestParams.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.