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

Interface TokenWipeAccountTransactionBodyOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AccountID
    getAccount()
    * An account identifier.<br/> This identifies the account from which tokens will be wiped.
    long
    getAmount()
    * An amount of fungible/common tokens to wipe.
    long
    getSerialNumbers(int index)
    * A list of serial numbers to wipe.<br/> The non-fungible/unique tokens with these serial numbers will be destroyed and cannot be recovered or reused.
    int
    getSerialNumbersCount()
    * A list of serial numbers to wipe.<br/> The non-fungible/unique tokens with these serial numbers will be destroyed and cannot be recovered or reused.
    List<Long>
    getSerialNumbersList()
    * A list of serial numbers to wipe.<br/> The non-fungible/unique tokens with these serial numbers will be destroyed and cannot be recovered or reused.
    TokenID
    getToken()
    * A token identifier.
    boolean
    hasAccount()
    * An account identifier.<br/> This identifies the account from which tokens will be wiped.
    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 field is REQUIRED.<br/>
 The identified token MUST exist, MUST NOT be paused, MUST NOT be
 deleted, and MUST NOT be expired.
      .proto.TokenID token = 1;
      Returns:
      Whether the token field is set.

    • getToken

      TokenID getToken()
       *
 A token identifier.
 <p>
 This field is REQUIRED.<br/>
 The identified token MUST exist, MUST NOT be paused, MUST NOT be
 deleted, and MUST NOT be expired.
      .proto.TokenID token = 1;
      Returns:
      The token.

    • hasAccount

      boolean hasAccount()
       *
 An account identifier.<br/>
 This identifies the account from which tokens will be wiped.
 <p>
 This field is REQUIRED.<br/>
 The identified account MUST NOT be deleted or expired.<br/>
 If the identified token `kyc_key` is set to a valid key, the
 identified account MUST have "KYC" granted.<br/>
 The identified account MUST NOT be the `treasury` account for the
 identified token.
      .proto.AccountID account = 2;
      Returns:
      Whether the account field is set.

    • getAccount

      AccountID getAccount()
       *
 An account identifier.<br/>
 This identifies the account from which tokens will be wiped.
 <p>
 This field is REQUIRED.<br/>
 The identified account MUST NOT be deleted or expired.<br/>
 If the identified token `kyc_key` is set to a valid key, the
 identified account MUST have "KYC" granted.<br/>
 The identified account MUST NOT be the `treasury` account for the
 identified token.
      .proto.AccountID account = 2;
      Returns:
      The account.

    • getAmount

      long getAmount()
       *
 An amount of fungible/common tokens to wipe.
 <p>
 If the identified token is a non-fungible/unique token type,
 this value MUST be exactly zero(`0`).<br/>
 If the identified token type is fungible/common:
 <ul>
 <li>This value SHALL be specified in units of the smallest
 denomination possible for the identified token
 (<tt>10<sup>-decimals</sup></tt> whole tokens).</li>
 <li>This value MUST be strictly less than `Long.MAX_VALUE`.</li>
 <li>This value MUST be less than or equal to the current total
 supply for the identified token.</li>
 <li>This value MUST be less than or equal to the current balance
 held by the identified account.</li>
 <li>This value MAY be zero(`0`).</li>
 </ul>
      uint64 amount = 3;
      Returns:
      The amount.

    • getSerialNumbersList

      List<Long> getSerialNumbersList()
       *
 A list of serial numbers to wipe.<br/>
 The non-fungible/unique tokens with these serial numbers will be
 destroyed and cannot be recovered or reused.
 <p>
 If the identified token type is a fungible/common type, this
 list MUST be empty.<br/>
 If the identified token type is non-fungible/unique:
 <ul>
 <li>This list MUST contain at least one entry if the identified token
 type is non-fungible/unique.>/li>
 <li>This list MUST NOT contain more entries than the current total
 supply for the identified token.</li>
 <li>Every entry in this list MUST be a valid serial number for the
 identified token (i.e. "collection").</li>
 <li>Every entry in this list MUST be owned by the
 identified account</li>
 <li></li>
 </ul>
 This list MUST NOT contain more entries than the network configuration
 value for batch size limit, typically ten(`10`).
      repeated int64 serialNumbers = 4;
      Returns:
      A list containing the serialNumbers.

    • getSerialNumbersCount

      int getSerialNumbersCount()
       *
 A list of serial numbers to wipe.<br/>
 The non-fungible/unique tokens with these serial numbers will be
 destroyed and cannot be recovered or reused.
 <p>
 If the identified token type is a fungible/common type, this
 list MUST be empty.<br/>
 If the identified token type is non-fungible/unique:
 <ul>
 <li>This list MUST contain at least one entry if the identified token
 type is non-fungible/unique.>/li>
 <li>This list MUST NOT contain more entries than the current total
 supply for the identified token.</li>
 <li>Every entry in this list MUST be a valid serial number for the
 identified token (i.e. "collection").</li>
 <li>Every entry in this list MUST be owned by the
 identified account</li>
 <li></li>
 </ul>
 This list MUST NOT contain more entries than the network configuration
 value for batch size limit, typically ten(`10`).
      repeated int64 serialNumbers = 4;
      Returns:
      The count of serialNumbers.

    • getSerialNumbers

      long getSerialNumbers(int index)
       *
 A list of serial numbers to wipe.<br/>
 The non-fungible/unique tokens with these serial numbers will be
 destroyed and cannot be recovered or reused.
 <p>
 If the identified token type is a fungible/common type, this
 list MUST be empty.<br/>
 If the identified token type is non-fungible/unique:
 <ul>
 <li>This list MUST contain at least one entry if the identified token
 type is non-fungible/unique.>/li>
 <li>This list MUST NOT contain more entries than the current total
 supply for the identified token.</li>
 <li>Every entry in this list MUST be a valid serial number for the
 identified token (i.e. "collection").</li>
 <li>Every entry in this list MUST be owned by the
 identified account</li>
 <li></li>
 </ul>
 This list MUST NOT contain more entries than the network configuration
 value for batch size limit, typically ten(`10`).
      repeated int64 serialNumbers = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The serialNumbers at the given index.