Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.calendar.CalendarEvent Class Reference
Inheritance diagram for homeassistant.components.calendar.CalendarEvent:
[legend]

Public Member Functions

None __post_init__ (self)
 
bool all_day (self)
 
dict[str, Any] as_dict (self)
 
datetime.datetime end_datetime_local (self)
 
datetime.datetime start_datetime_local (self)
 

Public Attributes

 end
 
 start
 

Static Public Attributes

 None
 

Detailed Description

An event on a calendar.

Definition at line 344 of file __init__.py.

Member Function Documentation

◆ __post_init__()

None homeassistant.components.calendar.CalendarEvent.__post_init__ (   self)
Perform validation on the CalendarEvent.

Definition at line 379 of file __init__.py.

◆ all_day()

bool homeassistant.components.calendar.CalendarEvent.all_day (   self)
Return true if the event is an all day event.

Definition at line 368 of file __init__.py.

◆ as_dict()

dict[str, Any] homeassistant.components.calendar.CalendarEvent.as_dict (   self)
Return a dict representation of the event.

Definition at line 372 of file __init__.py.

◆ end_datetime_local()

datetime.datetime homeassistant.components.calendar.CalendarEvent.end_datetime_local (   self)
Return event end time as a local datetime.

Definition at line 363 of file __init__.py.

◆ start_datetime_local()

datetime.datetime homeassistant.components.calendar.CalendarEvent.start_datetime_local (   self)
Return event start time as a local datetime.

Definition at line 358 of file __init__.py.

Member Data Documentation

◆ end

homeassistant.components.calendar.CalendarEvent.end

Definition at line 400 of file __init__.py.

◆ None

homeassistant.components.calendar.CalendarEvent.None
static

Definition at line 350 of file __init__.py.

◆ start

homeassistant.components.calendar.CalendarEvent.start

Definition at line 398 of file __init__.py.


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