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

Public Member Functions

None __init__ (self)
 
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_trusted_device (self, dict[str, Any]|None user_input=None, dict[str, str]|None errors=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_verification_code (self, dict[str, Any]|None user_input=None, dict[str, str]|None errors=None)
 
- 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

 api
 
- 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

def _show_setup_form (self, user_input=None, errors=None, step_id="user")
 
ConfigFlowResult _show_trusted_device_form (self, trusted_devices, dict[str, str]|None errors=None)
 
ConfigFlowResult _show_verification_code_form (self, dict[str, str]|None errors=None)
 
def _validate_and_create_entry (self, user_input, step_id)
 

Private Attributes

 _description_placeholders
 
 _existing_entry_data
 
 _gps_accuracy_threshold
 
 _max_interval
 
 _password
 
 _trusted_device
 
 _username
 
 _verification_code
 
 _with_family
 

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 iCloud config flow.

Definition at line 41 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.icloud.config_flow.IcloudFlowHandler.__init__ (   self)
Initialize iCloud config flow.

Definition at line 46 of file config_flow.py.

Member Function Documentation

◆ _show_setup_form()

def homeassistant.components.icloud.config_flow.IcloudFlowHandler._show_setup_form (   self,
  user_input = None,
  errors = None,
  step_id = "user" 
)
private
Show the setup form to the user.

Definition at line 61 of file config_flow.py.

◆ _show_trusted_device_form()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler._show_trusted_device_form (   self,
  trusted_devices,
dict[str, str] | None   errors = None 
)
private
Show the trusted_device form to the user.

Definition at line 243 of file config_flow.py.

◆ _show_verification_code_form()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler._show_verification_code_form (   self,
dict[str, str] | None   errors = None 
)
private
Show the verification_code form to the user.

Definition at line 326 of file config_flow.py.

◆ _validate_and_create_entry()

def homeassistant.components.icloud.config_flow.IcloudFlowHandler._validate_and_create_entry (   self,
  user_input,
  step_id 
)
private
Check if config is valid and create entry if so.

Definition at line 94 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Initialise re-authentication.

Definition at line 183 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Update password for a config entry that can't authenticate.

Definition at line 194 of file config_flow.py.

◆ async_step_trusted_device()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler.async_step_trusted_device (   self,
dict[str, Any] | None   user_input = None,
dict[str, str] | None   errors = None 
)
We need a trusted device.

Definition at line 203 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler.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 167 of file config_flow.py.

◆ async_step_verification_code()

ConfigFlowResult homeassistant.components.icloud.config_flow.IcloudFlowHandler.async_step_verification_code (   self,
dict[str, Any] | None   user_input = None,
dict[str, str] | None   errors = None 
)
Ask the verification code to the user.

Definition at line 260 of file config_flow.py.

Member Data Documentation

◆ _description_placeholders

homeassistant.components.icloud.config_flow.IcloudFlowHandler._description_placeholders
private

Definition at line 191 of file config_flow.py.

◆ _existing_entry_data

homeassistant.components.icloud.config_flow.IcloudFlowHandler._existing_entry_data
private

Definition at line 190 of file config_flow.py.

◆ _gps_accuracy_threshold

homeassistant.components.icloud.config_flow.IcloudFlowHandler._gps_accuracy_threshold
private

Definition at line 53 of file config_flow.py.

◆ _max_interval

homeassistant.components.icloud.config_flow.IcloudFlowHandler._max_interval
private

Definition at line 52 of file config_flow.py.

◆ _password

homeassistant.components.icloud.config_flow.IcloudFlowHandler._password
private

Definition at line 50 of file config_flow.py.

◆ _trusted_device

homeassistant.components.icloud.config_flow.IcloudFlowHandler._trusted_device
private

Definition at line 55 of file config_flow.py.

◆ _username

homeassistant.components.icloud.config_flow.IcloudFlowHandler._username
private

Definition at line 49 of file config_flow.py.

◆ _verification_code

homeassistant.components.icloud.config_flow.IcloudFlowHandler._verification_code
private

Definition at line 56 of file config_flow.py.

◆ _with_family

homeassistant.components.icloud.config_flow.IcloudFlowHandler._with_family
private

Definition at line 51 of file config_flow.py.

◆ api

homeassistant.components.icloud.config_flow.IcloudFlowHandler.api

Definition at line 48 of file config_flow.py.

◆ VERSION

int homeassistant.components.icloud.config_flow.IcloudFlowHandler.VERSION = 1
static

Definition at line 44 of file config_flow.py.


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