handlers.conditionally_delete_subscriptions_handler

class ConditionallyDeleteSubscriptionsHandler(handlers.eventhandler.EventHandler):

Whenever all conditions are fulfilled, we delete all subscriptions.

Configuration:
condition: Key/value pair that will be checked, e.g. approvalStatus: approved. If the condition holds true, we will set the field as specified. If the condition value starts with "!", the condition is negated (must not match).

name = 'Conditionally delete all subscriptions'

description = 'Whenever certain conditions are fulfilled, delete all subscriptions of the fact sheet.'

conditions = {'event_types': ['FactSheetUpdatedEvent']}

supports_initial_sync = True

config_template = {'fs_types': ['Application'], 'set_quality_seal_on_error': 'BROKEN_QUALITY_SEAL', 'condition': {'lifecycle_status': 'endOfLife'}}

def data_requirements(self):

Declare the exact fact-sheet data this handler needs, so the webhook event loop (process_event in workspace/views_module.py) can load a single lean FastFactSheet per event instead of the full fact sheet.

Return a dict: { "fields": [], "relations": [], "subscriptions": bool, # True if handle() reads fs["subscriptions"] "tags": bool, # True if handle() reads tags / has_tag() "documents": bool, "acls": bool, "completion": bool, # True if handle() reads fs["completion"] "base_fields": [], # optional; omit/None = full # default base field set. A list restricts the # base scalars to just those (id and type are # always loaded). Advanced opt-in for max speed. } Fields referenced by this handler's trigger are folded in automatically by the event loop (into "fields"), so only declare what handle() itself needs on top of them.

Return None (the default) to signal "requirements cannot be declared statically" - e.g. handlers that exec/eval config-supplied code. The event loop then loads the full fact sheet for that event, so correctness is always preserved. This is a standalone hook (deliberately not tied to the initial_sync_* hooks, which are slated to migrate onto it later).

def handle(self, event, fs, **kwargs):

Called automatically whenever a matching event comes in via webhook.

Inherited Members

handlers.eventhandler.EventHandler: EventHandler; get_trigger; get_event_types; get_fs_types; get; all; lx_client; initial_sync_event; update_with_uniqueness_check; facet_matches; is_tag_key; SUBSCRIPTION_TYPES; parse_subscription_key; get_mapped_subscriptions; get_notification_users; get_send_email_for_users; get_email_callback; get_due_date