homeassistant.components.alexa.config.AbstractConfig Class Reference

Inheritance diagram for homeassistant.components.alexa.config.AbstractConfig:

Collaboration diagram for homeassistant.components.alexa.config.AbstractConfig:

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

Public Attributes
	hass

Static Public Attributes
	None

Private Attributes
	_enable_proactive_mode_lock
	_store
	_unsub_proactive_report

Detailed Description

Hold the configuration for Alexa.

Definition at line 24 of file config.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.alexa.config.AbstractConfig.__init__	(		self,
		HomeAssistant	hass
	)

Initialize abstract config.

Definition at line 30 of file config.py.

Member Function Documentation

async_accept_grant()

str | None homeassistant.components.alexa.config.AbstractConfig.async_accept_grant	(		self,
		str	code
	)

Accept a grant.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 118 of file config.py.

async_deinitialize()

None homeassistant.components.alexa.config.AbstractConfig.async_deinitialize

(

self

)

Remove listeners.

Definition at line 42 of file config.py.

async_disable_proactive_mode()

None homeassistant.components.alexa.config.AbstractConfig.async_disable_proactive_mode

(

self

)

Disable proactive mode.

Definition at line 93 of file config.py.

async_enable_proactive_mode()

None homeassistant.components.alexa.config.AbstractConfig.async_enable_proactive_mode

(

self

)

Enable proactive mode.

Definition at line 83 of file config.py.

async_get_access_token()

str | None homeassistant.components.alexa.config.AbstractConfig.async_get_access_token

(

self

)

Get an access token.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 114 of file config.py.

async_initialize()

None homeassistant.components.alexa.config.AbstractConfig.async_initialize

(

self

)

Perform async initialization of config.

Definition at line 36 of file config.py.

async_invalidate_access_token()

None homeassistant.components.alexa.config.AbstractConfig.async_invalidate_access_token

(

self

)

Invalidate access token.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 110 of file config.py.

authorized()

bool homeassistant.components.alexa.config.AbstractConfig.authorized

(

self

)

Return authorization status.

Definition at line 123 of file config.py.

endpoint()

str | URL | None homeassistant.components.alexa.config.AbstractConfig.endpoint

(

self

)

Endpoint for report state.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 60 of file config.py.

entity_config()

dict[str, Any] homeassistant.components.alexa.config.AbstractConfig.entity_config

(

self

)

Return entity config.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 69 of file config.py.

generate_alexa_id()

str homeassistant.components.alexa.config.AbstractConfig.generate_alexa_id	(		self,
		str	entity_id
	)

Return the alexa ID for an entity ID.

Definition at line 105 of file config.py.

is_reporting_states()

bool homeassistant.components.alexa.config.AbstractConfig.is_reporting_states

(

self

)

Return if proactive mode is enabled.

Definition at line 74 of file config.py.

locale()

str | None homeassistant.components.alexa.config.AbstractConfig.locale

(

self

)

Return config locale.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 65 of file config.py.

set_authorized()

None homeassistant.components.alexa.config.AbstractConfig.set_authorized	(		self,
		bool	authorized
	)

Set authorization status.

- Set when an incoming message is received from Alexa.
- Unset if state reporting fails

Definition at line 127 of file config.py.

should_expose()

bool homeassistant.components.alexa.config.AbstractConfig.should_expose	(		self,
		str	entity_id
	)

If an entity should be exposed.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 101 of file config.py.

should_report_state()

bool homeassistant.components.alexa.config.AbstractConfig.should_report_state

(

self

)

Return if states should be proactively reported.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 54 of file config.py.

supports_auth()

bool homeassistant.components.alexa.config.AbstractConfig.supports_auth

(

self

)

Return if config supports auth.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 49 of file config.py.

user_identifier()

str homeassistant.components.alexa.config.AbstractConfig.user_identifier

(

self

)

Return an identifier for the user that represents this config.

Reimplemented in homeassistant.components.alexa.smart_home.AlexaConfig.

Definition at line 80 of file config.py.

Member Data Documentation

_enable_proactive_mode_lock

homeassistant.components.alexa.config.AbstractConfig._enable_proactive_mode_lock

private

Definition at line 33 of file config.py.

_store

homeassistant.components.alexa.config.AbstractConfig._store

private

Definition at line 38 of file config.py.

_unsub_proactive_report

homeassistant.components.alexa.config.AbstractConfig._unsub_proactive_report

private

Definition at line 89 of file config.py.

hass

homeassistant.components.alexa.config.AbstractConfig.hass

Definition at line 32 of file config.py.

None

homeassistant.components.alexa.config.AbstractConfig.None

static

Definition at line 28 of file config.py.

---

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

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