ESPHome  2024.3.1
Public Member Functions | Protected Attributes
esphome::api::HomeAssistantServiceCallAction< Ts > Class Template Reference

#include <homeassistant_service.h>

Inheritance diagram for esphome::api::HomeAssistantServiceCallAction< Ts >:
esphome::Action< Ts... >

Public Member Functions

 HomeAssistantServiceCallAction (APIServer *parent, bool is_event)
 
template<typename T >
void set_service (T service)
 
template<typename T >
void add_data (std::string key, T value)
 
template<typename T >
void add_data_template (std::string key, T value)
 
template<typename T >
void add_variable (std::string key, T value)
 
void play (Ts... x) override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void play_complex (Ts... x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running. More...
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain. More...
 

Protected Attributes

APIServerparent_
 
bool is_event_
 
TemplatableStringValue< Ts... > service_ {}
 
std::vector< TemplatableKeyValuePair< Ts... > > data_
 
std::vector< TemplatableKeyValuePair< Ts... > > data_template_
 
std::vector< TemplatableKeyValuePair< Ts... > > variables_
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (Ts... x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Detailed Description

template<typename... Ts>
class esphome::api::HomeAssistantServiceCallAction< Ts >

Definition at line 32 of file homeassistant_service.h.

Constructor & Destructor Documentation

◆ HomeAssistantServiceCallAction()

template<typename... Ts>
esphome::api::HomeAssistantServiceCallAction< Ts >::HomeAssistantServiceCallAction ( APIServer parent,
bool  is_event 
)
inlineexplicit

Definition at line 34 of file homeassistant_service.h.

Member Function Documentation

◆ add_data()

template<typename... Ts>
template<typename T >
void esphome::api::HomeAssistantServiceCallAction< Ts >::add_data ( std::string  key,
value 
)
inline

Definition at line 38 of file homeassistant_service.h.

◆ add_data_template()

template<typename... Ts>
template<typename T >
void esphome::api::HomeAssistantServiceCallAction< Ts >::add_data_template ( std::string  key,
value 
)
inline

Definition at line 41 of file homeassistant_service.h.

◆ add_variable()

template<typename... Ts>
template<typename T >
void esphome::api::HomeAssistantServiceCallAction< Ts >::add_variable ( std::string  key,
value 
)
inline

Definition at line 44 of file homeassistant_service.h.

◆ play()

template<typename... Ts>
void esphome::api::HomeAssistantServiceCallAction< Ts >::play ( Ts...  x)
inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 48 of file homeassistant_service.h.

◆ set_service()

template<typename... Ts>
template<typename T >
void esphome::api::HomeAssistantServiceCallAction< Ts >::set_service ( service)
inline

Definition at line 36 of file homeassistant_service.h.

Field Documentation

◆ data_

template<typename... Ts>
std::vector<TemplatableKeyValuePair<Ts...> > esphome::api::HomeAssistantServiceCallAction< Ts >::data_
protected

Definition at line 77 of file homeassistant_service.h.

◆ data_template_

template<typename... Ts>
std::vector<TemplatableKeyValuePair<Ts...> > esphome::api::HomeAssistantServiceCallAction< Ts >::data_template_
protected

Definition at line 78 of file homeassistant_service.h.

◆ is_event_

template<typename... Ts>
bool esphome::api::HomeAssistantServiceCallAction< Ts >::is_event_
protected

Definition at line 75 of file homeassistant_service.h.

◆ parent_

template<typename... Ts>
APIServer* esphome::api::HomeAssistantServiceCallAction< Ts >::parent_
protected

Definition at line 74 of file homeassistant_service.h.

◆ service_

template<typename... Ts>
TemplatableStringValue<Ts...> esphome::api::HomeAssistantServiceCallAction< Ts >::service_ {}
protected

Definition at line 76 of file homeassistant_service.h.

◆ variables_

template<typename... Ts>
std::vector<TemplatableKeyValuePair<Ts...> > esphome::api::HomeAssistantServiceCallAction< Ts >::variables_
protected

Definition at line 79 of file homeassistant_service.h.


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