homeassistant.components.config.config_entries.ConfigManagerFlowIndexView Class Reference

Inheritance diagram for homeassistant.components.config.config_entries.ConfigManagerFlowIndexView:

Collaboration diagram for homeassistant.components.config.config_entries.ConfigManagerFlowIndexView:

Public Member Functions
NoReturn	get (self, web.Request request)
dict[str, Any]	get_context (self, dict[str, Any] data)
web.Response	post (self, web.Request request, dict[str, Any] data)
Public Member Functions inherited from homeassistant.helpers.data_entry_flow._BaseFlowManagerView
None	__init__ (self, _FlowManagerT flow_mgr)
Public Member Functions inherited from homeassistant.config_entries.ConfigEntriesFlowManager
None	__init__ (self, HomeAssistant hass, ConfigEntries config_entries, ConfigType hass_config)
ConfigFlow	async_create_flow (self, str handler_key, *ConfigFlowContext|None context=None, Any data=None)
ConfigFlowResult	async_finish_flow (self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult] flow, ConfigFlowResult result)
bool	async_has_matching_discovery_flow (self, str handler, ConfigFlowContext match_context, Any data)
bool	async_has_matching_flow (self, ConfigFlow flow)
ConfigFlowResult	async_init (self, str handler, *ConfigFlowContext|None context=None, Any data=None)
None	async_post_init (self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult] flow, ConfigFlowResult result)
None	async_shutdown (self)
None	async_wait_import_flow_initialized (self, str handler)
Public Member Functions inherited from homeassistant.data_entry_flow.FlowManager
None	__init__ (self, HomeAssistant hass)
None	async_abort (self, str flow_id)
_FlowResultT	async_configure (self, str flow_id, dict|None user_input=None)
FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]	async_create_flow (self, _HandlerT handler_key, *_FlowContextT|None context=None, dict[str, Any]|None data=None)
_FlowResultT	async_finish_flow (self, FlowHandler[_FlowContextT, _FlowResultT, _HandlerT] flow, _FlowResultT result)
_FlowResultT	async_get (self, str flow_id)
_FlowResultT	async_init (self, _HandlerT handler, *_FlowContextT|None context=None, Any data=None)
None	async_post_init (self, FlowHandler[_FlowContextT, _FlowResultT, _HandlerT] flow, _FlowResultT result)
list[_FlowResultT]	async_progress (self, bool include_uninitialized=False)
list[_FlowResultT]	async_progress_by_handler (self, _HandlerT handler, bool include_uninitialized=False, dict[str, Any]|None match_context=None)
list[_FlowResultT]	async_progress_by_init_data_type (self, type init_data_type, Callable[[Any], bool] matcher, bool include_uninitialized=False)

Static Public Attributes
	default
	extra
string	name = "api:config:config_entries:flow"
	status
	text
string	url = "/api/config/config_entries/flow"
Static Public Attributes inherited from homeassistant.helpers.data_entry_flow.FlowManagerIndexView
	context
	default
	extra = vol.ALLOW_EXTRA,
	result

Private Member Functions
web.Response	_post_impl (self, web.Request request, dict[str, Any] data)
data_entry_flow.FlowResult	_prepare_result_json (self, data_entry_flow.FlowResult result)

Additional Inherited Members
Public Attributes inherited from homeassistant.config_entries.ConfigEntriesFlowManager
	config_entries
Public Attributes inherited from homeassistant.data_entry_flow.FlowManager
	hass

Detailed Description

View to create config flows.

Definition at line 145 of file config_entries.py.

Member Function Documentation

_post_impl()

web.Response homeassistant.components.config.config_entries.ConfigManagerFlowIndexView._post_impl (   self, web.Request  request, dict[str, Any]   data  )

private

Initialize a POST request for a config entry flow.

Reimplemented from homeassistant.helpers.data_entry_flow.FlowManagerIndexView.

Definition at line 170 of file config_entries.py.

_prepare_result_json()

data_entry_flow.FlowResult homeassistant.components.config.config_entries.ConfigManagerFlowIndexView._prepare_result_json (   self, data_entry_flow.FlowResult   result  )

private

Convert result to JSON.

Reimplemented from homeassistant.helpers.data_entry_flow._BaseFlowManagerView.

Definition at line 191 of file config_entries.py.

get()

NoReturn homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.get	(		self,
		web.Request	request
	)

Not implemented.

Definition at line 153 of file config_entries.py.

get_context()

dict[str, Any] homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.get_context	(		self,
		dict[str, Any]	data
	)

Return context.

Reimplemented from homeassistant.helpers.data_entry_flow.FlowManagerIndexView.

Definition at line 182 of file config_entries.py.

post()

web.Response homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.post	(		self,
		web.Request	request,
		dict[str, Any]	data
	)

Reimplemented from homeassistant.helpers.data_entry_flow.FlowManagerIndexView.

Definition at line 166 of file config_entries.py.

Member Data Documentation

default

homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.default

static

Definition at line 160 of file config_entries.py.

extra

homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.extra

static

Definition at line 163 of file config_entries.py.

name

string homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.name = "api:config:config_entries:flow"

static

Definition at line 151 of file config_entries.py.

status

homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.status

static

Definition at line 179 of file config_entries.py.

text

homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.text

static

Handle a POST request for a config entry flow.

Definition at line 178 of file config_entries.py.

url

string homeassistant.components.config.config_entries.ConfigManagerFlowIndexView.url = "/api/config/config_entries/flow"

static

Definition at line 150 of file config_entries.py.

---

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

• core/homeassistant/components/config/config_entries.py