homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler Class Reference

Inheritance diagram for homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler:

Collaboration diagram for homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler:

Public Member Functions
None	__init__ (self, ConfigEntry config_entry, Mapping[str, SchemaFlowStep] options_flow, Callable[[HomeAssistant, Mapping[str, Any]], None]|None async_options_flow_finished=None, Callable[[HomeAssistant], Coroutine[Any, Any, None]]|None async_setup_preview=None)
ConfigFlowResult	async_create_entry (self, Mapping[str, Any] data, **Any kwargs)
dict[str, Any]	options (self)
Public Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry	config_entry (self)
None	config_entry (self, ConfigEntry value)
Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
vol.Schema	add_suggested_values_to_schema (self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_FlowResultT	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
None	async_cancel_progress_task (self)
_FlowResultT	async_create_entry (self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step (self, *str|None step_id=None, str url, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step_done (self, *str next_step_id)
asyncio.Task[Any]|None	async_get_progress_task (self)
None	async_remove (self)
None	async_set_progress_task (self, asyncio.Task[Any] progress_task)
_FlowResultT	async_show_form (self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT	async_show_menu (self, *str|None step_id=None, Container[str] menu_options, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_show_progress (self, *str|None step_id=None, str progress_action, Mapping[str, str]|None description_placeholders=None, asyncio.Task[Any]|None progress_task=None)
_FlowResultT	async_show_progress_done (self, *str next_step_id)
bool	show_advanced_options (self)
str|None	source (self)

Static Private Member Functions
Callable[[SchemaConfigFlowHandler, dict[str, Any]|None], Coroutine[Any, Any, ConfigFlowResult],]	_async_step (str step_id)

Private Attributes
	_async_options_flow_finished
	_common_handler
	_options

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress
Static Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	Any
bool	deprecated_show_progress = False
	HomeAssistant
string	init_step = "init"
int	MINOR_VERSION = 1
	None
	str
int	VERSION = 1

Detailed Description

Handle a schema based options flow.

Definition at line 405 of file schema_config_entry_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler.__init__	(		self,
		ConfigEntry	config_entry,
		Mapping[str, SchemaFlowStep]	options_flow,
		Callable[[HomeAssistant, Mapping[str, Any]], None] | None	async_options_flow_finished = None,
		Callable[[HomeAssistant], Coroutine[Any, Any, None]] | None	async_setup_preview = None
	)

Initialize options flow.

If needed, `async_options_flow_finished` can be set to take necessary actions
after the options flow is finished. The second parameter contains config entry
options, which is the union of stored options and user input from the options
flow steps.

Definition at line 408 of file schema_config_entry_flow.py.

Member Function Documentation

_async_step()

Callable[ [SchemaConfigFlowHandler, dict[str, Any] | None], Coroutine[Any, Any, ConfigFlowResult], ] homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler._async_step ( str  step_id )

staticprivate

Generate a step handler.

Definition at line 444 of file schema_config_entry_flow.py.

async_create_entry()

ConfigFlowResult homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler.async_create_entry	(		self,
		Mapping[str, Any]	data,
		**Any	kwargs
	)

Finish config flow and create a config entry.

Definition at line 461 of file schema_config_entry_flow.py.

options()

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

(

self

)

Return a mutable copy of the config entry options.

Definition at line 439 of file schema_config_entry_flow.py.

Member Data Documentation

_async_options_flow_finished

homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler._async_options_flow_finished

private

Definition at line 426 of file schema_config_entry_flow.py.

_common_handler

homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler._common_handler

private

Definition at line 425 of file schema_config_entry_flow.py.

_options

homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler._options

private

Definition at line 424 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