Interface NfTokenOfferObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableNfTokenOfferObject

@Immutable public interface NfTokenOfferObject extends LedgerObject
An Offer returned in an NfTokenOfferObject list. Note that this object is NOT the same as the Offer ledger object.
  • Method Details

    • builder

      Construct a builder for this class.
      Returns:
      An ImmutableNfTokenOfferObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
      The type of ledger object. In this case, this is always "NfTokenOffer".
      Returns:
      Always LedgerObject.LedgerEntryType.NFTOKEN_OFFER.
    • amount

      CurrencyAmount amount()
      The amount expected or offered for the token.
      Returns:
      The CurrencyAmount.
    • owner

      Address owner()
      Address of the source account that created and owns the offer.
      Returns:
      The Address of the NfTokenOffer owner.
    • previousTransactionId

      Hash256 previousTransactionId()
      The identifying hash of the transaction that most recently modified this object.
      Returns:
      A Hash256 containing the previous transaction hash.
    • previousTransactionLedgerSequence

      com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()
      The index of the ledger that contains the transaction that most recently modified this object.
      Returns:
      An UnsignedInteger representing the previous transaction ledger sequence.
    • nfTokenId

      NfTokenId nfTokenId()
      The TokenId of the NfToken for which the offer has been created.
      Returns:
      NfTokenId of the NfToken.
    • expiration

      Optional<com.google.common.primitives.UnsignedInteger> expiration()
      A time after which this offer is considered unfunded, as the number of seconds since the Ripple Epoch.
      Returns:
      The offer's expiration.
    • destination

      Optional<Address> destination()
      The intended recipient of the NfTokenObject. This address will receive the NFToken when the offer is accepted.
      Returns:
      The Address of the destination.
    • ownerNode

      Optional<String> ownerNode()
      A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages. Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.
      Returns:
      A String containing the hint.
    • offerNode

      Optional<String> offerNode()
      A hint indicating which page of the token buy or sell offer directory links to this object.
      Returns:
      A String containing the hint.
    • flags

      A set of boolean NfTokenOfferFlags containing options enabled for this object.
      Returns:
      The NfTokenOfferFlags for this object.
    • index

      Hash256 index()
      The unique ID of this NfTokenOfferObject.
      Returns:
      A Hash256 containing the ID.