on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class PDFSignerNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class PDFSigner: @property def on_notification() -> Callable[[PDFSignerNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[PDFSignerNotificationEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
| DocumentLoaded | Reports the completion of PDF document processing by the component. Use the event handler to access document-related information, such as page number and document file details. The EventParam value passed with this EventID is empty. |
| TimestampRequest | A timestamp is requested from the custom timestamping
authority. This event is only fired if timestamp_server was set to a
virtual:// URI. The EventParam parameter contains the
TSP request (or the plain hash, depending on the value provided to
timestamp_server), in base16, that needs to be sent to the TSA.
Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |
| SignatureWidgetPrepare | Another copy of the signature widget needs
to be configured. Use the event handler to configure individual widgets
when creating multi-widget signatures. The on_notification event with this
event ID will be fired repeatedly until the LastSignatureWidget
configuration property is set to true.
The EventParam value passed with this EventID is empty. |