Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenRejectTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.TokenRejectTransaction

public class TokenRejectTransaction
extends Transaction<TokenRejectTransaction>

Reject undesired token(s).
Transfer one or more token balances held by the requesting account to the treasury for each token type. Each transfer SHALL be one of the following - A single non-fungible/unique token. - The full balance held for a fungible/common token. A single `tokenReject` transaction SHALL support a maximum of 10 transfers.
A token that is `pause`d MUST NOT be rejected.
If the `owner` account is `frozen` with respect to the identified token(s) the token(s) MUST NOT be rejected.
The `payer` for this transaction, and `owner` if set, SHALL NOT be charged any custom fees or other fees beyond the `tokenReject` transaction fee. ### Block Stream Effects - Each successful transfer from `payer` to `treasury` SHALL be recorded in the `token_transfer_list` for the transaction record.

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
TokenRejectTransaction()	Constructor
TokenRejectTransaction(TransactionBody txBody)	Constructor.
TokenRejectTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
TokenRejectTransaction	addNftId(NftId nftId)	Add a nft to the list of nfts.
TokenRejectTransaction	addTokenId(TokenId tokenId)	Add a token to the list of tokens.
(package private) TokenRejectTransactionBody.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.
List<NftId>	getNftIds()	Extract the list of nftIds.
AccountId	getOwnerId()	Extract the Account ID of the Owner.
List<TokenId>	getTokenIds()	Extract the list of tokenIds.
(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.
TokenRejectTransaction	setNftIds(List<NftId> nftIds)	A list of one or more token rejections (a single specific serialized non-fungible/unique token).
TokenRejectTransaction	setOwnerId(AccountId ownerId)	An account identifier. This OPTIONAL field identifies the account holding the tokens to be rejected.
TokenRejectTransaction	setTokenIds(List<TokenId> tokenIds)	A list of one or more token rejections (a fungible/common token type).
(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

TokenRejectTransaction

public TokenRejectTransaction()

Constructor

TokenRejectTransaction

TokenRejectTransaction(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

TokenRejectTransaction

TokenRejectTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getOwnerId

@Nullable
public AccountId getOwnerId()

Extract the Account ID of the Owner.

Returns:

the Account ID of the Owner.

setOwnerId

public TokenRejectTransaction setOwnerId(AccountId ownerId)

An account identifier.
This OPTIONAL field identifies the account holding the tokens to be rejected.

If set, this account MUST sign this transaction. If not set, the `payer` for this transaction SHALL be the effective `owner` for this transaction.

Parameters:

ownerId - the Account ID of the Owner.

Returns:

this

getTokenIds

public List<TokenId> getTokenIds()

Extract the list of tokenIds.

Returns:

the list of tokenIds.

setTokenIds

public TokenRejectTransaction setTokenIds(List<TokenId> tokenIds)

A list of one or more token rejections (a fungible/common token type).

Parameters:

tokenIds - the list of tokenIds.

Returns:

this

addTokenId

public TokenRejectTransaction addTokenId(TokenId tokenId)

Add a token to the list of tokens.

Parameters:

tokenId - token to add.

Returns:

this

getNftIds

public List<NftId> getNftIds()

Extract the list of nftIds.

Returns:

the list of nftIds.

setNftIds

public TokenRejectTransaction setNftIds(List<NftId> nftIds)

A list of one or more token rejections (a single specific serialized non-fungible/unique token).

Parameters:

nftIds - the list of nftIds.

Returns:

this

addNftId

public TokenRejectTransaction addNftId(NftId nftId)

Add a nft to the list of nfts.

Parameters:

nftId - nft to add.

Returns:

this

build

TokenRejectTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenRejectTransactionBody

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenRejectTransaction>

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<TokenRejectTransaction,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<TokenRejectTransaction>

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<TokenRejectTransaction>