Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::DelegateFilter Struct Reference

A delegate object used filter account_tx by specific delegate accounts. More...

#include <Types.hpp>

Public Types

enum class  Role : std::uint8_t { Actor , Authorizer }
 A delegate type used in delegate filter. More...

Public Member Functions

 DelegateFilter (Role role, std::optional< std::string > counterParty=std::nullopt)
 Construct a delegate filter.

Public Attributes

Role delegateType
std::optional< std::string > counterParty

Detailed Description

A delegate object used filter account_tx by specific delegate accounts.

Member Enumeration Documentation

◆ Role

enum class rpc::DelegateFilter::Role : std::uint8_t
strong

A delegate type used in delegate filter.

Enumerator
Actor 

This account is the active sender, acting on behalf of another party. e.g., Account A in "A sends payment to B on behalf of C."

Authorizer 

This account is the passive party whose funds are being moved from. e.g., Account C in "A sends payment to B on behalf of C."

Constructor & Destructor Documentation

◆ DelegateFilter()

rpc::DelegateFilter::DelegateFilter ( Role role,
std::optional< std::string > counterParty = std::nullopt )
inlineexplicit

Construct a delegate filter.

Parameters
roleThe delegate type to filter by
counterPartyThe optional counterparty to further narrow the filter by

The documentation for this struct was generated from the following file: