rippled
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
xrpl::ledger_entries::NFTokenOfferBuilder Class Reference

Builder for NFTokenOffer ledger entries. More...

#include <NFTokenOffer.h>

Inheritance diagram for xrpl::ledger_entries::NFTokenOfferBuilder:
Inheritance graph
[legend]
Collaboration diagram for xrpl::ledger_entries::NFTokenOfferBuilder:
Collaboration graph
[legend]

Public Member Functions

 NFTokenOfferBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &owner, std::decay_t< typename SF_UINT256::type::value_type > const &nFTokenID, std::decay_t< typename SF_AMOUNT::type::value_type > const &amount, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT64::type::value_type > const &nFTokenOfferNode, std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq)
 Construct a new NFTokenOfferBuilder with required fields.
 
 NFTokenOfferBuilder (std::shared_ptr< SLE const > sle)
 Construct a NFTokenOfferBuilder from an existing SLE object.
 
NFTokenOfferBuildersetOwner (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Ledger entry-specific field setters.
 
NFTokenOfferBuildersetNFTokenID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfNFTokenID (soeREQUIRED)
 
NFTokenOfferBuildersetAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
 Set sfAmount (soeREQUIRED)
 
NFTokenOfferBuildersetOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfOwnerNode (soeREQUIRED)
 
NFTokenOfferBuildersetNFTokenOfferNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfNFTokenOfferNode (soeREQUIRED)
 
NFTokenOfferBuildersetDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Set sfDestination (soeOPTIONAL)
 
NFTokenOfferBuildersetExpiration (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfExpiration (soeOPTIONAL)
 
NFTokenOfferBuildersetPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfPreviousTxnID (soeREQUIRED)
 
NFTokenOfferBuildersetPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfPreviousTxnLgrSeq (soeREQUIRED)
 
NFTokenOffer build (uint256 const &index)
 Build and return the completed NFTokenOffer wrapper.
 
bool validate () const
 Validate the ledger entry.
 
NFTokenOfferBuildersetLedgerIndex (uint256 const &value)
 Set the ledger index.
 
NFTokenOfferBuildersetFlags (uint32_t value)
 Set the flags.
 

Protected Attributes

STObject object_
 

Detailed Description

Builder for NFTokenOffer ledger entries.

Provides a fluent interface for constructing ledger entries with method chaining. Uses Json::Value internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 181 of file NFTokenOffer.h.

Constructor & Destructor Documentation

◆ NFTokenOfferBuilder() [1/2]

xrpl::ledger_entries::NFTokenOfferBuilder::NFTokenOfferBuilder ( std::decay_t< typename SF_ACCOUNT::type::value_type > const &  owner,
std::decay_t< typename SF_UINT256::type::value_type > const &  nFTokenID,
std::decay_t< typename SF_AMOUNT::type::value_type > const &  amount,
std::decay_t< typename SF_UINT64::type::value_type > const &  ownerNode,
std::decay_t< typename SF_UINT64::type::value_type > const &  nFTokenOfferNode,
std::decay_t< typename SF_UINT256::type::value_type > const &  previousTxnID,
std::decay_t< typename SF_UINT32::type::value_type > const &  previousTxnLgrSeq 
)

Construct a new NFTokenOfferBuilder with required fields.

Parameters
ownerThe sfOwner field value.
nFTokenIDThe sfNFTokenID field value.
amountThe sfAmount field value.
ownerNodeThe sfOwnerNode field value.
nFTokenOfferNodeThe sfNFTokenOfferNode field value.
previousTxnIDThe sfPreviousTxnID field value.
previousTxnLgrSeqThe sfPreviousTxnLgrSeq field value.

Definition at line 194 of file NFTokenOffer.h.

◆ NFTokenOfferBuilder() [2/2]

xrpl::ledger_entries::NFTokenOfferBuilder::NFTokenOfferBuilder ( std::shared_ptr< SLE const >  sle)

Construct a NFTokenOfferBuilder from an existing SLE object.

Parameters
sleThe existing ledger entry to copy from.
Exceptions
std::runtime_errorif the ledger entry type doesn't match.

Definition at line 211 of file NFTokenOffer.h.

Member Function Documentation

◆ setOwner()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setOwner ( std::decay_t< typename SF_ACCOUNT::type::value_type > const &  value)

Ledger entry-specific field setters.

Set sfOwner (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 227 of file NFTokenOffer.h.

◆ setNFTokenID()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setNFTokenID ( std::decay_t< typename SF_UINT256::type::value_type > const &  value)

Set sfNFTokenID (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 238 of file NFTokenOffer.h.

◆ setAmount()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setAmount ( std::decay_t< typename SF_AMOUNT::type::value_type > const &  value)

Set sfAmount (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 249 of file NFTokenOffer.h.

◆ setOwnerNode()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setOwnerNode ( std::decay_t< typename SF_UINT64::type::value_type > const &  value)

Set sfOwnerNode (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 260 of file NFTokenOffer.h.

◆ setNFTokenOfferNode()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setNFTokenOfferNode ( std::decay_t< typename SF_UINT64::type::value_type > const &  value)

Set sfNFTokenOfferNode (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 271 of file NFTokenOffer.h.

◆ setDestination()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setDestination ( std::decay_t< typename SF_ACCOUNT::type::value_type > const &  value)

Set sfDestination (soeOPTIONAL)

Returns
Reference to this builder for method chaining.

Definition at line 282 of file NFTokenOffer.h.

◆ setExpiration()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setExpiration ( std::decay_t< typename SF_UINT32::type::value_type > const &  value)

Set sfExpiration (soeOPTIONAL)

Returns
Reference to this builder for method chaining.

Definition at line 293 of file NFTokenOffer.h.

◆ setPreviousTxnID()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setPreviousTxnID ( std::decay_t< typename SF_UINT256::type::value_type > const &  value)

Set sfPreviousTxnID (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 304 of file NFTokenOffer.h.

◆ setPreviousTxnLgrSeq()

NFTokenOfferBuilder & xrpl::ledger_entries::NFTokenOfferBuilder::setPreviousTxnLgrSeq ( std::decay_t< typename SF_UINT32::type::value_type > const &  value)

Set sfPreviousTxnLgrSeq (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 315 of file NFTokenOffer.h.

◆ build()

NFTokenOffer xrpl::ledger_entries::NFTokenOfferBuilder::build ( uint256 const &  index)

Build and return the completed NFTokenOffer wrapper.

Parameters
indexThe ledger entry index.
Returns
The constructed ledger entry wrapper.

Definition at line 327 of file NFTokenOffer.h.

◆ validate()

Validate the ledger entry.

Returns
true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

Set the ledger index.

Parameters
valueLedger index
Returns
Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

◆ setFlags()

Set the flags.

Parameters
valueFlags value
Returns
Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

◆ object_

Definition at line 81 of file LedgerEntryBuilderBase.h.