homeassistant.auth.AuthManagerFlowManager Class Reference

Inheritance diagram for homeassistant.auth.AuthManagerFlowManager:

Collaboration diagram for homeassistant.auth.AuthManagerFlowManager:

Public Member Functions
None	__init__ (self, HomeAssistant hass, AuthManager auth_manager)
LoginFlow	async_create_flow (self, tuple[str, str] handler_key, *AuthFlowContext|None context=None, dict[str, Any]|None data=None)
AuthFlowResult	async_finish_flow (self, FlowHandler[AuthFlowContext, AuthFlowResult, tuple[str, str]] flow, AuthFlowResult 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)

Public Attributes
	auth_manager
Public Attributes inherited from homeassistant.data_entry_flow.FlowManager
	hass

Static Private Attributes
	_flow_result = AuthFlowResult

Detailed Description

Manage authentication flows.

Definition at line 100 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.auth.AuthManagerFlowManager.__init__	(		self,
		HomeAssistant	hass,
		AuthManager	auth_manager
	)

Init auth manager flows.

Definition at line 107 of file __init__.py.

Member Function Documentation

async_create_flow()

LoginFlow homeassistant.auth.AuthManagerFlowManager.async_create_flow	(		self,
		tuple[str, str]	handler_key,
		*AuthFlowContext | None	context = None,
		dict[str, Any] | None	data = None
	)

Create a login flow.

Definition at line 112 of file __init__.py.

async_finish_flow()

AuthFlowResult homeassistant.auth.AuthManagerFlowManager.async_finish_flow	(		self,
		FlowHandler[AuthFlowContext, AuthFlowResult, tuple[str, str]]	flow,
		AuthFlowResult	result
	)

Return a user as result of login flow.

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

Definition at line 125 of file __init__.py.

Member Data Documentation

_flow_result

homeassistant.auth.AuthManagerFlowManager._flow_result = AuthFlowResult

staticprivate

Definition at line 105 of file __init__.py.

auth_manager

homeassistant.auth.AuthManagerFlowManager.auth_manager

Definition at line 110 of file __init__.py.

---

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

• core/homeassistant/auth/__init__.py