Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.api.APIEntityStateView Class Reference
Inheritance diagram for homeassistant.components.api.APIEntityStateView:
[legend]
Collaboration diagram for homeassistant.components.api.APIEntityStateView:
[legend]

Public Member Functions

web.Response delete (self, web.Request request, str entity_id)
 
web.Response get (self, web.Request request, str entity_id)
 
web.Response post (self, web.Request request, str entity_id)
 

Static Public Attributes

string name = "api:entity-state"
 
string url = "/api/states/{entity_id}"
 

Detailed Description

View to handle EntityState requests.

Definition at line 236 of file __init__.py.

Member Function Documentation

◆ delete()

web.Response homeassistant.components.api.APIEntityStateView.delete (   self,
web.Request  request,
str  entity_id 
)
Remove entity.

Definition at line 299 of file __init__.py.

◆ get()

web.Response homeassistant.components.api.APIEntityStateView.get (   self,
web.Request  request,
str  entity_id 
)
Retrieve state of entity.

Definition at line 243 of file __init__.py.

◆ post()

web.Response homeassistant.components.api.APIEntityStateView.post (   self,
web.Request  request,
str  entity_id 
)
Update state of entity.

Definition at line 257 of file __init__.py.

Member Data Documentation

◆ name

string homeassistant.components.api.APIEntityStateView.name = "api:entity-state"
static

Definition at line 240 of file __init__.py.

◆ url

string homeassistant.components.api.APIEntityStateView.url = "/api/states/{entity_id}"
static

Definition at line 239 of file __init__.py.


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