Classes
class	XmppNotificationService

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

def	async_send_message (sender, password, recipients, use_tls, verify_certificate, room, hass, message, timeout=None, data=None)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_DATA = "data"

string	ATTR_PATH = "path"

string	ATTR_PATH_TEMPLATE = "path_template"

string	ATTR_TIMEOUT = "timeout"

string	ATTR_URL = "url"

string	ATTR_URL_TEMPLATE = "url_template"

string	ATTR_VERIFY = "verify"

string	CONF_TLS = "tls"

string	CONF_VERIFY = "verify"

string	DEFAULT_CONTENT_TYPE = "application/octet-stream"

string	DEFAULT_RESOURCE = "home-assistant"

	force_starttls

	loop

	PLATFORM_SCHEMA

	use_ipv6

int	XEP_0363_TIMEOUT = 10

Detailed Description

Jabber (XMPP) notification service.

Function Documentation

◆ async_get_service()

XmppNotificationService homeassistant.components.xmpp.notify.async_get_service	(	HomeAssistant	hass,
		ConfigType	config,
		DiscoveryInfoType \| None	discovery_info = `None`
	)

Get the Jabber (XMPP) notification service.

Definition at line 72 of file notify.py.

◆ async_send_message()

def homeassistant.components.xmpp.notify.async_send_message	(	sender,
		password,
		recipients,
		use_tls,
		verify_certificate,
		room,
		hass,
		message,
		timeout = `None`,
		data = `None`
	)

Send a message over XMPP.

Definition at line 125 of file notify.py.

Variable Documentation

◆ _LOGGER

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

private

Definition at line 42 of file notify.py.

◆ ATTR_DATA

string homeassistant.components.xmpp.notify.ATTR_DATA = "data"

Definition at line 44 of file notify.py.

◆ ATTR_PATH

string homeassistant.components.xmpp.notify.ATTR_PATH = "path"

Definition at line 45 of file notify.py.

◆ ATTR_PATH_TEMPLATE

string homeassistant.components.xmpp.notify.ATTR_PATH_TEMPLATE = "path_template"

Definition at line 46 of file notify.py.

◆ ATTR_TIMEOUT

string homeassistant.components.xmpp.notify.ATTR_TIMEOUT = "timeout"

Definition at line 47 of file notify.py.

◆ ATTR_URL

string homeassistant.components.xmpp.notify.ATTR_URL = "url"

Definition at line 48 of file notify.py.

◆ ATTR_URL_TEMPLATE

string homeassistant.components.xmpp.notify.ATTR_URL_TEMPLATE = "url_template"

Definition at line 49 of file notify.py.

◆ ATTR_VERIFY

string homeassistant.components.xmpp.notify.ATTR_VERIFY = "verify"

Definition at line 50 of file notify.py.

◆ CONF_TLS

string homeassistant.components.xmpp.notify.CONF_TLS = "tls"

Definition at line 52 of file notify.py.

◆ CONF_VERIFY

string homeassistant.components.xmpp.notify.CONF_VERIFY = "verify"

Definition at line 53 of file notify.py.

◆ DEFAULT_CONTENT_TYPE

string homeassistant.components.xmpp.notify.DEFAULT_CONTENT_TYPE = "application/octet-stream"

Definition at line 55 of file notify.py.

◆ DEFAULT_RESOURCE

string homeassistant.components.xmpp.notify.DEFAULT_RESOURCE = "home-assistant"

Definition at line 56 of file notify.py.

◆ force_starttls

homeassistant.components.xmpp.notify.force_starttls

Definition at line 148 of file notify.py.

◆ loop

homeassistant.components.xmpp.notify.loop

Definition at line 146 of file notify.py.

◆ PLATFORM_SCHEMA

homeassistant.components.xmpp.notify.PLATFORM_SCHEMA

Initial value:

 =  NOTIFY_PLATFORM_SCHEMA.extend(
     {
         vol.Required(CONF_SENDER): cv.string,
         vol.Required(CONF_PASSWORD): cv.string,
         vol.Required(CONF_RECIPIENT): vol.All(cv.ensure_list, [cv.string]),
         vol.Optional(CONF_RESOURCE, default=DEFAULT_RESOURCE): cv.string,
         vol.Optional(CONF_ROOM, default=""): cv.string,
         vol.Optional(CONF_TLS, default=True): cv.boolean,
         vol.Optional(CONF_VERIFY, default=True): cv.boolean,
     }
 )

Definition at line 59 of file notify.py.

◆ use_ipv6

homeassistant.components.xmpp.notify.use_ipv6

Definition at line 149 of file notify.py.

◆ XEP_0363_TIMEOUT

int homeassistant.components.xmpp.notify.XEP_0363_TIMEOUT = 10

Definition at line 57 of file notify.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables