Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | List of all members
homeassistant.components.alexa.intent.AlexaIntentResponse Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, dict[str, Any]|None intent_info)
 
None add_card (self, CardType card_type, str title, str content)
 
None add_reprompt (self, SpeechType speech_type, str text)
 
None add_speech (self, SpeechType speech_type, str text)
 
dict[str, Any] as_dict (self)
 

Public Attributes

 card
 
 hass
 
 reprompt
 
 should_end_session
 
 speech
 

Detailed Description

Help generating the response for Alexa.

Definition at line 240 of file intent.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.alexa.intent.AlexaIntentResponse.__init__ (   self,
HomeAssistant  hass,
dict[str, Any] | None  intent_info 
) 
Initialize the response.

Definition at line 243 of file intent.py.

Member Function Documentation

◆ add_card()

None homeassistant.components.alexa.intent.AlexaIntentResponse.add_card (   self,
CardType  card_type,
str  title,
str  content 
) 
Add a card to the response.

Definition at line 266 of file intent.py.

◆ add_reprompt()

None homeassistant.components.alexa.intent.AlexaIntentResponse.add_reprompt (   self,
SpeechType  speech_type,
str  text 
) 
Add reprompt if user does not answer.

Definition at line 288 of file intent.py.

◆ add_speech()

None homeassistant.components.alexa.intent.AlexaIntentResponse.add_speech (   self,
SpeechType  speech_type,
str  text 
) 
Add speech to the response.

Definition at line 280 of file intent.py.

◆ as_dict()

dict[str, Any] homeassistant.components.alexa.intent.AlexaIntentResponse.as_dict (   self) 
Return response in an Alexa valid dict.

Definition at line 298 of file intent.py.

Member Data Documentation

◆ card

homeassistant.components.alexa.intent.AlexaIntentResponse.card

Definition at line 273 of file intent.py.

◆ hass

homeassistant.components.alexa.intent.AlexaIntentResponse.hass

Definition at line 245 of file intent.py.

◆ reprompt

homeassistant.components.alexa.intent.AlexaIntentResponse.reprompt

Definition at line 296 of file intent.py.

◆ should_end_session

homeassistant.components.alexa.intent.AlexaIntentResponse.should_end_session

Definition at line 250 of file intent.py.

◆ speech

homeassistant.components.alexa.intent.AlexaIntentResponse.speech

Definition at line 286 of file intent.py.

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