adobe.pdfservices.operation.config.notifier package

Submodules

adobe.pdfservices.operation.config.notifier.callback_notifier_data module

class adobe.pdfservices.operation.config.notifier.callback_notifier_data.CallbackNotifierData(url: str, *, headers: Dict = None)

Bases: NotifierData

Represents the configuration for the notifier data.

Constructs an instance of CallbackNotifierData.

Parameters:

  • url (str) – Callback URL, can not be None

  • headers (dict) – Callback headers. (Optional, use key-value)

json_hint = {'headers': 'headers', 'url': 'url'}

For JSON Representation of this class, used internally by SDK.

to_json()
Returns:

Representation of CallbackNotifierData as a JSON string, used internally by the SDK.

Return type:

str

adobe.pdfservices.operation.config.notifier.notifier_config module

class adobe.pdfservices.operation.config.notifier.notifier_config.NotifierConfig(notifier_type: NotifierType, notifier_data: NotifierData)

Bases: object

Represents the configuration for a notifier to be used to notify user about the completion of a PDFServicesJob.

Constructs an instance of NotifierConfig.

Parameters:

  • notifier_type (NotifierType) – specifies the type of notifier; can not be None.

  • notifier_data (NotifierData) – encapsulates callback notifier data; can not be None.

json_hint = {'notifier_data': 'data', 'notifier_type': 'type'}

For JSON Representation of this class, used internally by SDK.

to_json()
Returns:

representation of NotifierConfig as a JSON string, used internally by the SDK.

Return type:

str

adobe.pdfservices.operation.config.notifier.notifier_data module

class adobe.pdfservices.operation.config.notifier.notifier_data.NotifierData

Bases: ABC

This abstract class represents the basic contract for the notifier data to be used with NotifierConfig

adobe.pdfservices.operation.config.notifier.notifier_type module

class adobe.pdfservices.operation.config.notifier.notifier_type.NotifierType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Notifier Type Mapping.

CALLBACK = 'CALLBACK'

Callback notifier type.

Module contents