homeassistant.config_entries.OptionsFlowManager Class Reference

Inheritance diagram for homeassistant.config_entries.OptionsFlowManager:

Collaboration diagram for homeassistant.config_entries.OptionsFlowManager:

Public Member Functions
OptionsFlow	async_create_flow (self, str handler_key, *ConfigFlowContext|None context=None, dict[str, Any]|None data=None)
ConfigFlowResult	async_finish_flow (self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult] flow, ConfigFlowResult result)
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)

Private Member Functions
ConfigEntry	_async_get_config_entry (self, str config_entry_id)
None	_async_setup_preview (self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult] flow)

Static Private Attributes
	_flow_result

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

Detailed Description

Flow to set options for a configuration entry.

Definition at line 3029 of file config_entries.py.

Member Function Documentation

_async_get_config_entry()

ConfigEntry homeassistant.config_entries.OptionsFlowManager._async_get_config_entry (   self, str  config_entry_id  )

private

Return config entry or raise if not found.

Definition at line 3036 of file config_entries.py.

_async_setup_preview()

None homeassistant.config_entries.OptionsFlowManager._async_setup_preview (   self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult]   flow  )

private

Set up preview for an option flow handler.

Definition at line 3080 of file config_entries.py.

async_create_flow()

OptionsFlow homeassistant.config_entries.OptionsFlowManager.async_create_flow	(		self,
		str	handler_key,
		*ConfigFlowContext | None	context = None,
		dict[str, Any] | None	data = None
	)

Create an options flow for a config entry.

Entry_id and flow.handler is the same thing to map entry with flow.

Definition at line 3040 of file config_entries.py.

async_finish_flow()

ConfigFlowResult homeassistant.config_entries.OptionsFlowManager.async_finish_flow	(		self,
		data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult]	flow,
		ConfigFlowResult	result
	)

Finish an options flow and update options for configuration entry.

This method is called when a flow step returns FlowResultType.ABORT or
FlowResultType.CREATE_ENTRY.

Flow.handler and entry_id is the same thing to map flow with entry.

Definition at line 3055 of file config_entries.py.

Member Data Documentation

_flow_result

homeassistant.config_entries.OptionsFlowManager._flow_result

staticprivate

Definition at line 3034 of file config_entries.py.

---

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

• core/homeassistant/config_entries.py