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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_auth_app (self, dict[str, str]|None user_input=None)
 
ConfigFlowResult async_step_auth_captcha (self, dict[str, str]|None user_input=None)
 
ConfigFlowResult async_step_auth_mfa (self, dict[str, str]|None user_input=None)
 
ConfigFlowResult async_step_auth_user (self, dict[str, str]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, str]|None user_input=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_user (self, dict[str, Any]|None user_input=None)
 
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 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_authenticate_app (self, str|None error=None)
 
ConfigFlowResult _async_authenticate_user (self, str|None error=None)
 
ConfigFlowResult _async_form_auth_app (self, str|None error=None)
 
ConfigFlowResult _async_form_auth_captcha (self, str|None error=None)
 
ConfigFlowResult _async_form_auth_mfa (self, str|None error=None)
 
ConfigFlowResult _async_form_auth_user (self, str|None error=None)
 
ConfigFlowResult _async_get_entry (self)
 

Private Attributes

 _app_code
 
 _app_id
 
 _app_secret
 
 _app_token
 
 _auth
 
 _captcha_code
 
 _captcha_image
 
 _captcha_sid
 
 _mfa_code
 
 _password
 
 _phone_number
 
 _slnet_token
 
 _slnet_token_expires
 
 _user_id
 
 _user_slid
 
 _username
 

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)
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Detailed Description

Handle a StarLine config flow.

Definition at line 29 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.starline.config_flow.StarlineFlowHandler.__init__ (   self)
Initialize flow.

Definition at line 39 of file config_flow.py.

Member Function Documentation

◆ _async_authenticate_app()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_authenticate_app (   self,
str | None   error = None 
)
private
Authenticate application.

Definition at line 186 of file config_flow.py.

◆ _async_authenticate_user()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_authenticate_user (   self,
str | None   error = None 
)
private
Authenticate user.

Definition at line 202 of file config_flow.py.

◆ _async_form_auth_app()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_form_auth_app (   self,
str | None   error = None 
)
private
Authenticate application form.

Definition at line 101 of file config_flow.py.

◆ _async_form_auth_captcha()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_form_auth_captcha (   self,
str | None   error = None 
)
private
Captcha verification form.

Definition at line 165 of file config_flow.py.

◆ _async_form_auth_mfa()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_form_auth_mfa (   self,
str | None   error = None 
)
private
Authenticate mfa form.

Definition at line 145 of file config_flow.py.

◆ _async_form_auth_user()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_form_auth_user (   self,
str | None   error = None 
)
private
Authenticate user form.

Definition at line 123 of file config_flow.py.

◆ _async_get_entry()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler._async_get_entry (   self)
private
Create entry.

Definition at line 237 of file config_flow.py.

◆ async_step_auth_app()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler.async_step_auth_app (   self,
dict[str, str] | None   user_input = None 
)
Authenticate application step.

Definition at line 62 of file config_flow.py.

◆ async_step_auth_captcha()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler.async_step_auth_captcha (   self,
dict[str, str] | None   user_input = None 
)
Captcha verification step.

Definition at line 91 of file config_flow.py.

◆ async_step_auth_mfa()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler.async_step_auth_mfa (   self,
dict[str, str] | None   user_input = None 
)
Authenticate mfa step.

Definition at line 82 of file config_flow.py.

◆ async_step_auth_user()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler.async_step_auth_user (   self,
dict[str, str] | None   user_input = None 
)
Authenticate user step.

Definition at line 72 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.starline.config_flow.StarlineFlowHandler.async_step_user (   self,
dict[str, str] | None   user_input = None 
)
Handle a flow initialized by the user.

Definition at line 56 of file config_flow.py.

Member Data Documentation

◆ _app_code

homeassistant.components.starline.config_flow.StarlineFlowHandler._app_code
private

Definition at line 191 of file config_flow.py.

◆ _app_id

homeassistant.components.starline.config_flow.StarlineFlowHandler._app_id
private

Definition at line 67 of file config_flow.py.

◆ _app_secret

homeassistant.components.starline.config_flow.StarlineFlowHandler._app_secret
private

Definition at line 68 of file config_flow.py.

◆ _app_token

homeassistant.components.starline.config_flow.StarlineFlowHandler._app_token
private

Definition at line 194 of file config_flow.py.

◆ _auth

homeassistant.components.starline.config_flow.StarlineFlowHandler._auth
private

Definition at line 54 of file config_flow.py.

◆ _captcha_code

homeassistant.components.starline.config_flow.StarlineFlowHandler._captcha_code
private

Definition at line 96 of file config_flow.py.

◆ _captcha_image

homeassistant.components.starline.config_flow.StarlineFlowHandler._captcha_image
private

Definition at line 229 of file config_flow.py.

◆ _captcha_sid

homeassistant.components.starline.config_flow.StarlineFlowHandler._captcha_sid
private

Definition at line 228 of file config_flow.py.

◆ _mfa_code

homeassistant.components.starline.config_flow.StarlineFlowHandler._mfa_code
private

Definition at line 87 of file config_flow.py.

◆ _password

homeassistant.components.starline.config_flow.StarlineFlowHandler._password
private

Definition at line 78 of file config_flow.py.

◆ _phone_number

homeassistant.components.starline.config_flow.StarlineFlowHandler._phone_number
private

Definition at line 222 of file config_flow.py.

◆ _slnet_token

homeassistant.components.starline.config_flow.StarlineFlowHandler._slnet_token
private

Definition at line 49 of file config_flow.py.

◆ _slnet_token_expires

homeassistant.components.starline.config_flow.StarlineFlowHandler._slnet_token_expires
private

Definition at line 50 of file config_flow.py.

◆ _user_id

homeassistant.components.starline.config_flow.StarlineFlowHandler._user_id
private

Definition at line 48 of file config_flow.py.

◆ _user_slid

homeassistant.components.starline.config_flow.StarlineFlowHandler._user_slid
private

Definition at line 47 of file config_flow.py.

◆ _username

homeassistant.components.starline.config_flow.StarlineFlowHandler._username
private

Definition at line 77 of file config_flow.py.

◆ VERSION

int homeassistant.components.starline.config_flow.StarlineFlowHandler.VERSION = 1
static

Definition at line 32 of file config_flow.py.


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