ESPHome 2026.6.0-dev
Loading...
Searching...
No Matches
esphome::api::ListEntitiesIterator Class Referencefinal

#include <list_entities.h>

Inheritance diagram for esphome::api::ListEntitiesIterator:
esphome::ComponentIterator

Public Member Functions

 ListEntitiesIterator (APIConnection *client)
 
bool on_service (UserServiceDescriptor *service) override
 
bool on_camera (camera::Camera *entity) override
 
bool on_end () override
 
- Public Member Functions inherited from esphome::ComponentIterator
void begin (bool include_internal=false)
 
void advance ()
 
bool completed () const
 
virtual bool on_begin ()
 

Protected Attributes

APIConnectionclient_
 
- Protected Attributes inherited from esphome::ComponentIterator
uint16_t at_ {0}
 
IteratorState state_ {IteratorState::NONE}
 
bool include_internal_ {false}
 

Additional Inherited Members

- Protected Types inherited from esphome::ComponentIterator
enum class  IteratorState : uint8_t {
  NONE = 0 , BEGIN , ENTITY_TYPE_ , ENTITY_CONTROLLER_TYPE_ ,
  SERVICE , CAMERA , MAX
}
 
- Protected Member Functions inherited from esphome::ComponentIterator
template<typename Container >
void process_platform_item_ (const Container &items, bool(ComponentIterator::*on_item)(typename Container::value_type))
 
void advance_platform_ ()
 

Detailed Description

Definition at line 18 of file list_entities.h.

Constructor & Destructor Documentation

◆ ListEntitiesIterator()

esphome::api::ListEntitiesIterator::ListEntitiesIterator ( APIConnection * client)

Definition at line 95 of file list_entities.cpp.

Member Function Documentation

◆ on_camera()

bool esphome::api::ListEntitiesIterator::on_camera ( camera::Camera * entity)
overridevirtual

Reimplemented from esphome::ComponentIterator.

◆ on_end()

bool esphome::api::ListEntitiesIterator::on_end ( )
overridevirtual

Reimplemented from esphome::ComponentIterator.

◆ on_service()

bool esphome::api::ListEntitiesIterator::on_service ( UserServiceDescriptor * service)
overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 98 of file list_entities.cpp.

Field Documentation

◆ client_

APIConnection* esphome::api::ListEntitiesIterator::client_
protected

Definition at line 41 of file list_entities.h.


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