Webhook Trigger Helper

class AzuracastPy.models.webhook.TriggerHelper(_webhook)

Provides functions for working with the triggers of a webhook.

__init__(_webhook): Initializes a TriggerHelper instance.

Note

This class should not be initialized directly. Instead, obtain an instance via: webhook.trigger.

add(*args: WebhookTriggers)

Adds one or more triggers to the webhook.

Parameters:: args – The trigger(s) to be added to the webhook. All arguments must be from the WebhookTriggers enum.

Usage:

from AzuracastPy.enums import WebhookTriggers

webhook.trigger.add(WebhookTriggers.SONG_CHANGED)

webhook.trigger.add(
    WebhookTriggers.SONG_CHANGED,
    WebhookTriggers.LIVE_CONNECT
)

remove(*args: WebhookTriggers)

Removes one or more triggers from the webhook.

Parameters:: args – The trigger(s) to be removed from the webhook. All arguments must be from the WebhookTriggers enum.

Usage:

from AzuracastPy.enums import WebhookTriggers

webhook.trigger.remove(WebhookTriggers.SONG_CHANGED)

webhook.trigger.remove(
    WebhookTriggers.SONG_CHANGED,
    WebhookTriggers.LIVE_CONNECT
)