esphome::api::HomeAssistantServiceCallAction< Ts > Class Template Reference

#include <homeassistant_service.h>

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

Data Structures
struct	Flags

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)
template<typename T >
void	set_response_template (T response_template)
void	set_wants_status ()
void	set_wants_response ()
Trigger< JsonObjectConst, Ts... > *	get_success_trigger_with_response () const
Trigger< Ts... > *	get_success_trigger () const
Trigger< std::string, Ts... > *	get_error_trigger () const
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.
int	num_running_total ()
	The total number of actions that are currently running in this plus any of the following actions in the chain.

Protected Attributes
APIServer *	parent_
TemplatableStringValue< Ts... >	service_ {}
std::vector< TemplatableKeyValuePair< Ts... > >	data_
std::vector< TemplatableKeyValuePair< Ts... > >	data_template_
std::vector< TemplatableKeyValuePair< Ts... > >	variables_
TemplatableStringValue< Ts... >	response_template_ {""}
Trigger< JsonObjectConst, Ts... > *	success_trigger_with_response_ = new Trigger<JsonObjectConst, Ts...>()
Trigger< Ts... > *	success_trigger_ = new Trigger<Ts...>()
Trigger< std::string, Ts... > *	error_trigger_ = new Trigger<std::string, Ts...>()
struct esphome::api::HomeAssistantServiceCallAction::Flags	flags_
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.

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 88 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 90 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, T value )

inline

Definition at line 99 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, T value )

inline

Definition at line 100 of file homeassistant_service.h.

add_variable()

template<typename... Ts>

template<typename T >

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

inline

Definition at line 103 of file homeassistant_service.h.

get_error_trigger()

template<typename... Ts>

Trigger< std::string, Ts... > * esphome::api::HomeAssistantServiceCallAction< Ts >::get_error_trigger ( ) const

inline

Definition at line 122 of file homeassistant_service.h.

get_success_trigger()

template<typename... Ts>

Trigger< Ts... > * esphome::api::HomeAssistantServiceCallAction< Ts >::get_success_trigger ( ) const

inline

Definition at line 121 of file homeassistant_service.h.

get_success_trigger_with_response()

template<typename... Ts>

Trigger< JsonObjectConst, Ts... > * esphome::api::HomeAssistantServiceCallAction< Ts >::get_success_trigger_with_response ( ) const

inline

Definition at line 117 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 125 of file homeassistant_service.h.

set_response_template()

template<typename... Ts>

template<typename T >

void esphome::api::HomeAssistantServiceCallAction< Ts >::set_response_template ( T response_template )

inline

Definition at line 108 of file homeassistant_service.h.

set_service()

template<typename... Ts>

template<typename T >

void esphome::api::HomeAssistantServiceCallAction< Ts >::set_service ( T service )

inline

Definition at line 94 of file homeassistant_service.h.

set_wants_response()

template<typename... Ts>

void esphome::api::HomeAssistantServiceCallAction< Ts >::set_wants_response ( )

inline

Definition at line 114 of file homeassistant_service.h.

set_wants_status()

template<typename... Ts>

void esphome::api::HomeAssistantServiceCallAction< Ts >::set_wants_status ( )

inline

Definition at line 113 of file homeassistant_service.h.

Field Documentation

data_

template<typename... Ts>

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

protected

Definition at line 194 of file homeassistant_service.h.

data_template_

template<typename... Ts>

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

protected

Definition at line 195 of file homeassistant_service.h.

error_trigger_

template<typename... Ts>

Trigger<std::string, Ts...>* esphome::api::HomeAssistantServiceCallAction< Ts >::error_trigger_ = new Trigger<std::string, Ts...>()

protected

Definition at line 203 of file homeassistant_service.h.

flags_

template<typename... Ts>

struct esphome::api::HomeAssistantServiceCallAction::Flags esphome::api::HomeAssistantServiceCallAction< Ts >::flags_

protected

parent_

template<typename... Ts>

APIServer* esphome::api::HomeAssistantServiceCallAction< Ts >::parent_

protected

Definition at line 192 of file homeassistant_service.h.

response_template_

template<typename... Ts>

TemplatableStringValue<Ts...> esphome::api::HomeAssistantServiceCallAction< Ts >::response_template_ {""}

protected

Definition at line 199 of file homeassistant_service.h.

service_

template<typename... Ts>

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

protected

Definition at line 193 of file homeassistant_service.h.

success_trigger_

template<typename... Ts>

Trigger<Ts...>* esphome::api::HomeAssistantServiceCallAction< Ts >::success_trigger_ = new Trigger<Ts...>()

protected

Definition at line 202 of file homeassistant_service.h.

success_trigger_with_response_

template<typename... Ts>

Trigger<JsonObjectConst, Ts...>* esphome::api::HomeAssistantServiceCallAction< Ts >::success_trigger_with_response_ = new Trigger<JsonObjectConst, Ts...>()

protected

Definition at line 200 of file homeassistant_service.h.

variables_

template<typename... Ts>

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

protected

Definition at line 196 of file homeassistant_service.h.

---

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

• esphome/components/api/homeassistant_service.h