Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | List of all members
homeassistant.components.image_upload.ImageStorageCollection Class Reference
Inheritance diagram for homeassistant.components.image_upload.ImageStorageCollection:
[legend]
Collaboration diagram for homeassistant.components.image_upload.ImageStorageCollection:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, pathlib.Path image_dir)
 

Public Attributes

 image_dir
 

Static Public Attributes

 CREATE_SCHEMA = vol.Schema(CREATE_FIELDS)
 
 UPDATE_SCHEMA = vol.Schema(UPDATE_FIELDS)
 

Private Member Functions

None _change_listener (self, str change_type, str item_id, dict[str, Any] data)
 
str _get_suggested_id (self, dict[str, Any] info)
 
int _move_data (self, dict[str, Any] data)
 
dict[str, Any] _process_create_data (self, dict[str, Any] data)
 
dict[str, Any] _update_data (self, dict[str, Any] item, dict[str, Any] update_data)
 

Detailed Description

Image collection stored in storage.

Definition at line 64 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.image_upload.ImageStorageCollection.__init__ (   self,
HomeAssistant  hass,
pathlib.Path  image_dir 
) 
Initialize media storage collection.

Definition at line 70 of file __init__.py.

Member Function Documentation

◆ _change_listener()

None homeassistant.components.image_upload.ImageStorageCollection._change_listener (   self,
str  change_type,
str  item_id,
dict[str, Any]  data 
)
private 
Handle change.

Definition at line 142 of file __init__.py.

◆ _get_suggested_id()

str homeassistant.components.image_upload.ImageStorageCollection._get_suggested_id (   self,
dict[str, Any]  info 
)
private 
Suggest an ID based on the config.

Definition at line 130 of file __init__.py.

◆ _move_data()

int homeassistant.components.image_upload.ImageStorageCollection._move_data (   self,
dict[str, Any]  data 
)
private 
Move data.

Definition at line 99 of file __init__.py.

◆ _process_create_data()

dict[str, Any] homeassistant.components.image_upload.ImageStorageCollection._process_create_data (   self,
dict[str, Any]  data 
)
private 
Validate the config is valid.

Definition at line 78 of file __init__.py.

◆ _update_data()

dict[str, Any] homeassistant.components.image_upload.ImageStorageCollection._update_data (   self,
dict[str, Any]  item,
dict[str, Any]  update_data 
)
private 
Return a new updated data object.

Definition at line 134 of file __init__.py.

Member Data Documentation

◆ CREATE_SCHEMA

homeassistant.components.image_upload.ImageStorageCollection.CREATE_SCHEMA = vol.Schema(CREATE_FIELDS)
static

Definition at line 67 of file __init__.py.

◆ image_dir

homeassistant.components.image_upload.ImageStorageCollection.image_dir

Definition at line 76 of file __init__.py.

◆ UPDATE_SCHEMA

homeassistant.components.image_upload.ImageStorageCollection.UPDATE_SCHEMA = vol.Schema(UPDATE_FIELDS)
static

Definition at line 68 of file __init__.py.

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