ESPHome  2024.11.3
Public Member Functions | Protected Member Functions
esphome::api::UserServiceTrigger< Ts > Class Template Reference

#include <user_services.h>

Inheritance diagram for esphome::api::UserServiceTrigger< Ts >:
esphome::api::UserServiceBase< Ts... > esphome::Trigger< Ts... > esphome::api::UserServiceDescriptor

Public Member Functions

 UserServiceTrigger (const std::string &name, const std::array< std::string, sizeof...(Ts)> &arg_names)
 
- Public Member Functions inherited from esphome::api::UserServiceBase< Ts... >
 UserServiceBase (std::string name, const std::array< std::string, sizeof...(Ts)> &arg_names)
 
ListEntitiesServicesResponse encode_list_service_response () override
 
bool execute_service (const ExecuteServiceRequest &req) override
 
- Public Member Functions inherited from esphome::Trigger< Ts... >
void trigger (Ts... x)
 Inform the parent automation that the event has triggered. More...
 
void set_automation_parent (Automation< Ts... > *automation_parent)
 
void stop_action ()
 Stop any action connected to this trigger. More...
 
bool is_action_running ()
 Returns true if any action connected to this trigger is running. More...
 

Protected Member Functions

void execute (Ts... x) override
 
- Protected Member Functions inherited from esphome::api::UserServiceBase< Ts... >
void execute_ (std::vector< ExecuteServiceArgument > args, seq< S... > type)
 

Additional Inherited Members

- Protected Attributes inherited from esphome::api::UserServiceBase< Ts... >
std::string name_
 
uint32_t key_
 
std::array< std::string, sizeof...(Ts)> arg_names_
 
- Protected Attributes inherited from esphome::Trigger< Ts... >
Automation< Ts... > * automation_parent_
 

Detailed Description

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

Definition at line 65 of file user_services.h.

Constructor & Destructor Documentation

◆ UserServiceTrigger()

template<typename... Ts>
esphome::api::UserServiceTrigger< Ts >::UserServiceTrigger ( const std::string &  name,
const std::array< std::string, sizeof...(Ts)> &  arg_names 
)
inline

Definition at line 67 of file user_services.h.

Member Function Documentation

◆ execute()

template<typename... Ts>
void esphome::api::UserServiceTrigger< Ts >::execute ( Ts...  x)
inlineoverrideprotectedvirtual

Implements esphome::api::UserServiceBase< Ts... >.

Definition at line 71 of file user_services.h.


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