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

Public Member Functions

ConfigFlowResult async_oauth_create_entry (self, dict[str, Any] data)
 
ConfigFlowResult async_step_channels (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)
 
dict[str, Any] extra_authorize_data (self)
 
YouTube get_resource (self, str token)
 
logging.Logger logger (self)
 

Static Public Member Functions

YouTubeOptionsFlowHandler async_get_options_flow (ConfigEntry config_entry)
 

Static Public Attributes

 DOMAIN = DOMAIN
 
 None
 
 str
 

Private Attributes

 _data
 
 _title
 
 _youtube
 

Detailed Description

Config flow to handle Google OAuth2 authentication.

Definition at line 39 of file config_flow.py.

Member Function Documentation

◆ async_get_options_flow()

YouTubeOptionsFlowHandler homeassistant.components.youtube.config_flow.OAuth2FlowHandler.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the options flow for this handler.

Definition at line 53 of file config_flow.py.

◆ async_oauth_create_entry()

ConfigFlowResult homeassistant.components.youtube.config_flow.OAuth2FlowHandler.async_oauth_create_entry (   self,
dict[str, Any]  data 
)
Create an entry for the flow, or update existing entry.

Definition at line 95 of file config_flow.py.

◆ async_step_channels()

ConfigFlowResult homeassistant.components.youtube.config_flow.OAuth2FlowHandler.async_step_channels (   self,
dict[str, Any] | None   user_input = None 
)
Select which channels to track.

Definition at line 130 of file config_flow.py.

◆ async_step_reauth()

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

Definition at line 74 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.youtube.config_flow.OAuth2FlowHandler.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Confirm reauth dialog.

Definition at line 80 of file config_flow.py.

◆ extra_authorize_data()

dict[str, Any] homeassistant.components.youtube.config_flow.OAuth2FlowHandler.extra_authorize_data (   self)
Extra data that needs to be appended to the authorize url.

Definition at line 65 of file config_flow.py.

◆ get_resource()

YouTube homeassistant.components.youtube.config_flow.OAuth2FlowHandler.get_resource (   self,
str  token 
)
Get Youtube resource async.

Definition at line 88 of file config_flow.py.

◆ logger()

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

Definition at line 60 of file config_flow.py.

Member Data Documentation

◆ _data

homeassistant.components.youtube.config_flow.OAuth2FlowHandler._data
private

Definition at line 115 of file config_flow.py.

◆ _title

homeassistant.components.youtube.config_flow.OAuth2FlowHandler._title
private

Definition at line 114 of file config_flow.py.

◆ _youtube

homeassistant.components.youtube.config_flow.OAuth2FlowHandler._youtube
private

Definition at line 91 of file config_flow.py.

◆ DOMAIN

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

Definition at line 47 of file config_flow.py.

◆ None

homeassistant.components.youtube.config_flow.OAuth2FlowHandler.None
static

Definition at line 49 of file config_flow.py.

◆ str

homeassistant.components.youtube.config_flow.OAuth2FlowHandler.str
static

Definition at line 45 of file config_flow.py.


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