homeassistant.components.backup.websocket Namespace Reference

Functions
None	async_register_websocket_handlers (HomeAssistant hass, bool with_hassio)
None	handle_backup_end (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_backup_start (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_create (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_details (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_info (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_remove (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	handle_restore (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Detailed Description

Websocket commands for the Backup integration.

Function Documentation

async_register_websocket_handlers()

None homeassistant.components.backup.websocket.async_register_websocket_handlers	(	HomeAssistant	hass,
		bool	with_hassio
	)

Register websocket commands.

Definition at line 14 of file websocket.py.

handle_backup_end()

None homeassistant.components.backup.websocket.handle_backup_end	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Backup end notification.

Definition at line 145 of file websocket.py.

handle_backup_start()

None homeassistant.components.backup.websocket.handle_backup_start	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Backup start notification.

Definition at line 123 of file websocket.py.

handle_create()

None homeassistant.components.backup.websocket.handle_create	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Generate a backup.

Definition at line 110 of file websocket.py.

handle_details()

None homeassistant.components.backup.websocket.handle_details	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Get backup details for a specific slug.

Definition at line 56 of file websocket.py.

handle_info()

None homeassistant.components.backup.websocket.handle_info	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

List all stored backups.

Definition at line 31 of file websocket.py.

handle_remove()

None homeassistant.components.backup.websocket.handle_remove	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Remove a backup.

Definition at line 79 of file websocket.py.

handle_restore()

None homeassistant.components.backup.websocket.handle_restore	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Restore a backup.

Definition at line 97 of file websocket.py.