flexget.components.notify.notify module

class flexget.components.notify.notify.Notify

Bases: object

on_task_abort(task, config)

on_task_output(task, config)

prepare_config(config)

send_notification(task, *args, **kwargs)

schema = {'additionalProperties': False, 'error_minProperties': 'You must specify at least one of `entries` or `task` in your notify config.', 'minProperties': 1, 'properties': {'abort': {'properties': {'message': {'default': 'Reason: {{ task.abort_reason }}', 'type': 'string'}, 'title': {'default': 'Task {{ task.name }} has aborted!', 'type': 'string'}, 'via': {'items': {'allOf': [{'$ref': '/schema/plugins?interface=notifiers'}, {'error_maxProperties': 'Plugin options indented 2 more spaces than the first letter of the plugin name.', 'maxProperties': 1, 'minProperties': 1}]}, 'type': 'array'}}, 'required': ['via'], 'type': 'object'}, 'entries': {'additionalProperties': False, 'properties': {'message': {'default': '{% if series_name is defined %}{{ tvdb_series_name|d(series_name) }} {{series_id}} {{tvdb_ep_name|d()}}{% elif imdb_name is defined %}{{imdb_name}} {{imdb_year}}{% elif title is defined %}{{ title }}{% endif %}', 'type': 'string'}, 'template': {'type': 'string'}, 'title': {'default': '{{ title }}', 'type': 'string'}, 'via': {'items': {'allOf': [{'$ref': '/schema/plugins?interface=notifiers'}, {'error_maxProperties': 'Plugin options indented 2 more spaces than the first letter of the plugin name.', 'maxProperties': 1, 'minProperties': 1}]}, 'type': 'array'}, 'what': {'oneOf': [{'items': {'enum': ['entries', 'accepted', 'rejected', 'failed', 'undecided'], 'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'enum': ['entries', 'accepted', 'rejected', 'failed', 'undecided'], 'title': 'single value', 'type': 'string'}]}}, 'required': ['via'], 'type': 'object'}, 'task': {'additionalProperties': False, 'properties': {'always_send': {'default': False, 'type': 'boolean'}, 'message': {'type': 'string'}, 'template': {'default': 'default.template', 'type': 'string'}, 'title': {'default': '{% if not task.failed and not task.accepted %} Task {{task.name}} did not produce any entries.{% else %} [FlexGet] {{task.name}}:{% if task.failed %} {{task.failed|length}} failed entries.{% endif %}{% if task.accepted %} {{task.accepted|length}} new entries downloaded.{% endif %}{% endif %}', 'type': 'string'}, 'via': {'items': {'allOf': [{'$ref': '/schema/plugins?interface=notifiers'}, {'error_maxProperties': 'Plugin options indented 2 more spaces than the first letter of the plugin name.', 'maxProperties': 1, 'minProperties': 1}]}, 'type': 'array'}}, 'required': ['via'], 'type': 'object'}}, 'type': 'object'}

flexget.components.notify.notify.register_plugin()