homeassistant.helpers.category_registry.CategoryRegistry Class Reference

Inheritance diagram for homeassistant.helpers.category_registry.CategoryRegistry:

Collaboration diagram for homeassistant.helpers.category_registry.CategoryRegistry:

Public Member Functions
None	__init__ (self, HomeAssistant hass)
CategoryEntry	async_create (self, *str name, str scope, str|None icon=None)
None	async_delete (self, *str scope, str category_id)
CategoryEntry|None	async_get_category (self, *str scope, str category_id)
Iterable[CategoryEntry]	async_list_categories (self, *str scope)
None	async_load (self)
CategoryEntry	async_update (self, *str scope, str category_id, str|None|UndefinedType icon=UNDEFINED, str|UndefinedType name=UNDEFINED)

Public Attributes
	categories
	hass

Private Member Functions
None	_async_ensure_name_is_available (self, str scope, str name, str|None category_id=None)
CategoryRegistryStoreData	_data_to_save (self)

Private Attributes
	_store

Detailed Description

Class to hold a registry of categories by scope.

Definition at line 93 of file category_registry.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.category_registry.CategoryRegistry.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the category registry.

Definition at line 96 of file category_registry.py.

Member Function Documentation

_async_ensure_name_is_available()

None homeassistant.helpers.category_registry.CategoryRegistry._async_ensure_name_is_available (   self, str  scope, str  name, str | None   category_id = None  )

private

Ensure name is available within the scope.

Definition at line 247 of file category_registry.py.

_data_to_save()

CategoryRegistryStoreData homeassistant.helpers.category_registry.CategoryRegistry._data_to_save (   self )

private

Return data of category registry to store in a file.

Definition at line 228 of file category_registry.py.

async_create()

CategoryEntry homeassistant.helpers.category_registry.CategoryRegistry.async_create	(		self,
		*str	name,
		str	scope,
		str | None	icon = None
	)

Create a new category.

Definition at line 125 of file category_registry.py.

async_delete()

None homeassistant.helpers.category_registry.CategoryRegistry.async_delete	(		self,
		*str	scope,
		str	category_id
	)

Delete category.

Definition at line 155 of file category_registry.py.

async_get_category()

CategoryEntry | None homeassistant.helpers.category_registry.CategoryRegistry.async_get_category	(		self,
		*str	scope,
		str	category_id
	)

Get category by ID.

Definition at line 109 of file category_registry.py.

async_list_categories()

Iterable[CategoryEntry] homeassistant.helpers.category_registry.CategoryRegistry.async_list_categories	(		self,
		*str	scope
	)

Get all categories.

Definition at line 118 of file category_registry.py.

async_load()

None homeassistant.helpers.category_registry.CategoryRegistry.async_load

(

self

)

Load the category registry.

Definition at line 207 of file category_registry.py.

async_update()

CategoryEntry homeassistant.helpers.category_registry.CategoryRegistry.async_update	(		self,
		*str	scope,
		str	category_id,
		str | None | UndefinedType	icon = UNDEFINED,
		str | UndefinedType	name = UNDEFINED
	)

Update name or icon of the category.

Definition at line 170 of file category_registry.py.

Member Data Documentation

_store

homeassistant.helpers.category_registry.CategoryRegistry._store

private

Definition at line 100 of file category_registry.py.

categories

homeassistant.helpers.category_registry.CategoryRegistry.categories

Definition at line 225 of file category_registry.py.

hass

homeassistant.helpers.category_registry.CategoryRegistry.hass

Definition at line 98 of file category_registry.py.

---

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

• core/homeassistant/helpers/category_registry.py