Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenDeleteTransaction

java.lang.Object

com.hedera.hashgraph.sdk.Executable<TokenDeleteTransaction,Transaction,TransactionResponse,TransactionResponse>

com.hedera.hashgraph.sdk.Transaction<TokenDeleteTransaction>

com.hedera.hashgraph.sdk.TokenDeleteTransaction

public class TokenDeleteTransaction
extends Transaction<TokenDeleteTransaction>

Deleting a token marks a token as deleted, though it will remain in the ledger. The operation must be signed by the specified Admin Key of the Token. If the Admin Key is not set, Transaction will result in TOKEN_IS_IMMUTABlE. Once deleted update, mint, burn, wipe, freeze, unfreeze, grant kyc, revoke kyc and token transfer transactions will resolve to TOKEN_WAS_DELETED. See Hedera Documentation

Nested Class Summary

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Transaction

Transaction.SignableNodeTransactionBodyBytes

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Executable

Executable.GrpcRequest

Field Summary

Fields inherited from class com.hedera.hashgraph.sdk.Transaction

customFeeLimits, DEFAULT_AUTO_RENEW_PERIOD, defaultMaxTransactionFee, DUMMY_ACCOUNT_ID, DUMMY_TRANSACTION_ID, frozenBodyBuilder, innerSignedTransactions, outerTransactions, publicKeys, regenerateTransactionId, signers, sigPairLists, sourceTransactionBody, transactionIds

Fields inherited from class com.hedera.hashgraph.sdk.Executable

attemptedAllNodes, blockingUnaryCall, grpcDeadline, logger, maxAttempts, maxBackoff, minBackoff, nodeAccountIds, nodes, random, RST_STREAM

Constructor Summary

Constructors

Constructor	Description
TokenDeleteTransaction()	Constructor.
TokenDeleteTransaction(TransactionBody txBody)	Constructor.
TokenDeleteTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) TokenDeleteTransactionBody.Builder	build()	Build the transaction body.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
TokenId	getTokenId()	Extract the token id.
(package private) void	initFromTransactionBody()	Initialize from the transaction body.
(package private) void	onFreeze(TransactionBody.Builder bodyBuilder)	Called in Transaction.freezeWith(Client) just before the transaction body is built.
(package private) void	onScheduled(SchedulableTransactionBody.Builder scheduled)	Called in Transaction.schedule() when converting transaction into a scheduled version.
TokenDeleteTransaction	setTokenId(TokenId tokenId)	A token identifier.
(package private) void	validateChecksums(Client client)

Methods inherited from class com.hedera.hashgraph.sdk.Transaction

addSignature, addSignature, batchify, buildAllTransactions, buildTransaction, doSchedule, estimateFee, freeze, freezeWith, fromBytes, fromScheduledTransaction, generateTransactionIds, getBatchKey, getDefaultMaxTransactionFee, getExecutionState, getHighVolume, getMaxTransactionFee, getRegenerateTransactionId, getRequiredChunks, getSignableNodeBodyBytesList, getSignatures, getSignaturesAtOffset, getTransactionBodySize, getTransactionHash, getTransactionHashPerNode, getTransactionId, getTransactionIdInternal, getTransactionMemo, getTransactionSize, getTransactionValidDuration, hash, isBatchedAndNotBatchTransaction, isFrozen, keyAlreadySigned, makeRequest, mapResponse, mapResponseStatus, onExecute, onExecuteAsync, regenerateTransactionId, requireNotFrozen, requireOneNodeAccountId, schedule, setBatchKey, setHighVolume, setMaxTransactionFee, setNodeAccountIds, setRegenerateTransactionId, setTransactionId, setTransactionMemo, setTransactionValidDuration, sign, signTransaction, signWith, signWithOperator, spawnBodyBuilder, toBytes, toString, wipeTransactionLists

Methods inherited from class com.hedera.hashgraph.sdk.Executable

advanceRequest, checkNodeAccountIds, execute, execute, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, getGrpcRequest, getMaxAttempts, getMaxBackoff, getMaxRetry, getMinBackoff, getNodeAccountIds, getNodeForExecute, grpcDeadline, logTransaction, mergeFromClient, setGrpcDeadline, setLogger, setMaxAttempts, setMaxBackoff, setMaxRetry, setMinBackoff, setNodesFromNodeAccountIds, setRequestListener, setResponseListener, shouldRetryExceptionally

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TokenDeleteTransaction

public TokenDeleteTransaction()

Constructor.

TokenDeleteTransaction

TokenDeleteTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)
                throws com.google.protobuf.InvalidProtocolBufferException

Constructor.

Parameters:

txs - Compound list of transaction id's list of (AccountId, Transaction) records

Throws:

com.google.protobuf.InvalidProtocolBufferException - when there is an issue with the protobuf

TokenDeleteTransaction

TokenDeleteTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getTokenId

@Nullable
public TokenId getTokenId()

Extract the token id.

Returns:

the token id

setTokenId

public TokenDeleteTransaction setTokenId(TokenId tokenId)

A token identifier.

This SHALL identify the token type to delete.
The identified token MUST exist, and MUST NOT be deleted.

Parameters:

tokenId - the token id

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

TokenDeleteTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenDeleteTransactionBody

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenDeleteTransaction>

Throws:

BadEntityIdException

getMethodDescriptor

io.grpc.MethodDescriptor<Transaction,TransactionResponse> getMethodDescriptor()

Description copied from class: Executable

Called to direct the invocation of the query to the appropriate gRPC service.

Specified by:

getMethodDescriptor in class Executable<TokenDeleteTransaction,Transaction,TransactionResponse,TransactionResponse>

onFreeze

void onFreeze(TransactionBody.Builder bodyBuilder)

Description copied from class: Transaction

Called in Transaction.freezeWith(Client) just before the transaction body is built. The intent is for the derived class to assign their data variant to the transaction body.

Specified by:

onFreeze in class Transaction<TokenDeleteTransaction>

onScheduled

void onScheduled(SchedulableTransactionBody.Builder scheduled)

Description copied from class: Transaction

Called in Transaction.schedule() when converting transaction into a scheduled version.

Specified by:

onScheduled in class Transaction<TokenDeleteTransaction>