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

Public Member Functions

None __init__ (self, pathlib.Path image_folder, ImageStorageCollection image_collection)
 
web.FileResponse get (self, web.Request request, str image_id, str filename)
 

Public Attributes

 image_collection
 
 image_folder
 
 transform_lock
 

Static Public Attributes

string name = "api:image:serve"
 
bool requires_auth = False
 
string url = "/api/image/serve/{image_id}/{filename}"
 

Detailed Description

View to download images.

Definition at line 184 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.image_upload.ImageServeView.__init__ (   self,
pathlib.Path  image_folder,
ImageStorageCollection  image_collection 
)
Initialize image serve view.

Definition at line 191 of file __init__.py.

Member Function Documentation

◆ get()

web.FileResponse homeassistant.components.image_upload.ImageServeView.get (   self,
web.Request  request,
str  image_id,
str  filename 
)
Serve image.

Definition at line 201 of file __init__.py.

Member Data Documentation

◆ image_collection

homeassistant.components.image_upload.ImageServeView.image_collection

Definition at line 199 of file __init__.py.

◆ image_folder

homeassistant.components.image_upload.ImageServeView.image_folder

Definition at line 198 of file __init__.py.

◆ name

string homeassistant.components.image_upload.ImageServeView.name = "api:image:serve"
static

Definition at line 188 of file __init__.py.

◆ requires_auth

bool homeassistant.components.image_upload.ImageServeView.requires_auth = False
static

Definition at line 189 of file __init__.py.

◆ transform_lock

homeassistant.components.image_upload.ImageServeView.transform_lock

Definition at line 197 of file __init__.py.

◆ url

string homeassistant.components.image_upload.ImageServeView.url = "/api/image/serve/{image_id}/{filename}"
static

Definition at line 187 of file __init__.py.


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