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

#include <user_services.h>

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

Public Member Functions
	APIRespondAction (APIServer *parent)
template<typename V >
void	set_success (V success)
template<typename V >
void	set_error_message (V error)
void	set_is_optional_mode (bool is_optional)
void	set_data (std::function< void(Ts..., JsonObject)> func)
void	play (const Ts &...x) override
Public Member Functions inherited from esphome::Action< Ts... >
virtual void	play_complex (const 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_
TemplatableValue< bool, Ts... >	success_ {true}
TemplatableValue< std::string, Ts... >	error_message_ {""}
std::function< void(Ts..., JsonObject)>	json_builder_
bool	has_data_ {false}
bool	is_optional_mode_ {false}
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_ (const Ts &...x)
void	play_next_tuple_ (const std::tuple< Ts... > &tuple, std::index_sequence< 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::APIRespondAction< Ts >

Definition at line 224 of file user_services.h.

Constructor & Destructor Documentation

APIRespondAction()

template<typename... Ts>

esphome::api::APIRespondAction< Ts >::APIRespondAction ( APIServer * parent )

inlineexplicit

Definition at line 226 of file user_services.h.

Member Function Documentation

play()

template<typename... Ts>

void esphome::api::APIRespondAction< Ts >::play ( const Ts &... x )

inlineoverridevirtual

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

Definition at line 239 of file user_services.h.

set_data()

template<typename... Ts>

void esphome::api::APIRespondAction< Ts >::set_data ( std::function< void(Ts..., JsonObject)> func )

inline

Definition at line 233 of file user_services.h.

set_error_message()

template<typename... Ts>

template<typename V >

void esphome::api::APIRespondAction< Ts >::set_error_message ( V error )

inline

Definition at line 229 of file user_services.h.

set_is_optional_mode()

template<typename... Ts>

void esphome::api::APIRespondAction< Ts >::set_is_optional_mode ( bool is_optional )

inline

Definition at line 230 of file user_services.h.

set_success()

template<typename... Ts>

template<typename V >

void esphome::api::APIRespondAction< Ts >::set_success ( V success )

inline

Definition at line 228 of file user_services.h.

Field Documentation

error_message_

template<typename... Ts>

TemplatableValue<std::string, Ts...> esphome::api::APIRespondAction< Ts >::error_message_ {""}

protected

Definition at line 279 of file user_services.h.

has_data_

template<typename... Ts>

bool esphome::api::APIRespondAction< Ts >::has_data_ {false}

protected

Definition at line 282 of file user_services.h.

is_optional_mode_

template<typename... Ts>

bool esphome::api::APIRespondAction< Ts >::is_optional_mode_ {false}

protected

Definition at line 284 of file user_services.h.

json_builder_

template<typename... Ts>

std::function<void(Ts..., JsonObject)> esphome::api::APIRespondAction< Ts >::json_builder_

protected

Definition at line 281 of file user_services.h.

parent_

template<typename... Ts>

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

protected

Definition at line 277 of file user_services.h.

success_

template<typename... Ts>

TemplatableValue<bool, Ts...> esphome::api::APIRespondAction< Ts >::success_ {true}

protected

Definition at line 278 of file user_services.h.

---

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

• esphome/components/api/user_services.h