homeassistant.auth.mfa_modules.SetupFlow Class Reference

Inheritance diagram for homeassistant.auth.mfa_modules.SetupFlow:

Collaboration diagram for homeassistant.auth.mfa_modules.SetupFlow:

Public Member Functions
None	__init__ (self, MultiFactorAuthModule auth_module, vol.Schema setup_schema, str user_id)
FlowResult	async_step_init (self, dict[str, str]|None user_input=None)
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)

Private Attributes
	_auth_module
	_setup_schema
	_user_id

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

Handler for the setup flow.

Definition at line 98 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.auth.mfa_modules.SetupFlow.__init__	(		self,
		MultiFactorAuthModule	auth_module,
		vol.Schema	setup_schema,
		str	user_id
	)

Initialize the setup flow.

Definition at line 101 of file __init__.py.

Member Function Documentation

async_step_init()

FlowResult homeassistant.auth.mfa_modules.SetupFlow.async_step_init	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the first step of setup flow.

Return self.async_show_form(step_id='init') if user_input is None.
Return self.async_create_entry(data={'result': result}) if finish.

Definition at line 109 of file __init__.py.

Member Data Documentation

_auth_module

homeassistant.auth.mfa_modules.SetupFlow._auth_module

private

Definition at line 105 of file __init__.py.

_setup_schema

homeassistant.auth.mfa_modules.SetupFlow._setup_schema

private

Definition at line 106 of file __init__.py.

_user_id

homeassistant.auth.mfa_modules.SetupFlow._user_id

private

Definition at line 107 of file __init__.py.

---

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

• core/homeassistant/auth/mfa_modules/__init__.py