on_passphrase_needed Event

Requests a data protection password from the application.

Syntax

class PGPReaderPassphraseNeededEventParams(object):
  @property
  def passphrase() -> str: ...
  @passphrase.setter
  def passphrase(value) -> None: ...
  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...

# In class PGPReader:
@property
def on_passphrase_needed() -> Callable[[PGPReaderPassphraseNeededEventParams], None]: ...
@on_passphrase_needed.setter
def on_passphrase_needed(event_hook: Callable[[PGPReaderPassphraseNeededEventParams], None]) -> None: ...

Remarks

The class fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.

The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.