homeassistant.components.config.config_entries Namespace Reference

Classes
class	ConfigManagerAvailableFlowView
class	ConfigManagerEntryIndexView
class	ConfigManagerEntryResourceReloadView
class	ConfigManagerEntryResourceView
class	ConfigManagerFlowIndexView
class	ConfigManagerFlowResourceView
class	OptionManagerFlowIndexView
class	OptionManagerFlowResourceView

Functions
list[json_fragment]	_async_matching_config_entries_json_fragments (HomeAssistant hass, list[str]|None type_filter, str|None domain)
data_entry_flow.FlowResult	_prepare_config_flow_result_json (data_entry_flow.FlowResult result, Callable[[data_entry_flow.FlowResult], data_entry_flow.FlowResult] prepare_result_json)
bool	async_setup (HomeAssistant hass)
None	config_entries_get (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	config_entries_progress (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	config_entries_subscribe (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	config_entry_disable (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	config_entry_get_single (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	config_entry_update (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
config_entries.ConfigEntry|None	get_entry (HomeAssistant hass, websocket_api.ActiveConnection connection, str entry_id, int msg_id)
None	ignore_config_flow (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	send_entry_not_found (websocket_api.ActiveConnection connection, int msg_id)

Detailed Description

Http views to control the config manager.

Function Documentation

_async_matching_config_entries_json_fragments()

list[json_fragment] homeassistant.components.config.config_entries._async_matching_config_entries_json_fragments ( HomeAssistant  hass, list[str] | None  type_filter, str | None   domain  )

private

Return matching config entries by type and/or domain.

Definition at line 550 of file config_entries.py.

_prepare_config_flow_result_json()

data_entry_flow.FlowResult homeassistant.components.config.config_entries._prepare_config_flow_result_json ( data_entry_flow.FlowResult  result, Callable[ [data_entry_flow.FlowResult], data_entry_flow.FlowResult ]  prepare_result_json  )

private

Convert result to JSON.

Definition at line 127 of file config_entries.py.

async_setup()

bool homeassistant.components.config.config_entries.async_setup

(

HomeAssistant

hass

)

Enable the Home Assistant views.

Definition at line 37 of file config_entries.py.

config_entries_get()

None homeassistant.components.config.config_entries.config_entries_get	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Return matching config entries by type and/or domain.

Definition at line 485 of file config_entries.py.

config_entries_progress()

None homeassistant.components.config.config_entries.config_entries_progress	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

List flows that are in progress but not started by a user.

Example of a non-user initiated flow is a discovered Hue hub that
requires user interaction to finish setup.

Definition at line 290 of file config_entries.py.

config_entries_subscribe()

None homeassistant.components.config.config_entries.config_entries_subscribe	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Subscribe to config entry updates.

Definition at line 504 of file config_entries.py.

config_entry_disable()

None homeassistant.components.config.config_entries.config_entry_disable	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Disable config entry.

Definition at line 410 of file config_entries.py.

config_entry_get_single()

None homeassistant.components.config.config_entries.config_entry_get_single	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Update config entry.

Definition at line 337 of file config_entries.py.

config_entry_update()

None homeassistant.components.config.config_entries.config_entry_update	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Update config entry.

Definition at line 362 of file config_entries.py.

get_entry()

config_entries.ConfigEntry | None homeassistant.components.config.config_entries.get_entry	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		str	entry_id,
		int	msg_id
	)

Get entry, send error message if it doesn't exist.

Definition at line 317 of file config_entries.py.

ignore_config_flow()

None homeassistant.components.config.config_entries.ignore_config_flow	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Ignore a config flow.

Definition at line 441 of file config_entries.py.

send_entry_not_found()

None homeassistant.components.config.config_entries.send_entry_not_found	(	websocket_api.ActiveConnection	connection,
		int	msg_id
	)

Send Config entry not found error.

Definition at line 310 of file config_entries.py.