PDFTron pdfnet-node

Class: TimestampingConfiguration

PDFNet. TimestampingConfiguration

new TimestampingConfiguration()

A class representing a set of options for timestamping a document.

Extends

Methods

<static> createFromURL(in_url)

Constructor.
Parameters:
Name Type Description
in_url string - a string representing a URL of a timestamp authority (TSA) to use during timestamping
Returns:
A promise that resolves to an object of type: "PDFNet.TimestampingConfiguration"
Type
Promise.<PDFNet.TimestampingConfiguration>

destroy()

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

setTimestampAuthorityServerPassword(in_password)

Setter for a password to use during timestamping.
Parameters:
Name Type Description
in_password string - a string representing a password.
Returns:
Type
Promise.<void>

setTimestampAuthorityServerURL(in_url)

Setter to change the timestamp authority (TSA) URL to use during timestamping.
Parameters:
Name Type Description
in_url string - a string representing a URL of a timestamp authority.
Returns:
Type
Promise.<void>

setTimestampAuthorityServerUsername(in_username)

Setter for a username to use during timestamping.
Parameters:
Name Type Description
in_username string - a string representing a username.
Returns:
Type
Promise.<void>

setUseNonce(in_use_nonce)

Setter for whether to use a nonce (unique random number) during timestamping. This is on by default, and should be on whenever a timestamp authority supports it, because it helps prevent replay attacks.
Parameters:
Name Type Description
in_use_nonce boolean - a boolean value representing whether or not to use a nonce
Returns:
Type
Promise.<void>

takeOwnership()

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

testConfiguration(in_opts)

Tests a timestamping configuration for usability and reports any failures. This function does not throw on many common failures, unlike the real signing, thereby allowing early diagnosis of things like connectivity issues with timestamp authorities.
Parameters:
Name Type Description
in_opts PDFNet.VerificationOptions - a set of verification options to try to use
Returns:
A promise that resolves to a result object containing information about the status of the configuration test and any errors that occurred during it.
Type
Promise.<PDFNet.TimestampingResult>