Interface CheckCancel
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableCheckCancel
Cancels an unredeemed Check, removing it from the ledger without sending any money. The source or the
destination of the check can cancel a Check at any time using this transaction type.
If the Check has expired, any address can cancel it.
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionstatic ImmutableCheckCancel.Builderbuilder()Construct a builder for this class.checkId()The ID of the Check ledger object to cancel, as a 64-character hexadecimal string.default TransactionFlagsflags()Set ofTransactionFlagss for thisCheckCancel, which only allows thetfFullyCanonicalSigflag, which is deprecated.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableCheckCancel.Builder.
-
flags
Set ofTransactionFlagss for thisCheckCancel, which only allows thetfFullyCanonicalSigflag, which is deprecated.The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.
- Returns:
- Always
TransactionFlags.EMPTY.
-
checkId
Hash256 checkId()The ID of the Check ledger object to cancel, as a 64-character hexadecimal string.- Returns:
- A
Hash256containing the ID of the Check ledger object in hexadecimal form.
-