Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.alexa.capabilities.AlexaTimeHoldController Class Reference
Inheritance diagram for homeassistant.components.alexa.capabilities.AlexaTimeHoldController:
[legend]
Collaboration diagram for homeassistant.components.alexa.capabilities.AlexaTimeHoldController:
[legend]

Public Member Functions

None __init__ (self, State entity, bool allow_remote_resume=False)
 
dict[str, Any]|None configuration (self)
 
str name (self)
 
- Public Member Functions inherited from homeassistant.components.alexa.capabilities.AlexaCapability
None __init__ (self, State entity, str|None instance=None, bool|None non_controllable_properties=None)
 
list[dict[str, Any]]|None camera_stream_configurations (self)
 
bool|None capability_proactively_reported (self)
 
dict[str, list[dict[str, Any]]] capability_resources (self)
 
dict[str, Any]|None configurations (self)
 
dict[str, Any] get_property (self, str name)
 
list[dict[str, str]]|None inputs (self)
 
bool|None properties_non_controllable (self)
 
bool properties_proactively_reported (self)
 
bool properties_retrievable (self)
 
list[dict] properties_supported (self)
 
dict[str, Any]|None semantics (self)
 
dict[str, Any] serialize_discovery (self)
 
Generator[dict[str, Any]] serialize_properties (self)
 
list[str] supported_operations (self)
 
bool|None supports_deactivation (self)
 

Static Public Attributes

dictionary supported_locales = {"en-US"}
 

Private Attributes

 _allow_remote_resume
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.alexa.capabilities.AlexaCapability
 entity
 
 instance
 

Detailed Description

Implements Alexa.TimeHoldController.

https://developer.amazon.com/docs/device-apis/alexa-timeholdcontroller.html

Definition at line 2425 of file capabilities.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.alexa.capabilities.AlexaTimeHoldController.__init__ (   self,
State  entity,
bool   allow_remote_resume = False 
)
Initialize the entity.

Definition at line 2433 of file capabilities.py.

Member Function Documentation

◆ configuration()

dict[str, Any] | None homeassistant.components.alexa.capabilities.AlexaTimeHoldController.configuration (   self)
Return configuration object.

Set allowRemoteResume to True if Alexa can restart the operation on the device.
When false, Alexa does not send the Resume directive.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2442 of file capabilities.py.

◆ name()

str homeassistant.components.alexa.capabilities.AlexaTimeHoldController.name (   self)
Return the Alexa API name of this interface.

Reimplemented from homeassistant.components.alexa.capabilities.AlexaCapability.

Definition at line 2438 of file capabilities.py.

Member Data Documentation

◆ _allow_remote_resume

homeassistant.components.alexa.capabilities.AlexaTimeHoldController._allow_remote_resume
private

Definition at line 2436 of file capabilities.py.

◆ supported_locales

dictionary homeassistant.components.alexa.capabilities.AlexaTimeHoldController.supported_locales = {"en-US"}
static

Definition at line 2431 of file capabilities.py.


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