homeassistant.components.rest.notify Namespace Reference

Classes
class	RestNotificationService

Functions
RestNotificationService	async_get_service (HomeAssistant hass, ConfigType config, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_DATA = "data"
string	CONF_DATA_TEMPLATE = "data_template"
string	CONF_MESSAGE_PARAMETER_NAME = "message_param_name"
string	CONF_TARGET_PARAMETER_NAME = "target_param_name"
string	CONF_TITLE_PARAMETER_NAME = "title_param_name"
string	DEFAULT_MESSAGE_PARAM_NAME = "message"
string	DEFAULT_METHOD = "GET"
bool	DEFAULT_VERIFY_SSL = True
	PLATFORM_SCHEMA

Detailed Description

RESTful platform for notify component.

Function Documentation

async_get_service()

RestNotificationService homeassistant.components.rest.notify.async_get_service	(	HomeAssistant	hass,
		ConfigType	config,
		DiscoveryInfoType | None	discovery_info = None
	)

Get the RESTful notification service.

Definition at line 76 of file notify.py.

Variable Documentation

_LOGGER

homeassistant.components.rest.notify._LOGGER = logging.getLogger(__name__)

private

Definition at line 73 of file notify.py.

CONF_DATA

string homeassistant.components.rest.notify.CONF_DATA = "data"

Definition at line 39 of file notify.py.

CONF_DATA_TEMPLATE

string homeassistant.components.rest.notify.CONF_DATA_TEMPLATE = "data_template"

Definition at line 40 of file notify.py.

CONF_MESSAGE_PARAMETER_NAME

string homeassistant.components.rest.notify.CONF_MESSAGE_PARAMETER_NAME = "message_param_name"

Definition at line 41 of file notify.py.

CONF_TARGET_PARAMETER_NAME

string homeassistant.components.rest.notify.CONF_TARGET_PARAMETER_NAME = "target_param_name"

Definition at line 42 of file notify.py.

CONF_TITLE_PARAMETER_NAME

string homeassistant.components.rest.notify.CONF_TITLE_PARAMETER_NAME = "title_param_name"

Definition at line 43 of file notify.py.

DEFAULT_MESSAGE_PARAM_NAME

string homeassistant.components.rest.notify.DEFAULT_MESSAGE_PARAM_NAME = "message"

Definition at line 44 of file notify.py.

DEFAULT_METHOD

string homeassistant.components.rest.notify.DEFAULT_METHOD = "GET"

Definition at line 45 of file notify.py.

DEFAULT_VERIFY_SSL

bool homeassistant.components.rest.notify.DEFAULT_VERIFY_SSL = True

Definition at line 46 of file notify.py.

PLATFORM_SCHEMA

homeassistant.components.rest.notify.PLATFORM_SCHEMA

Initial value:

=  NOTIFY_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_RESOURCE): cv.url,
        vol.Optional(
            CONF_MESSAGE_PARAMETER_NAME, default=DEFAULT_MESSAGE_PARAM_NAME
        ): cv.string,
        vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(
            ["POST", "GET", "POST_JSON"]
        ),
        vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.string}),
        vol.Optional(CONF_PARAMS): vol.Schema({cv.string: cv.string}),
        vol.Optional(CONF_NAME): cv.string,
        vol.Optional(CONF_TARGET_PARAMETER_NAME): cv.string,
        vol.Optional(CONF_TITLE_PARAMETER_NAME): cv.string,
        vol.Optional(CONF_DATA): vol.All(dict, cv.template_complex),
        vol.Optional(CONF_DATA_TEMPLATE): vol.All(dict, cv.template_complex),
        vol.Optional(CONF_AUTHENTICATION): vol.In(
            [HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]
        ),
        vol.Optional(CONF_PASSWORD): cv.string,
        vol.Optional(CONF_USERNAME): cv.string,
        vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
    }
)

Definition at line 48 of file notify.py.