on_decryption_info_needed Event

Requests decryption information during decryption, signing, or validation.

Syntax

class PDFVerifierDecryptionInfoNeededEventParams(object):
  @property
  def cancel_decryption() -> bool: ...
  @cancel_decryption.setter
  def cancel_decryption(value) -> None: ...

# In class PDFVerifier:
@property
def on_decryption_info_needed() -> Callable[[PDFVerifierDecryptionInfoNeededEventParams], None]: ...
@on_decryption_info_needed.setter
def on_decryption_info_needed(event_hook: Callable[[PDFVerifierDecryptionInfoNeededEventParams], None]) -> None: ...

Remarks

This event is fired when the component needs decryption information to be provided by the user.

Use encryption_type property to identify the document encryption type used, and then set password or decryption_certificate (decryption_certificates) properties accordingly.

The class fires this event repeatedly until suitable decryption information is provided. To terminate the operation, set CancelDecryption to true.