homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler Class Reference

Public Member Functions
None	__init__ (self, SchemaConfigFlowHandler|SchemaOptionsFlowHandler handler, Mapping[str, SchemaFlowStep] flow, dict[str, Any]|None options)
ConfigFlowResult	async_step (self, str step_id, dict[str, Any]|None user_input=None)
dict[str, Any]	flow_state (self)
dict[str, Any]	options (self)
SchemaConfigFlowHandler|SchemaOptionsFlowHandler	parent_handler (self)

Private Member Functions
ConfigFlowResult	_async_form_step (self, str step_id, dict[str, Any]|None user_input=None)
ConfigFlowResult	_async_menu_step (self, str step_id, dict[str, Any]|None user_input=None)
vol.Schema|None	_get_schema (self, SchemaFlowFormStep form_step)
ConfigFlowResult	_show_next_step (self, str next_step_id, SchemaFlowError|None error=None, dict[str, Any]|None user_input=None)
ConfigFlowResult	_show_next_step_or_create_entry (self, SchemaFlowFormStep form_step)
None	_update_and_remove_omitted_optional_keys (self, dict[str, Any] values, dict[str, Any] user_input, vol.Schema|None data_schema)

Private Attributes
	_flow
	_handler
	_options

Detailed Description

Handle a schema based config or options flow.

Definition at line 107 of file schema_config_entry_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler.__init__	(		self,
		SchemaConfigFlowHandler | SchemaOptionsFlowHandler	handler,
		Mapping[str, SchemaFlowStep]	flow,
		dict[str, Any] | None	options
	)

Initialize a common handler.

Definition at line 110 of file schema_config_entry_flow.py.

Member Function Documentation

_async_form_step()

ConfigFlowResult homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._async_form_step (   self, str  step_id, dict[str, Any] | None   user_input = None  )

private

Handle a form step.

Definition at line 156 of file schema_config_entry_flow.py.

_async_menu_step()

ConfigFlowResult homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._async_menu_step (   self, str  step_id, dict[str, Any] | None   user_input = None  )

private

Handle a menu step.

Definition at line 288 of file schema_config_entry_flow.py.

_get_schema()

vol.Schema | None homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._get_schema (   self, SchemaFlowFormStep  form_step  )

private

Definition at line 149 of file schema_config_entry_flow.py.

_show_next_step()

ConfigFlowResult homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._show_next_step (   self, str  next_step_id, SchemaFlowError | None   error = None, dict[str, Any] | None   user_input = None  )

private

Show form for next step.

Definition at line 236 of file schema_config_entry_flow.py.

_show_next_step_or_create_entry()

ConfigFlowResult homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._show_next_step_or_create_entry (   self, SchemaFlowFormStep   form_step  )

private

Definition at line 221 of file schema_config_entry_flow.py.

_update_and_remove_omitted_optional_keys()

None homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._update_and_remove_omitted_optional_keys (   self, dict[str, Any]  values, dict[str, Any]  user_input, vol.Schema | None  data_schema  )

private

Definition at line 199 of file schema_config_entry_flow.py.

async_step()

ConfigFlowResult homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler.async_step	(		self,
		str	step_id,
		dict[str, Any] | None	user_input = None
	)

Handle a step.

Definition at line 141 of file schema_config_entry_flow.py.

flow_state()

dict[str, Any] homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler.flow_state

(

self

)

Return the flow state, used to store temporary data.

It can be used for example to store the key or the index of a sub-item
that will be edited in the next step.

Definition at line 133 of file schema_config_entry_flow.py.

options()

dict[str, Any] homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler.options

(

self

)

Return the options linked to the current flow handler.

Definition at line 128 of file schema_config_entry_flow.py.

parent_handler()

SchemaConfigFlowHandler | SchemaOptionsFlowHandler homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler.parent_handler

(

self

)

Return parent handler.

Definition at line 123 of file schema_config_entry_flow.py.

Member Data Documentation

_flow

homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._flow

private

Definition at line 117 of file schema_config_entry_flow.py.

_handler

homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._handler

private

Definition at line 118 of file schema_config_entry_flow.py.

_options

homeassistant.helpers.schema_config_entry_flow.SchemaCommonFlowHandler._options

private

Definition at line 119 of file schema_config_entry_flow.py.

---

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

• core/homeassistant/helpers/schema_config_entry_flow.py