rpc::AccountObjectsHandler Class Reference

The account_objects command returns the raw ledger format for all objects owned by an account. The results can be filtered by the type. The valid types are: check, deposit_preauth, escrow, nft_offer, offer, payment_channel, signer_list, state (trust line), did and ticket. More...

#include <AccountObjects.hpp>

Inheritance diagram for rpc::AccountObjectsHandler:

Collaboration diagram for rpc::AccountObjectsHandler:

Classes
struct	Output
	A struct to hold the output data of the command. More...

Public Types
using	Result = HandlerReturnType<Output>

Public Member Functions
	AccountObjectsHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
	Construct a new AccountObjectsHandler object.
Result	process (Input const &input, Context const &ctx) const
	Process the AccountObjects command.

Static Public Attributes
static constexpr auto	kLimitMin = rpc::spec::handlers::account_objects::kLimitMin
static constexpr auto	kLimitMax = rpc::spec::handlers::account_objects::kLimitMax
static constexpr auto	kLimitDefault = rpc::spec::handlers::account_objects::kLimitDefault

Friends
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, AccountObjectsHandler::Output const &output)
	Convert the Output to a JSON object.

Detailed Description

The account_objects command returns the raw ledger format for all objects owned by an account. The results can be filtered by the type. The valid types are: check, deposit_preauth, escrow, nft_offer, offer, payment_channel, signer_list, state (trust line), did and ticket.

For more details see: https://xrpl.org/account_objects.html

Constructor & Destructor Documentation

AccountObjectsHandler()

rpc::AccountObjectsHandler::AccountObjectsHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend )

inline

Construct a new AccountObjectsHandler object.

Parameters

sharedPtrBackend

The backend to use

Member Function Documentation

process()

AccountObjectsHandler::Result rpc::AccountObjectsHandler::process ( Input const & input, Context const & ctx ) const

nodiscard

Process the AccountObjects command.

Parameters

input	The input data for the command
ctx	The context of the request

Returns

The result of the operation

Friends And Related Symbol Documentation

tag_invoke

void tag_invoke ( boost::json::value_from_tag , boost::json::value & jv, AccountObjectsHandler::Output const & output )

friend

Convert the Output to a JSON object.

Parameters

[out]	jv	The JSON object to convert to
	output	The output to convert

---

The documentation for this class was generated from the following files:

• /__w/clio/clio/src/rpc/handlers/AccountObjects.hpp
• /__w/clio/clio/src/rpc/handlers/AccountObjects.cpp