homeassistant.helpers.collection.ObservableCollection Class Reference

Inheritance diagram for homeassistant.helpers.collection.ObservableCollection:

Collaboration diagram for homeassistant.helpers.collection.ObservableCollection:

Public Member Functions
None	__init__ (self, IDManager|None id_manager)
Callable[[], None]	async_add_change_set_listener (self, ChangeSetListener listener)
Callable[[], None]	async_add_listener (self, ChangeListener listener)
list[_ItemT]	async_items (self)
None	notify_changes (self, Iterable[CollectionChange] change_set)

Public Attributes
	id_manager

Detailed Description

Base collection type that can be observed.

Definition at line 132 of file collection.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.collection.ObservableCollection.__init__	(		self,
		IDManager | None	id_manager
	)

Base collection type that can be observed.

Initialize the base collection.

Definition at line 135 of file collection.py.

Member Function Documentation

async_add_change_set_listener()

Callable[[], None] homeassistant.helpers.collection.ObservableCollection.async_add_change_set_listener	(		self,
		ChangeSetListener	listener
	)

Add a listener for a full change set.

Will be called with [(change_type, item_id, updated_config), ...]

Definition at line 159 of file collection.py.

async_add_listener()

Callable[[], None] homeassistant.helpers.collection.ObservableCollection.async_add_listener	(		self,
		ChangeListener	listener
	)

Add a listener.

Will be called with (change_type, item_id, updated_config).

Definition at line 150 of file collection.py.

async_items()

list[_ItemT] homeassistant.helpers.collection.ObservableCollection.async_items

(

self

)

Return list of items in collection.

Definition at line 145 of file collection.py.

notify_changes()

None homeassistant.helpers.collection.ObservableCollection.notify_changes	(		self,
		Iterable[CollectionChange]	change_set
	)

Notify listeners of a change.

Definition at line 169 of file collection.py.

Member Data Documentation

id_manager

homeassistant.helpers.collection.ObservableCollection.id_manager

Definition at line 137 of file collection.py.

---

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

• core/homeassistant/helpers/collection.py