homeassistant.components.calendar.CalendarEntity Class Reference

Inheritance diagram for homeassistant.components.calendar.CalendarEntity:

Collaboration diagram for homeassistant.components.calendar.CalendarEntity:

Public Member Functions
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[CalendarEvent]	async_get_events (self, HomeAssistant hass, datetime.datetime start_date, datetime.datetime end_date)
None	async_update_event (self, str uid, dict[str, Any] event, str|None recurrence_id=None, str|None recurrence_range=None)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
CalendarEvent|None	event (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, str]	translation_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)

Static Public Attributes
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Private Attributes
	_alarm_unsubs

Static Private Attributes
	_entity_component_unrecorded_attributes = frozenset({"description"})

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Base class for calendar event entities.

Definition at line 490 of file __init__.py.

Member Function Documentation

async_create_event()

None homeassistant.components.calendar.CalendarEntity.async_create_event	(		self,
		**Any	kwargs
	)

Add a new event to calendar.

Reimplemented in homeassistant.components.local_calendar.calendar.LocalCalendarEntity, and homeassistant.components.google.calendar.GoogleCalendarEntity.

Definition at line 600 of file __init__.py.

async_delete_event()

None homeassistant.components.calendar.CalendarEntity.async_delete_event	(		self,
		str	uid,
		str | None	recurrence_id = None,
		str | None	recurrence_range = None
	)

Delete an event on the calendar.

Reimplemented in homeassistant.components.rachio.calendar.RachioCalendarEntity, homeassistant.components.local_calendar.calendar.LocalCalendarEntity, and homeassistant.components.google.calendar.GoogleCalendarEntity.

Definition at line 604 of file __init__.py.

async_get_events()

list[CalendarEvent] homeassistant.components.calendar.CalendarEntity.async_get_events	(		self,
		HomeAssistant	hass,
		datetime.datetime	start_date,
		datetime.datetime	end_date
	)

Return calendar events within a datetime range.

Reimplemented in homeassistant.components.ridwell.calendar.RidwellCalendar, homeassistant.components.recollect_waste.calendar.ReCollectWasteCalendar, and homeassistant.components.demo.calendar.DemoCalendar.

Definition at line 591 of file __init__.py.

async_update_event()

None homeassistant.components.calendar.CalendarEntity.async_update_event	(		self,
		str	uid,
		dict[str, Any]	event,
		str | None	recurrence_id = None,
		str | None	recurrence_range = None
	)

Delete an event on the calendar.

Reimplemented in homeassistant.components.local_calendar.calendar.LocalCalendarEntity.

Definition at line 613 of file __init__.py.

async_will_remove_from_hass()

None homeassistant.components.calendar.CalendarEntity.async_will_remove_from_hass

(

self

)

Run when entity will be removed from hass.

To be extended by integrations.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 582 of file __init__.py.

async_write_ha_state()

None homeassistant.components.calendar.CalendarEntity.async_write_ha_state

(

self

)

Write the state to the state machine.

This sets up listeners to handle state transitions for start or end of
the current or upcoming event.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.radarr.calendar.RadarrCalendarEntity.

Definition at line 535 of file __init__.py.

event()

CalendarEvent | None homeassistant.components.calendar.CalendarEntity.event

(

self

)

Return the next upcoming event.

Reimplemented in homeassistant.components.withings.calendar.WithingsWorkoutCalendarEntity, homeassistant.components.vulcan.calendar.VulcanCalendarEntity, homeassistant.components.twentemilieu.calendar.TwenteMilieuCalendar, homeassistant.components.todoist.calendar.TodoistProjectEntity, homeassistant.components.ridwell.calendar.RidwellCalendar, homeassistant.components.recollect_waste.calendar.ReCollectWasteCalendar, homeassistant.components.rainbird.calendar.RainBirdCalendarEntity, homeassistant.components.radarr.calendar.RadarrCalendarEntity, homeassistant.components.rachio.calendar.RachioCalendarEntity, homeassistant.components.mealie.calendar.MealieMealplanCalendarEntity, homeassistant.components.local_calendar.calendar.LocalCalendarEntity, homeassistant.components.lamarzocco.calendar.LaMarzoccoCalendarEntity, homeassistant.components.husqvarna_automower.calendar.AutomowerCalendarEntity, homeassistant.components.holiday.calendar.HolidayCalendarEntity, homeassistant.components.habitica.calendar.HabiticaDailyRemindersCalendarEntity, homeassistant.components.habitica.calendar.HabiticaTodoRemindersCalendarEntity, homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity, homeassistant.components.habitica.calendar.HabiticaTodosCalendarEntity, homeassistant.components.google.calendar.GoogleCalendarEntity, homeassistant.components.epic_games_store.calendar.EGSCalendar, homeassistant.components.demo.calendar.DemoCalendar, and homeassistant.components.caldav.calendar.WebDavCalendarEntity.

Definition at line 500 of file __init__.py.

state()

str homeassistant.components.calendar.CalendarEntity.state

(

self

)

Return the state of the calendar event.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 522 of file __init__.py.

state_attributes()

dict[str, Any] | None homeassistant.components.calendar.CalendarEntity.state_attributes

(

self

)

Return the entity state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 506 of file __init__.py.

Member Data Documentation

_alarm_unsubs

homeassistant.components.calendar.CalendarEntity._alarm_unsubs

private

Definition at line 543 of file __init__.py.

_entity_component_unrecorded_attributes

homeassistant.components.calendar.CalendarEntity._entity_component_unrecorded_attributes = frozenset({"description"})

staticprivate

Definition at line 495 of file __init__.py.

None

homeassistant.components.calendar.CalendarEntity.None

static

Definition at line 497 of file __init__.py.

---

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

• core/homeassistant/components/calendar/__init__.py