Interface CredentialObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableCredentialObject

@Immutable public interface CredentialObject extends LedgerObject
A Credential object represents a credential, which contains an attestation about a subject account from a credential issuer account. The meaning of the attestation is defined by the issuer.
  • Method Details

    • builder

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

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
      Indicates that this object is a CredentialObject object.
      Returns:
      Always LedgerObject.LedgerEntryType.CREDENTIAL.
    • subject

      Address subject()
      The account that this credential is for.
      Returns:
      The Address of the credential recipient.
    • subjectNode

      String subjectNode()
      A hint indicating which page of the subject's owner directory links to this entry, in case the directory consists of multiple pages.
      Returns:
      A String containing the subject node hint.
    • issuer

      Address issuer()
      The account that issued this credential.
      Returns:
      The Address of the credential issuer.
    • issuerNode

      String issuerNode()
      A hint indicating which page of the issuer's directory links to this entry, in case the directory consists of multiple pages.
      Returns:
      A String containing the issuer node hint.
    • flags

      A set of boolean CredentialFlags containing options enabled for this object.
      Returns:
      The CredentialFlags for this object.
    • previousTxnId

      Hash256 previousTxnId()
      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:
      A UnsignedInteger representing the previous transaction sequence.
    • credentialType

      CredentialType credentialType()
      A (hex-encoded) value to identify the type of credential from the issuer. This field is limited to a maximum length of 64 bytes.
      Returns:
      A CredentialType defining the type of credential.
    • uri

      Optional additional data about the credential (such as a link to the VC document). This field isn't checked for validity and is limited to a maximum length of 256 bytes.
      Returns:
      An Optional of type CredentialUri.
    • expiration

      Optional<com.google.common.primitives.UnsignedInteger> expiration()
      Time after which the credential is expired, in seconds since the Ripple Epoch.
      Returns:
      An Optional of type UnsignedInteger.
    • index

      Hash256 index()
      The unique ID of the CredentialObject.
      Returns:
      A Hash256.