pdftools_sdk.sign.timestamp_configuration

Classes

TimestampConfiguration(handle)

Configuration for adding time-stamps
class pdftools_sdk.sign.timestamp_configuration.TimestampConfiguration(handle)[source]

Bases: _NativeObject, ABC

Configuration for adding time-stamps

This configuration controls the creation of time-stamps in pdftools_sdk.sign.signer.Signer.add_timestamp() .

Use a pdftools_sdk.crypto.providers.provider.Provider to create a time-stamp configuration.

Note that this object can be re-used to add time-stamps to multiple documents for mass-signing applications.

property field_name: str | None

The name of the existing signature field

The pdftools_sdk.pdf.signature_field.SignatureField.field_name of an existing, unsigned signature field to time-stamp. Note that when an existing signature field is used, the appearance’s position is defined by the existing field. Therefore, make sure the pdftools_sdk.sign.timestamp_configuration.TimestampConfiguration.appearance fits into the pdftools_sdk.pdf.signature_field.SignatureField.bounding_box .

If None, a new signature field is created using a unique field name.

Default is None

Returns:

Optional[str]

Raises:

StateError – If the creating provider has already been closed

property appearance: Appearance | None

The visual appearance of the time-stamp

The visual appearance or None to create a time-stamp without a visual appearance.

For time-stamps, not all text variables are available, most notably the [signature:name].

Default is None

Returns:

Optional[pdftools_sdk.sign.appearance.Appearance]

Raises:

StateError – If the creating provider has already been closed