Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.area_registry.AreaRegistryItems Class Reference
Inheritance diagram for homeassistant.helpers.area_registry.AreaRegistryItems:
[legend]
Collaboration diagram for homeassistant.helpers.area_registry.AreaRegistryItems:
[legend]

Public Member Functions

None __init__ (self)
 
list[AreaEntryget_areas_for_floor (self, str floor)
 
list[AreaEntryget_areas_for_label (self, str label)
 
- Public Member Functions inherited from homeassistant.helpers.area_registry.AreaEntry
json_fragment json_fragment (self)
 
- Public Member Functions inherited from homeassistant.helpers.normalized_name_base_registry.NormalizedNameBaseRegistryEntry
None __post_init__ (self)
 

Private Member Functions

None _index_entry (self, str key, AreaEntry entry)
 
None _unindex_entry (self, str key, AreaEntry|None replacement_entry=None)
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.area_registry.AreaEntry
 compare
 
 default_factory
 
 dict
 
 False
 
 init
 
- Static Public Attributes inherited from homeassistant.helpers.normalized_name_base_registry.NormalizedNameBaseRegistryEntry
 datetime
 
 default_factory
 
 init
 
 str
 

Detailed Description

Class to hold area registry items.

Definition at line 151 of file area_registry.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.helpers.area_registry.AreaRegistryItems.__init__ (   self)
Initialize the area registry items.

Definition at line 154 of file area_registry.py.

Member Function Documentation

◆ _index_entry()

None homeassistant.helpers.area_registry.AreaRegistryItems._index_entry (   self,
str  key,
AreaEntry  entry 
)
private
Index an entry.

Definition at line 160 of file area_registry.py.

◆ _unindex_entry()

None homeassistant.helpers.area_registry.AreaRegistryItems._unindex_entry (   self,
str  key,
AreaEntry | None   replacement_entry = None 
)
private

Definition at line 168 of file area_registry.py.

◆ get_areas_for_floor()

list[AreaEntry] homeassistant.helpers.area_registry.AreaRegistryItems.get_areas_for_floor (   self,
str  floor 
)
Get areas for floor.

Definition at line 185 of file area_registry.py.

◆ get_areas_for_label()

list[AreaEntry] homeassistant.helpers.area_registry.AreaRegistryItems.get_areas_for_label (   self,
str  label 
)
Get areas for label.

Definition at line 180 of file area_registry.py.


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