Inheritance diagram for homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler:

Collaboration diagram for homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler:

Public Member Functions
None	__init__ (self)

str	async_generate_authorize_url (self)

config_entries.ConfigFlowResult	async_oauth_create_entry (self, dict data)

None	async_register_implementation (cls, HomeAssistant hass, LocalOAuth2Implementation local_impl)

config_entries.ConfigFlowResult	async_step_auth (self, dict[str, Any]\|None user_input=None)

config_entries.ConfigFlowResult	async_step_authorize_rejected (self, None data=None)

config_entries.ConfigFlowResult	async_step_creation (self, dict[str, Any]\|None user_input=None)

config_entries.ConfigFlowResult	async_step_pick_implementation (self, dict\|None user_input=None)

config_entries.ConfigFlowResult	async_step_user (self, dict[str, Any]\|None user_input=None)

dict	extra_authorize_data (self)

logging.Logger	logger (self)

Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
None	__init_subclass__ (cls, str\|None domain=None, *Any kwargs)

ConfigFlowResult	async_abort (self, *str reason, Mapping[str, str]\|None description_placeholders=None)

ConfigFlowResult	async_create_entry (self, *str title, Mapping[str, Any] data, str\|None description=None, Mapping[str, str]\|None description_placeholders=None, Mapping[str, Any]\|None options=None)

ConfigEntry\|None	async_set_unique_id (self, str\|None unique_id=None, *bool raise_on_progress=True)

ConfigFlowResult	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)

ConfigFlowResult	async_step_bluetooth (self, BluetoothServiceInfoBleak discovery_info)

ConfigFlowResult	async_step_dhcp (self, DhcpServiceInfo discovery_info)

ConfigFlowResult	async_step_discovery (self, DiscoveryInfoType discovery_info)

ConfigFlowResult	async_step_hassio (self, HassioServiceInfo discovery_info)

ConfigFlowResult	async_step_homekit (self, ZeroconfServiceInfo discovery_info)

ConfigFlowResult	async_step_ignore (self, dict[str, Any] user_input)

ConfigFlowResult	async_step_integration_discovery (self, DiscoveryInfoType discovery_info)

ConfigFlowResult	async_step_mqtt (self, MqttServiceInfo discovery_info)

ConfigFlowResult	async_step_ssdp (self, SsdpServiceInfo discovery_info)

ConfigFlowResult	async_step_usb (self, UsbServiceInfo discovery_info)

ConfigFlowResult	async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)

bool	async_supports_options_flow (cls, ConfigEntry config_entry)

ConfigFlowResult	async_update_reload_and_abort (self, ConfigEntry entry, *str\|None\|UndefinedType unique_id=UNDEFINED, str\|UndefinedType title=UNDEFINED, Mapping[str, Any]\|UndefinedType data=UNDEFINED, Mapping[str, Any]\|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]\|UndefinedType options=UNDEFINED, str\|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)

bool	is_matching (self, Self other_flow)

str\|None	unique_id (self)

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)

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_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)

Public Attributes
	DOMAIN

	external_data

	flow_impl

Public Attributes inherited from homeassistant.config_entries.ConfigFlow
	source

Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Static Public Attributes
string	DOMAIN = ""

int	VERSION = 1

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

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
OptionsFlow	async_get_options_flow (ConfigEntry config_entry)

Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)

Detailed Description

Handle a config flow.

Definition at line 230 of file config_entry_oauth2_flow.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.__init__ ( self )

Instantiate config flow.

Definition at line 237 of file config_entry_oauth2_flow.py.

Member Function Documentation

◆ async_generate_authorize_url()

str homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_generate_authorize_url ( self )

Generate a url for the user to authorize.

Definition at line 258 of file config_entry_oauth2_flow.py.

◆ async_oauth_create_entry()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_oauth_create_entry	(		self,
		dict	data
	)

Create an entry for the flow.

Ok to override if you want to fetch extra info or even add another step.

Reimplemented in homeassistant.components.weheat.config_flow.OAuth2FlowHandler.

Definition at line 374 of file config_entry_oauth2_flow.py.

◆ async_register_implementation()

None homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_register_implementation	(		cls,
		HomeAssistant	hass,
		LocalOAuth2Implementation	local_impl
	)

Register a local implementation.

Definition at line 390 of file config_entry_oauth2_flow.py.

◆ async_step_auth()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_step_auth	(		self,
		dict[str, Any] \| None	user_input = `None`
	)

Create an entry for auth.

Definition at line 296 of file config_entry_oauth2_flow.py.

◆ async_step_authorize_rejected()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_step_authorize_rejected	(		self,
		None	data = `None`
	)

Step to handle flow rejection.

Definition at line 365 of file config_entry_oauth2_flow.py.

◆ async_step_creation()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_step_creation	(		self,
		dict[str, Any] \| None	user_input = `None`
	)

Create config entry from external data.

Definition at line 324 of file config_entry_oauth2_flow.py.

◆ async_step_pick_implementation()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_step_pick_implementation	(		self,
		dict \| None	user_input = `None`
	)

Handle a flow start.

Definition at line 263 of file config_entry_oauth2_flow.py.

◆ async_step_user()

config_entries.ConfigFlowResult homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.async_step_user	(		self,
		dict[str, Any] \| None	user_input = `None`
	)

Handle a flow start.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Reimplemented in homeassistant.components.ondilo_ico.config_flow.OndiloIcoOAuth2FlowHandler, and homeassistant.components.lametric.config_flow.LaMetricFlowHandler.

Definition at line 383 of file config_entry_oauth2_flow.py.

◆ extra_authorize_data()

dict homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.extra_authorize_data ( self )

Extra data that needs to be appended to the authorize url.

Reimplemented in homeassistant.components.weheat.config_flow.OAuth2FlowHandler, homeassistant.components.ondilo_ico.config_flow.OndiloIcoOAuth2FlowHandler, and homeassistant.components.lametric.config_flow.LaMetricFlowHandler.

Definition at line 254 of file config_entry_oauth2_flow.py.

◆ logger()

logging.Logger homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.logger ( self )

Return logger.

Reimplemented in homeassistant.components.weheat.config_flow.OAuth2FlowHandler, homeassistant.components.toon.config_flow.ToonFlowHandler, homeassistant.components.point.config_flow.OAuth2FlowHandler, homeassistant.components.ondilo_ico.config_flow.OndiloIcoOAuth2FlowHandler, homeassistant.components.lametric.config_flow.LaMetricFlowHandler, and homeassistant.components.geocaching.config_flow.GeocachingFlowHandler.

Definition at line 250 of file config_entry_oauth2_flow.py.

Member Data Documentation

◆ DOMAIN [1/2]

string homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.DOMAIN = ""

static

Definition at line 233 of file config_entry_oauth2_flow.py.

◆ DOMAIN [2/2]

homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.DOMAIN

Definition at line 239 of file config_entry_oauth2_flow.py.

◆ external_data

homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.external_data

Definition at line 302 of file config_entry_oauth2_flow.py.

◆ flow_impl

homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.flow_impl

Definition at line 270 of file config_entry_oauth2_flow.py.

◆ VERSION

int homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2FlowHandler.VERSION = 1