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

Public Member Functions

None __init__ (self, list[str] patterns, HomeAssistant hass, str entry_id)
 
None on_closed (self, FileClosedEvent event)
 
None on_created (self, FileCreatedEvent event)
 
None on_deleted (self, FileDeletedEvent event)
 
None on_modified (self, FileModifiedEvent event)
 
None on_moved (self, FileMovedEvent event)
 
None process (self, FileSystemEvent event, bool moved=False)
 

Public Attributes

 entry_id
 
 hass
 

Detailed Description

Class for handling Watcher events.

Definition at line 66 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.folder_watcher.EventHandler.__init__ (   self,
list[str]  patterns,
HomeAssistant  hass,
str  entry_id 
)
Initialise the EventHandler.

Definition at line 69 of file __init__.py.

Member Function Documentation

◆ on_closed()

None homeassistant.components.folder_watcher.EventHandler.on_closed (   self,
FileClosedEvent  event 
)
File closed.

Definition at line 120 of file __init__.py.

◆ on_created()

None homeassistant.components.folder_watcher.EventHandler.on_created (   self,
FileCreatedEvent  event 
)
File created.

Definition at line 112 of file __init__.py.

◆ on_deleted()

None homeassistant.components.folder_watcher.EventHandler.on_deleted (   self,
FileDeletedEvent  event 
)
File deleted.

Definition at line 116 of file __init__.py.

◆ on_modified()

None homeassistant.components.folder_watcher.EventHandler.on_modified (   self,
FileModifiedEvent  event 
)
File modified.

Definition at line 104 of file __init__.py.

◆ on_moved()

None homeassistant.components.folder_watcher.EventHandler.on_moved (   self,
FileMovedEvent  event 
)
File moved.

Definition at line 108 of file __init__.py.

◆ process()

None homeassistant.components.folder_watcher.EventHandler.process (   self,
FileSystemEvent  event,
bool   moved = False 
)
On Watcher event, fire HA event.

Definition at line 75 of file __init__.py.

Member Data Documentation

◆ entry_id

homeassistant.components.folder_watcher.EventHandler.entry_id

Definition at line 73 of file __init__.py.

◆ hass

homeassistant.components.folder_watcher.EventHandler.hass

Definition at line 72 of file __init__.py.


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