ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
esphome::http_request::HttpRequestSendAction< Ts > Class Template Reference

#include <http_request.h>

Inheritance diagram for esphome::http_request::HttpRequestSendAction< Ts >:
esphome::Action< Ts... >

Public Member Functions

 HttpRequestSendAction (HttpRequestComponent *parent)
 
 TEMPLATABLE_VALUE (std::string, url) TEMPLATABLE_VALUE(const char *
 
method TEMPLATABLE_VALUE (std::string, body) TEMPLATABLE_VALUE(bool
 
method capture_response void init_request_headers (size_t count)
 
void add_request_header (const char *key, TemplatableValue< const char *, Ts... > value)
 
void add_collect_header (const char *value)
 
void init_json (size_t count)
 
void add_json (const char *key, TemplatableValue< std::string, Ts... > value)
 
void set_json (std::function< void(Ts..., JsonObject)> json_func)
 
Trigger< std::shared_ptr< HttpContainer >, std::string &, Ts... > * get_success_trigger_with_response ()
 
Trigger< std::shared_ptr< HttpContainer >, Ts... > * get_success_trigger ()
 
Trigger< Ts... > * get_error_trigger ()
 
void set_max_response_buffer_size (size_t max_response_buffer_size)
 
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 Member Functions

void encode_json_ (Ts... x, JsonObject root)
 
void encode_json_func_ (Ts... x, JsonObject root)
 
- 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_ ()
 

Protected Attributes

HttpRequestComponentparent_
 
FixedVector< std::pair< const char *, TemplatableValue< const char *, Ts... > > > request_headers_ {}
 
std::vector< std::string > lower_case_collect_headers_ {"content-type", "content-length"}
 
FixedVector< std::pair< const char *, TemplatableValue< std::string, Ts... > > > json_ {}
 
std::function< void(Ts..., JsonObject)> json_func_ {nullptr}
 
Trigger< std::shared_ptr< HttpContainer >, std::string &, Ts... > success_trigger_with_response_
 
Trigger< std::shared_ptr< HttpContainer >, Ts... > success_trigger_
 
Trigger< Ts... > error_trigger_
 
size_t max_response_buffer_size_ {SIZE_MAX}
 
- 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.
 

Detailed Description

template<typename... Ts>
class esphome::http_request::HttpRequestSendAction< Ts >

Definition at line 449 of file http_request.h.

Constructor & Destructor Documentation

◆ HttpRequestSendAction()

template<typename... Ts>
esphome::http_request::HttpRequestSendAction< Ts >::HttpRequestSendAction ( HttpRequestComponent * parent)
inline

Definition at line 451 of file http_request.h.

Member Function Documentation

◆ add_collect_header()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::add_collect_header ( const char * value)
inline

Definition at line 464 of file http_request.h.

◆ add_json()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::add_json ( const char * key,
TemplatableValue< std::string, Ts... > value )
inline

Definition at line 467 of file http_request.h.

◆ add_request_header()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::add_request_header ( const char * key,
TemplatableValue< const char *, Ts... > value )
inline

Definition at line 460 of file http_request.h.

◆ encode_json_()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::encode_json_ ( Ts... x,
JsonObject root )
inlineprotected

Definition at line 558 of file http_request.h.

◆ encode_json_func_()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::encode_json_func_ ( Ts... x,
JsonObject root )
inlineprotected

Definition at line 564 of file http_request.h.

◆ get_error_trigger()

template<typename... Ts>
Trigger< Ts... > * esphome::http_request::HttpRequestSendAction< Ts >::get_error_trigger ( )
inline

Definition at line 478 of file http_request.h.

◆ get_success_trigger()

template<typename... Ts>
Trigger< std::shared_ptr< HttpContainer >, Ts... > * esphome::http_request::HttpRequestSendAction< Ts >::get_success_trigger ( )
inline

Definition at line 476 of file http_request.h.

◆ get_success_trigger_with_response()

template<typename... Ts>
Trigger< std::shared_ptr< HttpContainer >, std::string &, Ts... > * esphome::http_request::HttpRequestSendAction< Ts >::get_success_trigger_with_response ( )
inline

Definition at line 472 of file http_request.h.

◆ init_json()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::init_json ( size_t count)
inline

Definition at line 466 of file http_request.h.

◆ init_request_headers()

template<typename... Ts>
method capture_response void esphome::http_request::HttpRequestSendAction< Ts >::init_request_headers ( size_t count)
inline

Definition at line 459 of file http_request.h.

◆ play()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::play ( const Ts &... x)
inlineoverridevirtual

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

Definition at line 484 of file http_request.h.

◆ set_json()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::set_json ( std::function< void(Ts..., JsonObject)> json_func)
inline

Definition at line 469 of file http_request.h.

◆ set_max_response_buffer_size()

template<typename... Ts>
void esphome::http_request::HttpRequestSendAction< Ts >::set_max_response_buffer_size ( size_t max_response_buffer_size)
inline

Definition at line 480 of file http_request.h.

◆ TEMPLATABLE_VALUE() [1/2]

template<typename... Ts>
method esphome::http_request::HttpRequestSendAction< Ts >::TEMPLATABLE_VALUE ( std::string ,
body  )

◆ TEMPLATABLE_VALUE() [2/2]

template<typename... Ts>
esphome::http_request::HttpRequestSendAction< Ts >::TEMPLATABLE_VALUE ( std::string ,
url  ) const

Field Documentation

◆ error_trigger_

template<typename... Ts>
Trigger<Ts...> esphome::http_request::HttpRequestSendAction< Ts >::error_trigger_
protected

Definition at line 574 of file http_request.h.

◆ json_

template<typename... Ts>
FixedVector<std::pair<const char *, TemplatableValue<std::string, Ts...> > > esphome::http_request::HttpRequestSendAction< Ts >::json_ {}
protected

Definition at line 568 of file http_request.h.

◆ json_func_

template<typename... Ts>
std::function<void(Ts..., JsonObject)> esphome::http_request::HttpRequestSendAction< Ts >::json_func_ {nullptr}
protected

Definition at line 569 of file http_request.h.

◆ lower_case_collect_headers_

template<typename... Ts>
std::vector<std::string> esphome::http_request::HttpRequestSendAction< Ts >::lower_case_collect_headers_ {"content-type", "content-length"}
protected

Definition at line 567 of file http_request.h.

◆ max_response_buffer_size_

template<typename... Ts>
size_t esphome::http_request::HttpRequestSendAction< Ts >::max_response_buffer_size_ {SIZE_MAX}
protected

Definition at line 576 of file http_request.h.

◆ parent_

template<typename... Ts>
HttpRequestComponent* esphome::http_request::HttpRequestSendAction< Ts >::parent_
protected

Definition at line 565 of file http_request.h.

◆ request_headers_

template<typename... Ts>
FixedVector<std::pair<const char *, TemplatableValue<const char *, Ts...> > > esphome::http_request::HttpRequestSendAction< Ts >::request_headers_ {}
protected

Definition at line 566 of file http_request.h.

◆ success_trigger_

template<typename... Ts>
Trigger<std::shared_ptr<HttpContainer>, Ts...> esphome::http_request::HttpRequestSendAction< Ts >::success_trigger_
protected

Definition at line 573 of file http_request.h.

◆ success_trigger_with_response_

template<typename... Ts>
Trigger<std::shared_ptr<HttpContainer>, std::string &, Ts...> esphome::http_request::HttpRequestSendAction< Ts >::success_trigger_with_response_
protected

Definition at line 571 of file http_request.h.


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