homeassistant.components.frontend.storage Namespace Reference

Functions
None	_initialize_frontend_storage (HomeAssistant hass)
None	async_setup_frontend_storage (HomeAssistant hass)
tuple[Store, dict[str, Any]]	async_user_store (HomeAssistant hass, str user_id)
None	websocket_get_user_data (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Store store, dict[str, Any] data)
None	websocket_set_user_data (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Store store, dict[str, Any] data)
Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None]]	with_store (Callable[[HomeAssistant, ActiveConnection, dict[str, Any], Store, dict[str, Any]], Coroutine[Any, Any, None],] orig_func)

Variables
string	DATA_STORAGE = "frontend_storage"
int	STORAGE_VERSION_USER_DATA = 1

Detailed Description

API for persistent storage for the frontend.

Function Documentation

_initialize_frontend_storage()

None homeassistant.components.frontend.storage._initialize_frontend_storage ( HomeAssistant  hass )

private

Set up frontend storage.

Definition at line 21 of file storage.py.

async_setup_frontend_storage()

None homeassistant.components.frontend.storage.async_setup_frontend_storage

(

HomeAssistant

hass

)

Set up frontend storage.

Definition at line 28 of file storage.py.

async_user_store()

tuple[Store, dict[str, Any]] homeassistant.components.frontend.storage.async_user_store	(	HomeAssistant	hass,
		str	user_id
	)

Access a user store.

Definition at line 35 of file storage.py.

websocket_get_user_data()

None homeassistant.components.frontend.storage.websocket_get_user_data	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		Store	store,
		dict[str, Any]	data
	)

Handle get global data command.

Async friendly.

Definition at line 108 of file storage.py.

websocket_set_user_data()

None homeassistant.components.frontend.storage.websocket_set_user_data	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg,
		Store	store,
		dict[str, Any]	data
	)

Handle set global data command.

Async friendly.

Definition at line 87 of file storage.py.

with_store()

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None] ] homeassistant.components.frontend.storage.with_store

(

Callable[ [HomeAssistant, ActiveConnection, dict[str, Any], Store, dict[str, Any]], Coroutine[Any, Any, None], ]

orig_func

)

Decorate function to provide data.

Definition at line 54 of file storage.py.

Variable Documentation

DATA_STORAGE

string homeassistant.components.frontend.storage.DATA_STORAGE = "frontend_storage"

Definition at line 16 of file storage.py.

STORAGE_VERSION_USER_DATA

int homeassistant.components.frontend.storage.STORAGE_VERSION_USER_DATA = 1

Definition at line 17 of file storage.py.