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

Public Member Functions

ConfigFlowResult async_oauth_create_entry (self, dict data)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_reauth_confirm (self, user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
dict extra_authorize_data (self)
 
logging.Logger logger (self)
 

Public Attributes

 source
 

Static Public Attributes

 DOMAIN = DOMAIN
 

Detailed Description

Config flow to handle yolink OAuth2 authentication.

Definition at line 15 of file config_flow.py.

Member Function Documentation

◆ async_oauth_create_entry()

ConfigFlowResult homeassistant.components.yolink.config_flow.OAuth2FlowHandler.async_oauth_create_entry (   self,
dict  data 
)
Create an oauth config entry or update existing entry for reauth.

Definition at line 45 of file config_flow.py.

◆ async_step_reauth()

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

Definition at line 33 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.yolink.config_flow.OAuth2FlowHandler.async_step_reauth_confirm (   self,
  user_input = None 
)
Dialog that informs the user that reauth is required.

Definition at line 39 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.yolink.config_flow.OAuth2FlowHandler.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a flow start.

Definition at line 53 of file config_flow.py.

◆ extra_authorize_data()

dict homeassistant.components.yolink.config_flow.OAuth2FlowHandler.extra_authorize_data (   self)
Extra data that needs to be appended to the authorize url.

Definition at line 28 of file config_flow.py.

◆ logger()

logging.Logger homeassistant.components.yolink.config_flow.OAuth2FlowHandler.logger (   self)
Return logger.

Definition at line 23 of file config_flow.py.

Member Data Documentation

◆ DOMAIN

homeassistant.components.yolink.config_flow.OAuth2FlowHandler.DOMAIN = DOMAIN
static

Definition at line 20 of file config_flow.py.

◆ source

homeassistant.components.yolink.config_flow.OAuth2FlowHandler.source

Definition at line 47 of file config_flow.py.


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