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

Public Member Functions

None __init__ (self, LocalCalendarStore store, Calendar calendar, str name, str unique_id)
 
None async_create_event (self, **Any kwargs)
 
None async_delete_event (self, str uid, str|None recurrence_id=None, str|None recurrence_range=None)
 
list[CalendarEventasync_get_events (self, HomeAssistant hass, datetime start_date, datetime end_date)
 
None async_update (self)
 
None async_update_event (self, str uid, dict[str, Any] event, str|None recurrence_id=None, str|None recurrence_range=None)
 
CalendarEvent|None event (self)
 
- Public Member Functions inherited from homeassistant.components.calendar.CalendarEntity
list[CalendarEventasync_get_events (self, HomeAssistant hass, datetime.datetime start_date, datetime.datetime end_date)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str state (self)
 
dict[str, Any]|None state_attributes (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Private Member Functions

None _async_store (self)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 
 _calendar
 
 _calendar_lock
 
 _event
 
 _store
 

Static Private Attributes

bool _attr_has_entity_name = True
 
tuple _attr_supported_features
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.calendar.CalendarEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

A calendar entity backed by a local iCalendar file.

Definition at line 58 of file calendar.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.local_calendar.calendar.LocalCalendarEntity.__init__ (   self,
LocalCalendarStore  store,
Calendar  calendar,
str  name,
str  unique_id 
)
Initialize LocalCalendarEntity.

Definition at line 68 of file calendar.py.

Member Function Documentation

◆ _async_store()

None homeassistant.components.local_calendar.calendar.LocalCalendarEntity._async_store (   self)
private
Persist the calendar to disk.

Definition at line 107 of file calendar.py.

◆ async_create_event()

None homeassistant.components.local_calendar.calendar.LocalCalendarEntity.async_create_event (   self,
**Any  kwargs 
)
Add a new event to calendar.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 112 of file calendar.py.

◆ async_delete_event()

None homeassistant.components.local_calendar.calendar.LocalCalendarEntity.async_delete_event (   self,
str  uid,
str | None   recurrence_id = None,
str | None   recurrence_range = None 
)
Delete an event on the calendar.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 121 of file calendar.py.

◆ async_get_events()

list[CalendarEvent] homeassistant.components.local_calendar.calendar.LocalCalendarEntity.async_get_events (   self,
HomeAssistant  hass,
datetime  start_date,
datetime   end_date 
)
Get all events in a specific time frame.

Definition at line 88 of file calendar.py.

◆ async_update()

None homeassistant.components.local_calendar.calendar.LocalCalendarEntity.async_update (   self)
Update entity state with the next upcoming event.

Definition at line 98 of file calendar.py.

◆ async_update_event()

None homeassistant.components.local_calendar.calendar.LocalCalendarEntity.async_update_event (   self,
str  uid,
dict[str, Any]  event,
str | None   recurrence_id = None,
str | None   recurrence_range = None 
)
Update an existing event on the calendar.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 143 of file calendar.py.

◆ event()

CalendarEvent | None homeassistant.components.local_calendar.calendar.LocalCalendarEntity.event (   self)
Return the next upcoming event.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 84 of file calendar.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.local_calendar.calendar.LocalCalendarEntity._attr_has_entity_name = True
staticprivate

Definition at line 61 of file calendar.py.

◆ _attr_name

homeassistant.components.local_calendar.calendar.LocalCalendarEntity._attr_name
private

Definition at line 80 of file calendar.py.

◆ _attr_supported_features

tuple homeassistant.components.local_calendar.calendar.LocalCalendarEntity._attr_supported_features
staticprivate
Initial value:
= (
CalendarEntityFeature.CREATE_EVENT
| CalendarEntityFeature.DELETE_EVENT
| CalendarEntityFeature.UPDATE_EVENT
)

Definition at line 62 of file calendar.py.

◆ _attr_unique_id

homeassistant.components.local_calendar.calendar.LocalCalendarEntity._attr_unique_id
private

Definition at line 81 of file calendar.py.

◆ _calendar

homeassistant.components.local_calendar.calendar.LocalCalendarEntity._calendar
private

Definition at line 77 of file calendar.py.

◆ _calendar_lock

homeassistant.components.local_calendar.calendar.LocalCalendarEntity._calendar_lock
private

Definition at line 78 of file calendar.py.

◆ _event

homeassistant.components.local_calendar.calendar.LocalCalendarEntity._event
private

Definition at line 103 of file calendar.py.

◆ _store

homeassistant.components.local_calendar.calendar.LocalCalendarEntity._store
private

Definition at line 76 of file calendar.py.


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