homeassistant.components.alexa.smart_home.AlexaConfig Class Reference

Inheritance diagram for homeassistant.components.alexa.smart_home.AlexaConfig:

Collaboration diagram for homeassistant.components.alexa.smart_home.AlexaConfig:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigType config)
str|None	async_accept_grant (self, str code)
str|None	async_get_access_token (self)
None	async_invalidate_access_token (self)
str|URL|None	endpoint (self)
dict[str, Any]	entity_config (self)
str|None	locale (self)
bool	should_expose (self, str entity_id)
bool	should_report_state (self)
bool	supports_auth (self)
str	user_identifier (self)
Public Member Functions inherited from homeassistant.components.alexa.config.AbstractConfig
None	__init__ (self, HomeAssistant hass)
None	async_deinitialize (self)
None	async_disable_proactive_mode (self)
None	async_enable_proactive_mode (self)
None	async_initialize (self)
bool	authorized (self)
str	generate_alexa_id (self, str entity_id)
bool	is_reporting_states (self)
None	set_authorized (self, bool authorized)

Private Attributes
	_auth
	_config

Additional Inherited Members
Public Attributes inherited from homeassistant.components.alexa.config.AbstractConfig
	hass
Static Public Attributes inherited from homeassistant.components.alexa.config.AbstractConfig
	None

Detailed Description

Alexa config.

Definition at line 41 of file smart_home.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.alexa.smart_home.AlexaConfig.__init__	(		self,
		HomeAssistant	hass,
		ConfigType	config
	)

Initialize Alexa config.

Definition at line 46 of file smart_home.py.

Member Function Documentation

async_accept_grant()

str | None homeassistant.components.alexa.smart_home.AlexaConfig.async_accept_grant	(		self,
		str	code
	)

Accept a grant.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 113 of file smart_home.py.

async_get_access_token()

str | None homeassistant.components.alexa.smart_home.AlexaConfig.async_get_access_token

(

self

)

Get an access token.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 108 of file smart_home.py.

async_invalidate_access_token()

None homeassistant.components.alexa.smart_home.AlexaConfig.async_invalidate_access_token

(

self

)

Invalidate access token.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 103 of file smart_home.py.

endpoint()

str | URL | None homeassistant.components.alexa.smart_home.AlexaConfig.endpoint

(

self

)

Endpoint for report state.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 67 of file smart_home.py.

entity_config()

dict[str, Any] homeassistant.components.alexa.smart_home.AlexaConfig.entity_config

(

self

)

Return entity config.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 72 of file smart_home.py.

locale()

str | None homeassistant.components.alexa.smart_home.AlexaConfig.locale

(

self

)

Return config locale.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 77 of file smart_home.py.

should_expose()

bool homeassistant.components.alexa.smart_home.AlexaConfig.should_expose	(		self,
		str	entity_id
	)

If an entity should be exposed.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 87 of file smart_home.py.

should_report_state()

bool homeassistant.components.alexa.smart_home.AlexaConfig.should_report_state

(

self

)

Return if we should proactively report states.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 62 of file smart_home.py.

supports_auth()

bool homeassistant.components.alexa.smart_home.AlexaConfig.supports_auth

(

self

)

Return if config supports auth.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 57 of file smart_home.py.

user_identifier()

str homeassistant.components.alexa.smart_home.AlexaConfig.user_identifier

(

self

)

Return an identifier for the user that represents this config.

Reimplemented from homeassistant.components.alexa.config.AbstractConfig.

Definition at line 82 of file smart_home.py.

Member Data Documentation

_auth

homeassistant.components.alexa.smart_home.AlexaConfig._auth

private

Definition at line 52 of file smart_home.py.

_config

homeassistant.components.alexa.smart_home.AlexaConfig._config

private

Definition at line 49 of file smart_home.py.

---

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

• core/homeassistant/components/alexa/smart_home.py