homeassistant.components.mobile_app.websocket_api Namespace Reference

Functions
def	_ensure_webhook_access (func)
def	async_setup_commands (hass)
None	handle_push_notification_channel (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_push_notification_confirm (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Detailed Description

Mobile app websocket API.

Function Documentation

_ensure_webhook_access()

def homeassistant.components.mobile_app.websocket_api._ensure_webhook_access (   func )

private

Decorate WS function to ensure user owns the webhook ID.

Definition at line 24 of file websocket_api.py.

async_setup_commands()

def homeassistant.components.mobile_app.websocket_api.async_setup_commands

(

hass

)

Set up the mobile app websocket API.

Definition at line 18 of file websocket_api.py.

handle_push_notification_channel()

None homeassistant.components.mobile_app.websocket_api.handle_push_notification_channel	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Set up a direct push notification channel.

Definition at line 97 of file websocket_api.py.

handle_push_notification_confirm()

None homeassistant.components.mobile_app.websocket_api.handle_push_notification_confirm	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Confirm receipt of a push notification.

Definition at line 61 of file websocket_api.py.