Home Assistant Unofficial Reference 2024.12.1
homeassistant.config_entries.OptionsFlowWithConfigEntry Class Reference
Inheritance diagram for homeassistant.config_entries.OptionsFlowWithConfigEntry:
[legend]
Collaboration diagram for homeassistant.config_entries.OptionsFlowWithConfigEntry:
[legend]

Public Member Functions

None __init__ (self, ConfigEntry config_entry)
 
dict[str, Anyoptions (self)
 
- Public Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry config_entry (self)
 
None config_entry (self, ConfigEntry value)
 
- 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

 _config_entry
 
 _options
 

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

Base class for options flows with config entry and options.

This class is being phased out, and should not be referenced in new code.
It is kept only for backward compatibility, and only for custom integrations.

Definition at line 3160 of file config_entries.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.config_entries.OptionsFlowWithConfigEntry.__init__ (   self,
ConfigEntry  config_entry 
)
Initialize options flow.

Definition at line 3167 of file config_entries.py.

Member Function Documentation

◆ options()

dict[str, Any] homeassistant.config_entries.OptionsFlowWithConfigEntry.options (   self)
Return a mutable copy of the config entry options.

Definition at line 3179 of file config_entries.py.

Member Data Documentation

◆ _config_entry

homeassistant.config_entries.OptionsFlowWithConfigEntry._config_entry
private

Definition at line 3169 of file config_entries.py.

◆ _options

homeassistant.config_entries.OptionsFlowWithConfigEntry._options
private

Definition at line 3170 of file config_entries.py.


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