Interface TransactionMetadata
- All Known Implementing Classes:
ImmutableTransactionMetadata
@Immutable
public interface TransactionMetadata
Transaction metadata is a section of data that gets added to a transaction after it is processed. Any transaction
that gets included in a ledger has metadata, regardless of whether it is successful. The transaction metadata
describes the outcome of the transaction in detail.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()Construct a builder for this class.The Currency Amount actually received by the Destination account.TheMpTokenIssuanceIdof theMpTokenIssuanceObjectcreated via anMpTokenIssuanceCreatetransaction.offerId()The ID of the offer created byNfTokenCreateOffertransactions.com.google.common.primitives.UnsignedIntegerThe transaction's position within the ledger that included it.A result code indicating whether the transaction succeeded or how it failed.
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableTransactionMetadata.Builder.
-
transactionIndex
com.google.common.primitives.UnsignedInteger transactionIndex()The transaction's position within the ledger that included it. This is zero-indexed. For example, the value 2 means it was the 3rd transaction in that ledger.- Returns:
- index of transaction within ledger.
-
transactionResult
String transactionResult()A result code indicating whether the transaction succeeded or how it failed.- Returns:
- transaction result code.
-
deliveredAmount
Optional<CurrencyAmount> deliveredAmount()The Currency Amount actually received by the Destination account. Use this field to determine how much was delivered, regardless of whether the transaction is a partial payment. Omitted for non-Payment transactions.- Returns:
- delivered amount for payments, otherwise empty for non-payments.
-
nfTokenId
TheNfTokenIdof theNfTokenthat was changed as a result of this transaction. Only present in metadata forNfTokenMintandNfTokenAcceptOffertransactions.- Returns:
- An optionally-present
NfTokenId.
-
nfTokenIds
TheNfTokenIds of theNfTokens changed by aNfTokenCancelOffertransaction. Only present in metadata forNfTokenCancelOffertransactions. -
mpTokenIssuanceId
Optional<MpTokenIssuanceId> mpTokenIssuanceId()TheMpTokenIssuanceIdof theMpTokenIssuanceObjectcreated via anMpTokenIssuanceCreatetransaction.- Returns:
- An
OptionalMpTokenIssuanceId.
-
offerId
The ID of the offer created byNfTokenCreateOffertransactions. Only present in metadata forNfTokenCreateOffertransactions.- Returns:
- An optionally-present
Hash256denoting the offer ID.
-
affectedNodes
List<AffectedNode> affectedNodes()
-