homeassistant.components.configurator.Configurator Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass)
None	async_handle_service_call (self, ServiceCall call)
None	async_notify_errors (self, str request_id, str error)
str	async_request_config (self, str name, ConfiguratorCallback|None callback, str|None description, str|None submit_caption, list[dict[str, str]]|None fields, str|None entity_picture)
None	async_request_done (self, str request_id)

Public Attributes
	hass

Private Member Functions
str	_generate_unique_id (self)
bool	_validate_request_id (self, str request_id)

Private Attributes
	_cur_id

Detailed Description

The class to keep track of current configuration requests.

Definition at line 149 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.configurator.Configurator.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the configurator.

Definition at line 152 of file __init__.py.

Member Function Documentation

_generate_unique_id()

str homeassistant.components.configurator.Configurator._generate_unique_id (   self )

private

Generate a unique configurator ID.

Definition at line 259 of file __init__.py.

_validate_request_id()

bool homeassistant.components.configurator.Configurator._validate_request_id (   self, str  request_id  )

private

Validate that the request belongs to this instance.

Definition at line 264 of file __init__.py.

async_handle_service_call()

None homeassistant.components.configurator.Configurator.async_handle_service_call	(		self,
		ServiceCall	call
	)

Handle a configure service call.

Definition at line 242 of file __init__.py.

async_notify_errors()

None homeassistant.components.configurator.Configurator.async_notify_errors	(		self,
		str	request_id,
		str	error
	)

Update the state with errors.

Definition at line 206 of file __init__.py.

async_request_config()

str homeassistant.components.configurator.Configurator.async_request_config	(		self,
		str	name,
		ConfiguratorCallback | None	callback,
		str | None	description,
		str | None	submit_caption,
		list[dict[str, str]] | None	fields,
		str | None	entity_picture
	)

Set up a request for configuration.

Definition at line 164 of file __init__.py.

async_request_done()

None homeassistant.components.configurator.Configurator.async_request_done	(		self,
		str	request_id
	)

Remove the configuration request.

Definition at line 222 of file __init__.py.

Member Data Documentation

_cur_id

homeassistant.components.configurator.Configurator._cur_id

private

Definition at line 155 of file __init__.py.

hass

homeassistant.components.configurator.Configurator.hass

Definition at line 154 of file __init__.py.

---

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

• core/homeassistant/components/configurator/__init__.py