homeassistant.helpers.collection.CollectionEntity Class Reference

Inheritance diagram for homeassistant.helpers.collection.CollectionEntity:

Collaboration diagram for homeassistant.helpers.collection.CollectionEntity:

Public Member Functions
None	async_update_config (self, ConfigType config)
CollectionEntity	from_storage (cls, ConfigType config)
CollectionEntity	from_yaml (cls, ConfigType config)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
StateType	state (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Mixin class for entities managed by an ObservableCollection.

Definition at line 114 of file collection.py.

Member Function Documentation

async_update_config()

None homeassistant.helpers.collection.CollectionEntity.async_update_config	(		self,
		ConfigType	config
	)

Handle updated configuration.

Reimplemented in homeassistant.components.schedule.Schedule.

Definition at line 128 of file collection.py.

from_storage()

CollectionEntity homeassistant.helpers.collection.CollectionEntity.from_storage	(		cls,
		ConfigType	config
	)

Create instance from storage.

Reimplemented in homeassistant.components.schedule.Schedule.

Definition at line 119 of file collection.py.

from_yaml()

CollectionEntity homeassistant.helpers.collection.CollectionEntity.from_yaml	(		cls,
		ConfigType	config
	)

Create instance from yaml config.

Reimplemented in homeassistant.components.schedule.Schedule.

Definition at line 124 of file collection.py.

---

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

• core/homeassistant/helpers/collection.py