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

#include <user_services.h>

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

Public Member Functions
	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::api::UserServiceDescriptor
bool	is_internal ()

Protected Member Functions
virtual void	execute (Ts... x)=0
template<int... S>
void	execute_ (std::vector< ExecuteServiceArgument > args, seq< S... > type)

Protected Attributes
std::string	name_
uint32_t	key_ {0}
std::array< std::string, sizeof...(Ts)>	arg_names_

Detailed Description

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

Definition at line 26 of file user_services.h.

Constructor & Destructor Documentation

UserServiceBase()

template<typename... Ts>

esphome::api::UserServiceBase< Ts >::UserServiceBase ( std::string name, const std::array< std::string, sizeof...(Ts)> & arg_names )

inline

Definition at line 28 of file user_services.h.

Member Function Documentation

encode_list_service_response()

template<typename... Ts>

ListEntitiesServicesResponse esphome::api::UserServiceBase< Ts >::encode_list_service_response ( )

inlineoverridevirtual

Implements esphome::api::UserServiceDescriptor.

Definition at line 33 of file user_services.h.

execute()

template<typename... Ts>

virtual void esphome::api::UserServiceBase< Ts >::execute ( Ts... x )

protectedpure virtual

Implemented in esphome::api::CustomAPIDeviceService< T, Ts >, and esphome::api::UserServiceTrigger< Ts >.

execute_()

template<typename... Ts>

template<int... S>

void esphome::api::UserServiceBase< Ts >::execute_ ( std::vector< ExecuteServiceArgument > args, seq< S... > type )

inlineprotected

Definition at line 58 of file user_services.h.

execute_service()

template<typename... Ts>

bool esphome::api::UserServiceBase< Ts >::execute_service ( const ExecuteServiceRequest & req )

inlineoverridevirtual

Implements esphome::api::UserServiceDescriptor.

Definition at line 47 of file user_services.h.

Field Documentation

arg_names_

template<typename... Ts>

std::array<std::string, sizeof...(Ts)> esphome::api::UserServiceBase< Ts >::arg_names_

protected

Definition at line 64 of file user_services.h.

key_

template<typename... Ts>

uint32_t esphome::api::UserServiceBase< Ts >::key_ {0}

protected

Definition at line 63 of file user_services.h.

name_

template<typename... Ts>

std::string esphome::api::UserServiceBase< Ts >::name_

protected

Definition at line 62 of file user_services.h.

---

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

• esphome/components/api/user_services.h