Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
homeassistant.components.vizio.config_flow.VizioConfigFlow Class Reference
Inheritance diagram for homeassistant.components.vizio.config_flow.VizioConfigFlow:
[legend]
Collaboration diagram for homeassistant.components.vizio.config_flow.VizioConfigFlow:
[legend]

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_import (self, dict[str, Any] import_data)
 
ConfigFlowResult async_step_pair_tv (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_pairing_complete (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_pairing_complete_import (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_zeroconf (self, zeroconf.ZeroconfServiceInfo discovery_info)
 
- 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

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

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 _create_entry (self, dict[str, Any] input_dict)
 
ConfigFlowResult _pairing_complete (self, str step_id)
 

Private Attributes

 _apps
 
 _ch_type
 
 _data
 
 _must_show_form
 
 _pairing_token
 
 _user_schema
 

Additional Inherited Members

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

Definition at line 174 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.vizio.config_flow.VizioConfigFlow.__init__ (   self) 
Initialize config flow.

Definition at line 185 of file config_flow.py.

Member Function Documentation

◆ _create_entry()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow._create_entry (   self,
dict[str, Any]  input_dict 
)
private 
Create vizio config entry.

Definition at line 194 of file config_flow.py.

◆ _pairing_complete()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow._pairing_complete (   self,
str  step_id 
)
private 
Handle config flow completion.

Definition at line 453 of file config_flow.py.

◆ async_get_options_flow()

VizioOptionsConfigFlow homeassistant.components.vizio.config_flow.VizioConfigFlow.async_get_options_flow ( ConfigEntry  config_entry)
static 
Get the options flow for this handler.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 181 of file config_flow.py.

◆ async_step_import()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow.async_step_import (   self,
dict[str, Any]  import_data 
) 
Import a config entry from configuration.yaml.

Definition at line 284 of file config_flow.py.

◆ async_step_pair_tv()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow.async_step_pair_tv (   self,
dict[str, Any] | None   user_input = None 
) 
Start pairing process for TV.

Ask user for PIN to complete pairing process.

Definition at line 386 of file config_flow.py.

◆ async_step_pairing_complete()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow.async_step_pairing_complete (   self,
dict[str, Any] | None   user_input = None 
) 
Complete non-import sourced config flow.

Display final message to user confirming pairing.

Definition at line 465 of file config_flow.py.

◆ async_step_pairing_complete_import()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow.async_step_pairing_complete_import (   self,
dict[str, Any] | None   user_input = None 
) 
Complete import sourced config flow.

Display final message to user confirming pairing and displaying
access token.

Definition at line 474 of file config_flow.py.

◆ async_step_user()

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

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 205 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.vizio.config_flow.VizioConfigFlow.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
) 
Handle zeroconf discovery.

Definition at line 346 of file config_flow.py.

Member Data Documentation

◆ _apps

homeassistant.components.vizio.config_flow.VizioConfigFlow._apps
private

Definition at line 343 of file config_flow.py.

◆ _ch_type

homeassistant.components.vizio.config_flow.VizioConfigFlow._ch_type
private

Definition at line 409 of file config_flow.py.

◆ _data

homeassistant.components.vizio.config_flow.VizioConfigFlow._data
private

Definition at line 270 of file config_flow.py.

◆ _must_show_form

homeassistant.components.vizio.config_flow.VizioConfigFlow._must_show_form
private

Definition at line 237 of file config_flow.py.

◆ _pairing_token

homeassistant.components.vizio.config_flow.VizioConfigFlow._pairing_token
private

Definition at line 410 of file config_flow.py.

◆ _user_schema

homeassistant.components.vizio.config_flow.VizioConfigFlow._user_schema
private

Definition at line 213 of file config_flow.py.

◆ VERSION

int homeassistant.components.vizio.config_flow.VizioConfigFlow.VERSION = 1
static

Definition at line 177 of file config_flow.py.

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