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

Interface AccountChannelsRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableAccountChannelsRequestParams

@Immutable
public interface AccountChannelsRequestParams
extends XrplRequestParams

Request parameters for the account_channels rippled method.

Method Summary

Modifier and Type	Method	Description
Address	account()	The unique Address for the account.
static ImmutableAccountChannelsRequestParams.Builder	builder()	Construct a builder for this class.
Optional<Address>	destinationAccount()	The unique Address for the destination account.
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.

Method Detail

builder

static ImmutableAccountChannelsRequestParams.Builder builder()

Construct a builder for this class.

Returns:

An ImmutableAccountChannelsRequestParams.Builder.

account

Address account()

The unique Address for the account. The request returns channels where this account is the channel's owner/source.

Returns:

The Address for the account.

destinationAccount

Optional<Address> destinationAccount()

The unique Address for the destination account. If provided, the response results are filtered by channels whose destination is this account.

Returns:

The optionally present Address of the destination 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.

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 default is 200.

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.