PDFTron WebViewer

Class: EmbeddedTimestampVerificationResult

PDFNet. EmbeddedTimestampVerificationResult

new EmbeddedTimestampVerificationResult()

This class represents the result of verifying a secure embedded timestamp digital signature.

Extends

Methods

destroy()

Destructor
Inherited From:
Returns:
Type
Promise.<void>

getCMSDigestStatus()

Retrieves the result condition associated with the CMS signed digest verification step.
Returns:
A promise that resolves to a DigestStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.DigestStatus = {
	e_digest_invalid : 0
	e_digest_verified : 1
	e_digest_verification_disabled : 2
	e_weak_digest_algorithm_but_digest_verifiable : 3
	e_no_digest_status : 4
	e_unsupported_encoding : 5
}
</pre>

getCMSDigestStatusAsString()

Retrieves the result condition associated with the CMS signed digest verification step, as a descriptive string.
Returns:
A promise that resolves to a string
Type
Promise.<string>

getCMSSignatureDigestAlgorithm()

Retrieves an enumeration value representing the digest algorithm used to sign the timestamp token.
Returns:
A promise that resolves to a DigestAlgorithm enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.DigestAlgorithm.Type = {
	e_SHA1 : 0
	e_SHA256 : 1
	e_SHA384 : 2
	e_SHA512 : 3
	e_RIPEMD160 : 4
	e_unknown_digest_algorithm : 5
}
</pre>

getMessageImprintDigestAlgorithm()

Retrieves an enumeration value representing the digest algorithm used inside the message imprint field of the timestamp to digest the main signature value.
Returns:
A promise that resolves to a DigestAlgorithm enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.DigestAlgorithm.Type = {
	e_SHA1 : 0
	e_SHA256 : 1
	e_SHA384 : 2
	e_SHA512 : 3
	e_RIPEMD160 : 4
	e_unknown_digest_algorithm : 5
}
</pre>

getMessageImprintDigestStatus()

Retrieves the result condition associated with the message imprint digest verification step.
Returns:
A promise that resolves to a DigestStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.DigestStatus = {
	e_digest_invalid : 0
	e_digest_verified : 1
	e_digest_verification_disabled : 2
	e_weak_digest_algorithm_but_digest_verifiable : 3
	e_no_digest_status : 4
	e_unsupported_encoding : 5
}
</pre>

getMessageImprintDigestStatusAsString()

Retrieves the result condition associated with the message imprint digest verification step, as a descriptive string.
Returns:
A promise that resolves to a string
Type
Promise.<string>

getTrustStatus()

Retrieves the result condition associated with the trust verification step.
Returns:
A promise that resolves to a TrustStatus-type enumeration value.
Type
Promise.<number>
Example
Return value enum:
<pre>
PDFNet.VerificationResult.TrustStatus = {
	e_trust_verified : 0
	e_untrusted : 1
	e_trust_verification_disabled : 2
	e_no_trust_status : 3
}
</pre>

getTrustStatusAsString()

Retrieves the result condition associated with the trust verification step, as a descriptive string.
Returns:
A promise that resolves to a string
Type
Promise.<string>

getTrustVerificationResult()

Retrieves the detailed result associated with the trust step of the verification operation that returned this EmbeddedTimestampVerificationResult, if such a detailed trust result is available. Must call HasTrustVerificationResult first and check for a true result.
Returns:
A promise that resolves to a TrustVerificationResult object.
Type
Promise.<PDFNet.TrustVerificationResult>

getUnsupportedFeatures()

Retrieves reports about unsupported features encountered during verification of the timestamp. Current possible values: "GeneralizedTime format with length ", "unsupported digest algorithm"
Returns:
A promise that resolves to a container of strings representing unsupported features encountered during verification of the timestamp
Type
Promise.<Array.<string>>

getVerificationStatus()

Retrieves the main verification status. The main status is determined based on the other statuses.
Returns:
A promise that resolves to a boolean representing whether or not the verification operation was completely successful.
Type
Promise.<boolean>

hasTrustVerificationResult()

Returns whether there is a detailed TrustVerificationResult in this EmbeddedTimestampVerificationResult.
Returns:
A promise that resolves to a boolean
Type
Promise.<boolean>

takeOwnership()

Take the ownership of this object, so that PDFNet.runWithCleanup won't destroy this object.
Inherited From:
Returns:
Type
void