Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TokenUpdateNftsTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.TokenUpdateNftsTransaction

public class TokenUpdateNftsTransaction
extends Transaction<TokenUpdateNftsTransaction>

Modify the metadata field for an individual non-fungible/unique token (NFT). Updating the metadata of an NFT SHALL NOT affect ownership or the ability to transfer that NFT.
This transaction SHALL affect only the specific serial numbered tokens identified. This transaction SHALL modify individual token metadata.
This transaction MUST be signed by the token `metadata_key`.
The token `metadata_key` MUST be a valid `Key`.
The token `metadata_key` MUST NOT be an empty `KeyList`. ### Block Stream Effects None

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

Method Summary

Modifier and Type	Method	Description
TokenUpdateNftsTransaction	addSerial(long serial)	Add a serial number to the list of serial numbers.
(package private) TokenUpdateNftsTransactionBody.Builder	build()	Build the transaction body.
byte[]	getMetadata()	Extract the metadata.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
List<Long>	getSerials()	Extract the list of serial numbers.
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.
TokenUpdateNftsTransaction	setMetadata(byte[] metadata)	A new value for the metadata.
TokenUpdateNftsTransaction	setSerials(List<Long> serials)	A list of serial numbers to be updated.
TokenUpdateNftsTransaction	setTokenId(TokenId tokenId)	A token identifier. This is the token type (i.e.
(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

TokenUpdateNftsTransaction

public TokenUpdateNftsTransaction()

Constructor.

TokenUpdateNftsTransaction

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

TokenUpdateNftsTransaction

TokenUpdateNftsTransaction(TransactionBody txBody)

Method Details

getTokenId

@Nullable
public TokenId getTokenId()

Extract the token id.

Returns:

the token id

setTokenId

public TokenUpdateNftsTransaction setTokenId(@Nullable
 TokenId tokenId)

A token identifier.
This is the token type (i.e. collection) for which to update NFTs.

This field is REQUIRED.
The identified token MUST exist, MUST NOT be paused, MUST have the type non-fungible/unique, and MUST have a valid `metadata_key`.

Parameters:

tokenId - the token id

Returns:

this

getSerials

public List<Long> getSerials()

Extract the list of serial numbers.

Returns:

the list of serial numbers

setSerials

public TokenUpdateNftsTransaction setSerials(List<Long> serials)

A list of serial numbers to be updated.

This field is REQUIRED.
This list MUST have at least one(1) entry.
This list MUST NOT have more than ten(10) entries.

Parameters:

serials - the list of serial numbers

Returns:

this

addSerial

public TokenUpdateNftsTransaction addSerial(@Nonnegative
 long serial)

Add a serial number to the list of serial numbers.

Parameters:

serial - the serial number to add

Returns:

this

getMetadata

@Nullable
public byte[] getMetadata()

Extract the metadata.

Returns:

the metadata

setMetadata

public TokenUpdateNftsTransaction setMetadata(byte[] metadata)

A new value for the metadata.

If this field is not set, the metadata SHALL NOT change.
This value, if set, MUST NOT exceed 100 bytes.

Parameters:

metadata - the metadata

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

TokenUpdateNftsTransactionBody.Builder build()

Build the transaction body.

Returns:

TokenUpdateNftsTransactionBody

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<TokenUpdateNftsTransaction>

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

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