homeassistant.components.nest.config_flow.NestFlowHandler Class Reference

Inheritance diagram for homeassistant.components.nest.config_flow.NestFlowHandler:

Collaboration diagram for homeassistant.components.nest.config_flow.NestFlowHandler:

Public Member Functions
None	__init__ (self)
str	async_generate_authorize_url (self)
ConfigFlowResult	async_oauth_create_entry (self, dict[str, Any] data)
ConfigFlowResult	async_step_cloud_project (self, dict|None user_input=None)
ConfigFlowResult	async_step_create_cloud_project (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_device_project (self, dict|None user_input=None)
ConfigFlowResult	async_step_pubsub (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_pubsub_subscription (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_pubsub_topic (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_user (self, dict[str, Any]|None user_input=None)
dict[str, str]	extra_authorize_data (self)
logging.Logger	logger (self)

Public Attributes
	source

Static Public Attributes
	DOMAIN = DOMAIN
int	VERSION = 1

Private Member Functions
ConfigFlowResult	_async_finish (self)

Private Attributes
	_admin_client
	_eligible_topics
	_structure_config_title

Detailed Description

Config flow to handle authentication for both APIs.

Definition at line 85 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.nest.config_flow.NestFlowHandler.__init__

(

self

)

Initialize NestFlowHandler.

Definition at line 93 of file config_flow.py.

Member Function Documentation

_async_finish()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler._async_finish (   self )

private

Create an entry for the SDM flow.

Definition at line 399 of file config_flow.py.

async_generate_authorize_url()

str homeassistant.components.nest.config_flow.NestFlowHandler.async_generate_authorize_url

(

self

)

Generate a url for the user to authorize based on user input.

Definition at line 118 of file config_flow.py.

async_oauth_create_entry()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_oauth_create_entry	(		self,
		dict[str, Any]	data
	)

Complete OAuth setup and finish pubsub or finish.

Definition at line 125 of file config_flow.py.

async_step_cloud_project()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_cloud_project	(		self,
		dict | None	user_input = None
	)

Handle cloud project in user input.

Definition at line 190 of file config_flow.py.

async_step_create_cloud_project()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_create_cloud_project	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle initial step in app credentials flow.

Definition at line 163 of file config_flow.py.

async_step_device_project()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_device_project	(		self,
		dict | None	user_input = None
	)

Collect device access project from user input.

Definition at line 210 of file config_flow.py.

async_step_pubsub()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_pubsub	(		self,
		dict[str, Any] | None	user_input = None
	)

Configure and the pre-requisites to configure Pub/Sub topics and subscriptions.

Definition at line 243 of file config_flow.py.

async_step_pubsub_subscription()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_pubsub_subscription	(		self,
		dict[str, Any] | None	user_input = None
	)

Configure and create Pub/Sub subscription.

Definition at line 313 of file config_flow.py.

async_step_pubsub_topic()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_pubsub_topic	(		self,
		dict[str, Any] | None	user_input = None
	)

Configure and create Pub/Sub topic.

Definition at line 290 of file config_flow.py.

async_step_reauth()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_reauth	(		self,
		Mapping[str, Any]	entry_data
	)

Perform reauth upon an API authentication error.

Definition at line 135 of file config_flow.py.

async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_reauth_confirm	(		self,
		dict[str, Any] | None	user_input = None
	)

Confirm reauth dialog.

Definition at line 144 of file config_flow.py.

async_step_user()

ConfigFlowResult homeassistant.components.nest.config_flow.NestFlowHandler.async_step_user	(		self,
		dict[str, Any] | None	user_input = None
	)

Handle a flow initialized by the user.

Definition at line 152 of file config_flow.py.

extra_authorize_data()

dict[str, str] homeassistant.components.nest.config_flow.NestFlowHandler.extra_authorize_data

(

self

)

Extra data that needs to be appended to the authorize url.

Definition at line 109 of file config_flow.py.

logger()

logging.Logger homeassistant.components.nest.config_flow.NestFlowHandler.logger

(

self

)

Return logger.

Definition at line 104 of file config_flow.py.

Member Data Documentation

_admin_client

homeassistant.components.nest.config_flow.NestFlowHandler._admin_client

private

Definition at line 257 of file config_flow.py.

_eligible_topics

homeassistant.components.nest.config_flow.NestFlowHandler._eligible_topics

private

Definition at line 272 of file config_flow.py.

_structure_config_title

homeassistant.components.nest.config_flow.NestFlowHandler._structure_config_title

private

Definition at line 360 of file config_flow.py.

DOMAIN

homeassistant.components.nest.config_flow.NestFlowHandler.DOMAIN = DOMAIN

static

Definition at line 90 of file config_flow.py.

source

homeassistant.components.nest.config_flow.NestFlowHandler.source

Definition at line 130 of file config_flow.py.

VERSION

int homeassistant.components.nest.config_flow.NestFlowHandler.VERSION = 1

static

Definition at line 91 of file config_flow.py.

---

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

• core/homeassistant/components/nest/config_flow.py