Package org.xrpl.xrpl4j.model.ledger
Interface CredentialObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableCredentialObject
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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Construct a builder for this class.A (hex-encoded) value to identify the type of credential from the issuer.Optional<com.google.common.primitives.UnsignedInteger> Time after which the credential is expired, in seconds since the Ripple Epoch.flags()A set of booleanCredentialFlagscontaining options enabled for this object.index()The unique ID of theCredentialObject.issuer()The account that issued this credential.A hint indicating which page of the issuer's directory links to this entry, in case the directory consists of multiple pages.default LedgerObject.LedgerEntryTypeIndicates that this object is aCredentialObjectobject.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.The identifying hash of the transaction that most recently modified this object.subject()The account that this credential is for.A hint indicating which page of the subject's owner directory links to this entry, in case the directory consists of multiple pages.uri()Optional additional data about the credential (such as a link to the VC document).
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableCredentialObject.Builder.
-
ledgerEntryType
Indicates that this object is aCredentialObjectobject.- Returns:
- Always
LedgerObject.LedgerEntryType.CREDENTIAL.
-
subject
Address subject()The account that this credential is for.- Returns:
- The
Addressof 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
Stringcontaining the subject node hint.
-
issuer
Address issuer()The account that issued this credential.- Returns:
- The
Addressof 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
Stringcontaining the issuer node hint.
-
flags
CredentialFlags flags()A set of booleanCredentialFlagscontaining options enabled for this object.- Returns:
- The
CredentialFlagsfor this object.
-
previousTxnId
Hash256 previousTxnId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing 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
UnsignedIntegerrepresenting 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
CredentialTypedefining the type of credential.
-
uri
Optional<CredentialUri> 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
Optionalof typeCredentialUri.
-
expiration
Optional<com.google.common.primitives.UnsignedInteger> expiration()Time after which the credential is expired, in seconds since the Ripple Epoch.- Returns:
- An
Optionalof typeUnsignedInteger.
-
index
Hash256 index()The unique ID of theCredentialObject.- Returns:
- A
Hash256.
-