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

Public Member Functions

None __init__ (self, EntityComponent[ImageEntity] component)
 
web.StreamResponse get (self, web.Request request, str entity_id)
 
web.StreamResponse handle (self, web.Request request, ImageEntity image_entity)
 

Public Attributes

 component
 

Static Public Attributes

string name = "api:image:image"
 
bool requires_auth = False
 
string url = "/api/image_proxy/{entity_id}"
 

Detailed Description

View to serve an image.

Definition at line 280 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.image.ImageView.__init__ (   self,
EntityComponent[ImageEntity component 
)
Initialize an image view.

Definition at line 287 of file __init__.py.

Member Function Documentation

◆ get()

web.StreamResponse homeassistant.components.image.ImageView.get (   self,
web.Request  request,
str  entity_id 
)
Start a GET request.

Definition at line 291 of file __init__.py.

◆ handle()

web.StreamResponse homeassistant.components.image.ImageView.handle (   self,
web.Request  request,
ImageEntity   image_entity 
)
Serve image.

Reimplemented in homeassistant.components.image.ImageStreamView.

Definition at line 311 of file __init__.py.

Member Data Documentation

◆ component

homeassistant.components.image.ImageView.component

Definition at line 289 of file __init__.py.

◆ name

string homeassistant.components.image.ImageView.name = "api:image:image"
static

Definition at line 283 of file __init__.py.

◆ requires_auth

bool homeassistant.components.image.ImageView.requires_auth = False
static

Definition at line 284 of file __init__.py.

◆ url

string homeassistant.components.image.ImageView.url = "/api/image_proxy/{entity_id}"
static

Definition at line 285 of file __init__.py.


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