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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_2sa (self, dict[str, Any] user_input, dict[str, str]|None errors=None)
 
ConfigFlowResult async_step_link (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_reauth_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_zeroconf (self, zeroconf.ZeroconfServiceInfo discovery_info)
 
ConfigFlowResult async_validate_input_create_entry (self, dict[str, Any] user_input, str step_id)
 
- 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)
 

Static Public Member Functions

SynologyDSMOptionsFlowHandler async_get_options_flow (ConfigEntry config_entry)
 
- Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None async_setup_preview (HomeAssistant hass)
 

Public Attributes

 discovered_conf
 
 reauth_conf
 
 saved_user_input
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Static Public Attributes

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
 

Private Member Functions

ConfigFlowResult _async_from_discovery (self, str host, str friendly_name, list[str] discovered_macs)
 
ConfigEntry|None _async_get_existing_entry (self, str discovered_mac)
 
ConfigFlowResult _show_form (self, str step_id, dict[str, Any]|None user_input=None, dict[str, str]|None errors=None)
 

Detailed Description

Handle a config flow.

Definition at line 110 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.__init__ (   self)
Initialize the synology_dsm config flow.

Definition at line 123 of file config_flow.py.

Member Function Documentation

◆ _async_from_discovery()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler._async_from_discovery (   self,
str  host,
str  friendly_name,
list[str]   discovered_macs 
)
private
Handle a discovered synology_dsm via zeroconf or ssdp.

Definition at line 274 of file config_flow.py.

◆ _async_get_existing_entry()

ConfigEntry | None homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler._async_get_existing_entry (   self,
str  discovered_mac 
)
private
See if we already have a configured NAS with this MAC address.

Definition at line 366 of file config_flow.py.

◆ _show_form()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler._show_form (   self,
str  step_id,
dict[str, Any] | None   user_input = None,
dict[str, str] | None   errors = None 
)
private
Show the setup form to the user.

Definition at line 130 of file config_flow.py.

◆ async_get_options_flow()

SynologyDSMOptionsFlowHandler homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 117 of file config_flow.py.

◆ async_step_2sa()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_2sa (   self,
dict[str, Any user_input,
dict[str, str] | None   errors = None 
)
Enter 2SA code to anthenticate.

Definition at line 347 of file config_flow.py.

◆ async_step_link()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_link (   self,
dict[str, Any] | None   user_input = None 
)
Link a config entry from discovery.

Definition at line 314 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Perform reauth upon an API authentication error.

Definition at line 324 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Perform reauth confirm upon an API authentication error.

Definition at line 337 of file config_flow.py.

◆ async_step_ssdp()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_ssdp (   self,
ssdp.SsdpServiceInfo   discovery_info 
)
Handle a discovered synology_dsm via ssdp.

Definition at line 260 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a flow initiated by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 236 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Handle a discovered synology_dsm via zeroconf.

Definition at line 245 of file config_flow.py.

◆ async_validate_input_create_entry()

ConfigFlowResult homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.async_validate_input_create_entry (   self,
dict[str, Any user_input,
str   step_id 
)
Process user input and create new or update existing config entry.

Definition at line 159 of file config_flow.py.

Member Data Documentation

◆ discovered_conf

homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.discovered_conf

Definition at line 307 of file config_flow.py.

◆ reauth_conf

homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.reauth_conf

Definition at line 328 of file config_flow.py.

◆ saved_user_input

homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.saved_user_input

Definition at line 352 of file config_flow.py.

◆ VERSION

int homeassistant.components.synology_dsm.config_flow.SynologyDSMFlowHandler.VERSION = 1
static
Handle a config flow.

Definition at line 113 of file config_flow.py.


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