Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler Class Reference
Inheritance diagram for homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler:
[legend]
Collaboration diagram for homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler:
[legend]

Public Member Functions

None __init__ (self, UnifiConfigEntry config_entry)
 
ConfigFlowResult async_step_client_control (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_configure_entity_sources (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_device_tracker (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_init (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_simple_options (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_statistics_sensors (self, dict[str, Any]|None user_input=None)
 
- 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)
 

Public Attributes

 hub
 
 options
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Private Member Functions

ConfigFlowResult _update_options (self)
 

Additional Inherited Members

- Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None async_setup_preview (HomeAssistant hass)
 
- 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

Handle Unifi Network options.

Definition at line 245 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.__init__ (   self,
UnifiConfigEntry  config_entry 
)
Initialize UniFi Network options flow.

Definition at line 250 of file config_flow.py.

Member Function Documentation

◆ _update_options()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler._update_options (   self)
private
Update config entry options.

Definition at line 461 of file config_flow.py.

◆ async_step_client_control()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.async_step_client_control (   self,
dict[str, Any] | None   user_input = None 
)
Manage configuration of network access controlled clients.

Definition at line 397 of file config_flow.py.

◆ async_step_configure_entity_sources()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.async_step_configure_entity_sources (   self,
dict[str, Any] | None   user_input = None 
)
Select sources for entities.

Definition at line 301 of file config_flow.py.

◆ async_step_device_tracker()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.async_step_device_tracker (   self,
dict[str, Any] | None   user_input = None 
)
Manage the device tracker options.

Definition at line 334 of file config_flow.py.

◆ async_step_init()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.async_step_init (   self,
dict[str, Any] | None   user_input = None 
)
Manage the UniFi Network options.

Definition at line 254 of file config_flow.py.

◆ async_step_simple_options()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.async_step_simple_options (   self,
dict[str, Any] | None   user_input = None 
)
For users without advanced settings enabled.

Definition at line 266 of file config_flow.py.

◆ async_step_statistics_sensors()

ConfigFlowResult homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.async_step_statistics_sensors (   self,
dict[str, Any] | None   user_input = None 
)
Manage the statistics sensors options.

Definition at line 436 of file config_flow.py.

Member Data Documentation

◆ hub

homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.hub

Definition at line 258 of file config_flow.py.

◆ options

homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler.options

Definition at line 252 of file config_flow.py.


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