Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface TokenBurnTransactionBodyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
TokenBurnTransactionBody, TokenBurnTransactionBody.Builder
@Generated public interface TokenBurnTransactionBodyOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getAmount()
    * An amount to burn from the Treasury Account.
    long
    getSerialNumbers(int index)
    * A list of serial numbers to burn from the Treasury Account.
    int
    getSerialNumbersCount()
    * A list of serial numbers to burn from the Treasury Account.
    List<Long>
    getSerialNumbersList()
    * A list of serial numbers to burn from the Treasury Account.
    TokenID
    getToken()
    * A token identifier.
    boolean
    hasToken()
    * A token identifier.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasToken

      boolean hasToken()
       *
 A token identifier.
 <p>
 This SHALL identify the token type to "burn".<br/>
 The identified token MUST exist, and MUST NOT be deleted.
      .proto.TokenID token = 1;
      Returns:
      Whether the token field is set.

    • getToken

      TokenID getToken()
       *
 A token identifier.
 <p>
 This SHALL identify the token type to "burn".<br/>
 The identified token MUST exist, and MUST NOT be deleted.
      .proto.TokenID token = 1;
      Returns:
      The token.

    • getAmount

      long getAmount()
       *
 An amount to burn from the Treasury Account.
 <p>
 This is interpreted as an amount in the smallest possible denomination
 for the token (10<sup>-decimals</sup> whole tokens).<br/>
 The balance for the token treasury account MUST contain sufficient
 tokens to complete this transaction with a non-negative balance.<br/>
 If this value is equal to zero (`0`), the token SHOULD be a
 non-fungible/unique type.<br/>
 If this value is non-zero, the token MUST be a fungible/common type.
      uint64 amount = 2;
      Returns:
      The amount.

    • getSerialNumbersList

      List<Long> getSerialNumbersList()
       *
 A list of serial numbers to burn from the Treasury Account.
 <p>
 This list MUST NOT contain more entries than the current limit set by
 the network configuration value `tokens.nfts.maxBatchSizeBurn`.<br/>
 The treasury account for the token MUST hold each unique token
 identified in this list.<br/>
 If this list is not empty, the token MUST be a
 non-fungible/unique type.<br/>
 If this list is empty, the token MUST be a fungible/common type.
      repeated int64 serialNumbers = 3;
      Returns:
      A list containing the serialNumbers.

    • getSerialNumbersCount

      int getSerialNumbersCount()
       *
 A list of serial numbers to burn from the Treasury Account.
 <p>
 This list MUST NOT contain more entries than the current limit set by
 the network configuration value `tokens.nfts.maxBatchSizeBurn`.<br/>
 The treasury account for the token MUST hold each unique token
 identified in this list.<br/>
 If this list is not empty, the token MUST be a
 non-fungible/unique type.<br/>
 If this list is empty, the token MUST be a fungible/common type.
      repeated int64 serialNumbers = 3;
      Returns:
      The count of serialNumbers.

    • getSerialNumbers

      long getSerialNumbers(int index)
       *
 A list of serial numbers to burn from the Treasury Account.
 <p>
 This list MUST NOT contain more entries than the current limit set by
 the network configuration value `tokens.nfts.maxBatchSizeBurn`.<br/>
 The treasury account for the token MUST hold each unique token
 identified in this list.<br/>
 If this list is not empty, the token MUST be a
 non-fungible/unique type.<br/>
 If this list is empty, the token MUST be a fungible/common type.
      repeated int64 serialNumbers = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The serialNumbers at the given index.