Inheritance diagram for homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler:

Collaboration diagram for homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler:

Public Member Functions
None	__init__ (self)

None	__init_subclass__ (cls, **Any kwargs)

str	async_config_entry_title (self, Mapping[str, Any] options)

None	async_config_flow_finished (self, Mapping[str, Any] options)

ConfigFlowResult	async_create_entry (self, Mapping[str, Any] data, **Any kwargs)

bool	async_supports_options_flow (cls, ConfigEntry config_entry)

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_user (self, dict[str, Any]\|None user_input=None)

ConfigFlowResult	async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)

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)

Static Public Member Functions
None	async_options_flow_finished (HomeAssistant hass, Mapping[str, Any] options)

None	async_setup_preview (HomeAssistant hass)

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

Public Attributes
	async_get_options_flow

Public Attributes inherited from homeassistant.config_entries.ConfigFlow
	source

Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Static Public Attributes
	None

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

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

Private Attributes
	_common_handler

Detailed Description

Handle a schema based config flow.

Definition at line 299 of file schema_config_entry_flow.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.__init__ ( self )

Initialize config flow.

Definition at line 333 of file schema_config_entry_flow.py.

Member Function Documentation

◆ __init_subclass__()

None homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.__init_subclass__	(		cls,
		**Any	kwargs
	)

Initialize a subclass.

Definition at line 307 of file schema_config_entry_flow.py.

◆ _async_step()

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

staticprivate

Generate a step handler.

Definition at line 348 of file schema_config_entry_flow.py.

◆ async_config_entry_title()

str homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.async_config_entry_title	(		self,
		Mapping[str, Any]	options
	)

Return config entry title.

The options parameter contains config entry options, which is the union of user
input from the config flow steps.

Definition at line 366 of file schema_config_entry_flow.py.

◆ async_config_flow_finished()

None homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.async_config_flow_finished	(		self,
		Mapping[str, Any]	options
	)

Take necessary actions after the config flow is finished, if needed.

The options parameter contains config entry options, which is the union of user
input from the config flow steps.

Reimplemented in homeassistant.components.time_date.config_flow.TimeDateConfigFlowHandler, and homeassistant.components.group.config_flow.GroupConfigFlowHandler.

Definition at line 374 of file schema_config_entry_flow.py.

◆ async_create_entry()

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

Finish config flow and create a config entry.

Reimplemented in homeassistant.components.systemmonitor.config_flow.SystemMonitorConfigFlowHandler, and homeassistant.components.folder_watcher.config_flow.FolderWatcherConfigFlowHandler.

Definition at line 393 of file schema_config_entry_flow.py.

◆ async_options_flow_finished()

None homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.async_options_flow_finished	(	HomeAssistant	hass,
		Mapping[str, Any]	options
	)

static

Take necessary actions after the options flow is finished, if needed.

The options parameter contains config entry options, which is the union of
stored options and user input from the options flow steps.

Reimplemented in homeassistant.components.group.config_flow.GroupConfigFlowHandler.

Definition at line 383 of file schema_config_entry_flow.py.

◆ async_setup_preview()

None homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.async_setup_preview ( HomeAssistant hass )

static

Set up preview.

Reimplemented from homeassistant.data_entry_flow.FlowHandler.

Reimplemented in homeassistant.components.time_date.config_flow.TimeDateConfigFlowHandler, homeassistant.components.threshold.config_flow.ConfigFlowHandler, homeassistant.components.template.config_flow.TemplateConfigFlowHandler, homeassistant.components.statistics.config_flow.StatisticsConfigFlowHandler, homeassistant.components.mold_indicator.config_flow.MoldIndicatorConfigFlowHandler, and homeassistant.components.group.config_flow.GroupConfigFlowHandler.

Definition at line 338 of file schema_config_entry_flow.py.

◆ async_supports_options_flow()

bool homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.async_supports_options_flow	(		cls,
		ConfigEntry	config_entry
	)

Return options flow support for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 343 of file schema_config_entry_flow.py.

Member Data Documentation

◆ _common_handler

homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler._common_handler

private

Definition at line 335 of file schema_config_entry_flow.py.

◆ async_get_options_flow

homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.async_get_options_flow

Definition at line 327 of file schema_config_entry_flow.py.

◆ None

homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.None

static

Definition at line 303 of file schema_config_entry_flow.py.

◆ VERSION

int homeassistant.helpers.schema_config_entry_flow.SchemaConfigFlowHandler.VERSION = 1

static

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

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __init_subclass__()

◆ _async_step()

◆ async_config_entry_title()

◆ async_config_flow_finished()

◆ async_create_entry()

◆ async_options_flow_finished()

◆ async_setup_preview()

◆ async_supports_options_flow()

Member Data Documentation

◆ _common_handler

◆ async_get_options_flow

◆ None

◆ VERSION

◆ init()