homeassistant.helpers.restore_state.RestoreStateData Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass)
None	async_dump_states (self)
list[StoredState]	async_get_stored_states (self)
None	async_load (self)
None	async_restore_entity_added (self, RestoreEntity entity)
None	async_restore_entity_removed (self, str entity_id, ExtraStoredData|None extra_data)
None	async_save_persistent_states (cls, HomeAssistant hass)
None	async_setup (self)
None	async_setup_dump (self, *Any args)

Public Attributes
	last_states
	store

Detailed Description

Helper class for managing the helper saved data.

Definition at line 110 of file restore_state.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.restore_state.RestoreStateData.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the restore state data class.

Definition at line 118 of file restore_state.py.

Member Function Documentation

async_dump_states()

None homeassistant.helpers.restore_state.RestoreStateData.async_dump_states

(

self

)

Save the current state machine to storage.

Definition at line 201 of file restore_state.py.

async_get_stored_states()

list[StoredState] homeassistant.helpers.restore_state.RestoreStateData.async_get_stored_states

(

self

)

Get the set of states which should be stored.

This includes the states of all registered entities, as well as the
stored states from the previous run, which have not been created as
entities on this run, and have not expired.

Definition at line 158 of file restore_state.py.

async_load()

None homeassistant.helpers.restore_state.RestoreStateData.async_load

(

self

)

Load the instance of this data helper.

Definition at line 138 of file restore_state.py.

async_restore_entity_added()

None homeassistant.helpers.restore_state.RestoreStateData.async_restore_entity_added	(		self,
		RestoreEntity	entity
	)

Store this entity's state when hass is shutdown.

Definition at line 246 of file restore_state.py.

async_restore_entity_removed()

None homeassistant.helpers.restore_state.RestoreStateData.async_restore_entity_removed	(		self,
		str	entity_id,
		ExtraStoredData | None	extra_data
	)

Unregister this entity from saving state.

Definition at line 251 of file restore_state.py.

async_save_persistent_states()

None homeassistant.helpers.restore_state.RestoreStateData.async_save_persistent_states	(		cls,
		HomeAssistant	hass
	)

Dump states now.

Definition at line 114 of file restore_state.py.

async_setup()

None homeassistant.helpers.restore_state.RestoreStateData.async_setup

(

self

)

Set up up the instance of this data helper.

Definition at line 127 of file restore_state.py.

async_setup_dump()

None homeassistant.helpers.restore_state.RestoreStateData.async_setup_dump	(		self,
		*Any	args
	)

Set up the restore state listeners.

Definition at line 215 of file restore_state.py.

Member Data Documentation

last_states

homeassistant.helpers.restore_state.RestoreStateData.last_states

Definition at line 148 of file restore_state.py.

store

homeassistant.helpers.restore_state.RestoreStateData.store

Definition at line 121 of file restore_state.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/helpers/restore_state.py