flexget.components.notify.notifiers.join module

class flexget.components.notify.notifiers.join.JoinNotifier

Bases: object

Send Join notifications.

Example:

notify:
  entries:
    via:
      - join:
          [api_key: <API_KEY> (your join api key. Only required for 'group' notifications)]
          [group: <GROUP_NAME> (name of group of join devices to notify. 'all', 'android', etc.)
          [device: <DEVICE_ID> (can also be a list of device ids)]
          [url: <NOTIFICATION_URL>]
          [sms_number: <NOTIFICATION_SMS_NUMBER>]
          [icon: <NOTIFICATION_ICON>]

notify(title, message, config)

Send Join notifications.

schema = {'additionalProperties': False, 'error_not': "Cannot select both 'device' and 'group'", 'not': {'required': ['device', 'group']}, 'properties': {'api_key': {'type': 'string'}, 'device': {'oneOf': [{'items': {'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'title': 'single value', 'type': 'string'}]}, 'device_name': {'oneOf': [{'items': {'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'title': 'single value', 'type': 'string'}]}, 'group': {'enum': ['all', 'android', 'chrome', 'windows10', 'phone', 'tablet', 'pc'], 'type': 'string'}, 'icon': {'type': 'string'}, 'priority': {'maximum': 2, 'minimum': -2, 'type': 'integer'}, 'sms_number': {'type': 'string'}, 'url': {'type': 'string'}}, 'required': ['api_key'], 'type': 'object'}

flexget.components.notify.notifiers.join.register_plugin()