Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::DepositAuthorizedHandler Class Reference

Handles the deposit_authorized command. More...

#include <DepositAuthorized.hpp>

Inheritance diagram for rpc::DepositAuthorizedHandler:
Collaboration diagram for rpc::DepositAuthorizedHandler:

Classes

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

Public Types

using Result = HandlerReturnType<Output>

Public Member Functions

 DepositAuthorizedHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
 Construct a new DepositAuthorizedHandler object.
Result process (Input const &input, Context const &ctx) const
 Process the DepositAuthorized command.

Friends

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

Detailed Description

Handles the deposit_authorized command.

The deposit_authorized command indicates whether one account is authorized to send payments directly to another. See Deposit Authorization for information on how to require authorization to deliver money to your account.

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

Constructor & Destructor Documentation

◆ DepositAuthorizedHandler()

rpc::DepositAuthorizedHandler::DepositAuthorizedHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend)
inline

Construct a new DepositAuthorizedHandler object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

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

Process the DepositAuthorized command.

Parameters
inputThe input data for the command
ctxThe context of the request
Returns
The result of the operation

◆ tag_invoke

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

Convert the Output to a JSON object.

Parameters
[out]jvThe JSON object to convert to
outputThe output to convert

The documentation for this class was generated from the following files:
  • /__w/clio/clio/src/rpc/handlers/DepositAuthorized.hpp
  • /__w/clio/clio/src/rpc/handlers/DepositAuthorized.cpp