ledger::core::api::Operation Class Reference

#include <Operation.hpp>

Inheritance diagram for ledger::core::api::Operation:

Public Member Functions
virtual std::string	getUid ()=0
virtual int32_t	getAccountIndex ()=0
virtual OperationType	getOperationType ()=0
virtual std::chrono::system_clock::time_point	getDate ()=0
virtual std::vector< std::string >	getSenders ()=0
virtual std::vector< std::string >	getRecipients ()=0
virtual std::shared_ptr< Amount >	getAmount ()=0
virtual std::shared_ptr< Amount >	getFees ()=0
virtual std::shared_ptr< Preferences >	getPreferences ()=0
virtual std::shared_ptr< TrustIndicator >	getTrust ()=0
virtual std::experimental::optional< int64_t >	getBlockHeight ()=0
virtual std::shared_ptr< BitcoinLikeOperation >	asBitcoinLikeOperation ()=0
virtual std::shared_ptr< EthereumLikeOperation >	asEthereumLikeOperation ()=0
virtual std::shared_ptr< RippleLikeOperation >	asRippleLikeOperation ()=0
virtual std::shared_ptr< TezosLikeOperation >	asTezosLikeOperation ()=0
virtual bool	isInstanceOfBitcoinLikeOperation ()=0
virtual bool	isInstanceOfEthereumLikeOperation ()=0
virtual bool	isInstanceOfRippleLikeOperation ()=0
virtual bool	isInstanceOfTezosLikeOperation ()=0
virtual bool	isComplete ()=0
virtual WalletType	getWalletType ()=0
virtual Currency	getCurrency ()=0

Detailed Description

Class representing an operation.

Member Function Documentation

asBitcoinLikeOperation()

virtual std::shared_ptr<BitcoinLikeOperation> ledger::core::api::Operation::asBitcoinLikeOperation ( )

pure virtual

Convert operation as Bitcoin operation.

Returns

BitcoinLikeOperation object

Implemented in ledger::core::OperationApi.

asEthereumLikeOperation()

virtual std::shared_ptr<EthereumLikeOperation> ledger::core::api::Operation::asEthereumLikeOperation ( )

pure virtual

Convert operation as Ethereum operation.

Returns

EthereumLikeOperation object

Implemented in ledger::core::OperationApi.

asRippleLikeOperation()

virtual std::shared_ptr<RippleLikeOperation> ledger::core::api::Operation::asRippleLikeOperation ( )

pure virtual

Convert operation as Ripple operation

Returns

RippleLikeOperation object

Implemented in ledger::core::OperationApi.

asTezosLikeOperation()

virtual std::shared_ptr<TezosLikeOperation> ledger::core::api::Operation::asTezosLikeOperation ( )

pure virtual

Convert operation as Tezos operation

Returns

TezosLikeOperation object

Implemented in ledger::core::OperationApi.

getAccountIndex()

virtual int32_t ledger::core::api::Operation::getAccountIndex ( )

pure virtual

Get account's index in user's wallet.

Returns

32-bit integer

Implemented in ledger::core::OperationApi.

getAmount()

virtual std::shared_ptr<Amount> ledger::core::api::Operation::getAmount ( )

pure virtual

Get amount of operation.

Returns

Amount object

Implemented in ledger::core::OperationApi.

getBlockHeight()

virtual std::experimental::optional<int64_t> ledger::core::api::Operation::getBlockHeight ( )

pure virtual

Get block height on which operation was included.

Returns

Optional 64-bit integer, height of block in which operation was validated

Implemented in ledger::core::OperationApi.

getCurrency()

virtual Currency ledger::core::api::Operation::getCurrency ( )

pure virtual

Get the currency this operation is about.

Implemented in ledger::core::OperationApi.

getDate()

virtual std::chrono::system_clock::time_point ledger::core::api::Operation::getDate ( )

pure virtual

Return date on which operation was issued.

Returns

date object

Implemented in ledger::core::OperationApi.

getFees()

virtual std::shared_ptr<Amount> ledger::core::api::Operation::getFees ( )

pure virtual

Get fees of operation.

Returns

Optional Amount object

Implemented in ledger::core::OperationApi.

getOperationType()

virtual OperationType ledger::core::api::Operation::getOperationType ( )

pure virtual

Get type of operation.

Returns

OperationType object (for more details refer to OperationType)

Implemented in ledger::core::OperationApi.

getPreferences()

virtual std::shared_ptr<Preferences> ledger::core::api::Operation::getPreferences ( )

pure virtual

Get preferences of operation.

Returns

Prefences object

Implemented in ledger::core::OperationApi.

getRecipients()

virtual std::vector<std::string> ledger::core::api::Operation::getRecipients ( )

pure virtual

Get recipients of operation.

Returns

List of string, list of all recipients

Implemented in ledger::core::OperationApi.

getSenders()

virtual std::vector<std::string> ledger::core::api::Operation::getSenders ( )

pure virtual

Get senders of operation.

Returns

List of string, list of all senders

Implemented in ledger::core::OperationApi.

getTrust()

virtual std::shared_ptr<TrustIndicator> ledger::core::api::Operation::getTrust ( )

pure virtual

Get trust indicator of operation.

Returns

TrustIndicator object

Implemented in ledger::core::OperationApi.

getUid()

virtual std::string ledger::core::api::Operation::getUid ( )

pure virtual

Get id's operation.

Returns

string

Implemented in ledger::core::OperationApi.

getWalletType()

virtual WalletType ledger::core::api::Operation::getWalletType ( )

pure virtual

Get type of wallet from which operation was issued.

Returns

WalletType object

Implemented in ledger::core::OperationApi.

isComplete()

virtual bool ledger::core::api::Operation::isComplete ( )

pure virtual

Tells if the operation is complete.

Returns

boolean

Implemented in ledger::core::OperationApi.

isInstanceOfBitcoinLikeOperation()

virtual bool ledger::core::api::Operation::isInstanceOfBitcoinLikeOperation ( )

pure virtual

Same as isInstanceOfBitcoinLikeOperation for bitcoin.

Implemented in ledger::core::OperationApi.

isInstanceOfEthereumLikeOperation()

virtual bool ledger::core::api::Operation::isInstanceOfEthereumLikeOperation ( )

pure virtual

Same as isInstanceOfEthereumLikeOperation for ethereum.

Implemented in ledger::core::OperationApi.

isInstanceOfRippleLikeOperation()

virtual bool ledger::core::api::Operation::isInstanceOfRippleLikeOperation ( )

pure virtual

Same as isInstanceOfRippleLikeOperation for ripple.

Implemented in ledger::core::OperationApi.

isInstanceOfTezosLikeOperation()

virtual bool ledger::core::api::Operation::isInstanceOfTezosLikeOperation ( )

pure virtual

Same as isInstanceOfTezosLikeOperation for tezos.

Implemented in ledger::core::OperationApi.

---

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

• src/api/Operation.hpp