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

Public Member Functions

None __init__ (self, CalendarSyncUpdateCoordinator|CalendarQueryUpdateCoordinator coordinator, str calendar_id, GoogleCalendarEntityDescription entity_description, str|None unique_id)
 
None async_added_to_hass (self)
 
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)
 
CalendarEvent|None event (self)
 
dict[str, boolextra_state_attributes (self)
 
bool offset_reached (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.google.coordinator.CalendarSyncUpdateCoordinator
None __init__ (self, HomeAssistant hass, CalendarEventSyncManager sync, str name)
 
Iterable[Event] async_get_events (self, datetime start_date, datetime end_date)
 
Iterable[Event]|None upcoming (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.google.coordinator.CalendarQueryUpdateCoordinator
None __init__ (self, HomeAssistant hass, GoogleCalendarService calendar_service, str name, str calendar_id, str|None search)
 
Iterable[Event] async_get_events (self, datetime start_date, datetime end_date)
 
Iterable[Event]|None upcoming (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_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)
 
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_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)
 
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)
 

Public Attributes

 calendar_id
 
 entity_description
 
 entity_id
 
- Public Attributes inherited from homeassistant.components.google.coordinator.CalendarSyncUpdateCoordinator
 sync
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.google.coordinator.CalendarQueryUpdateCoordinator
 calendar_id
 
 calendar_service
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

bool _event_filter (self, Event event)
 
tuple[CalendarEvent|None, timedelta|None_event_with_offset (self)
 

Private Attributes

 _attr_supported_features
 
 _attr_unique_id
 
 _ignore_availability
 
 _offset
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- 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 event entity.

Definition at line 324 of file calendar.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.google.calendar.GoogleCalendarEntity.__init__ (   self,
CalendarSyncUpdateCoordinator | CalendarQueryUpdateCoordinator  coordinator,
str  calendar_id,
GoogleCalendarEntityDescription  entity_description,
str | None  unique_id 
)
Create the Calendar event device.

Definition at line 333 of file calendar.py.

Member Function Documentation

◆ _event_filter()

bool homeassistant.components.google.calendar.GoogleCalendarEntity._event_filter (   self,
Event  event 
)
private
Return True if the event is visible and not declined.

Definition at line 376 of file calendar.py.

◆ _event_with_offset()

tuple[CalendarEvent | None, timedelta | None] homeassistant.components.google.calendar.GoogleCalendarEntity._event_with_offset (   self)
private
Get the calendar event and offset if any.

Definition at line 414 of file calendar.py.

◆ async_added_to_hass()

None homeassistant.components.google.calendar.GoogleCalendarEntity.async_added_to_hass (   self)
When entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 391 of file calendar.py.

◆ async_create_event()

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

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 433 of file calendar.py.

◆ async_delete_event()

None homeassistant.components.google.calendar.GoogleCalendarEntity.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 472 of file calendar.py.

◆ async_get_events()

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

Definition at line 404 of file calendar.py.

◆ event()

CalendarEvent | None homeassistant.components.google.calendar.GoogleCalendarEntity.event (   self)
Return the next upcoming event.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 371 of file calendar.py.

◆ extra_state_attributes()

dict[str, bool] homeassistant.components.google.calendar.GoogleCalendarEntity.extra_state_attributes (   self)
Return the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 358 of file calendar.py.

◆ offset_reached()

bool homeassistant.components.google.calendar.GoogleCalendarEntity.offset_reached (   self)
Return whether or not the event offset was reached.

Definition at line 363 of file calendar.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.google.calendar.GoogleCalendarEntity._attr_has_entity_name = True
staticprivate

Definition at line 331 of file calendar.py.

◆ _attr_supported_features

homeassistant.components.google.calendar.GoogleCalendarEntity._attr_supported_features
private

Definition at line 353 of file calendar.py.

◆ _attr_unique_id

homeassistant.components.google.calendar.GoogleCalendarEntity._attr_unique_id
private

Definition at line 351 of file calendar.py.

◆ _ignore_availability

homeassistant.components.google.calendar.GoogleCalendarEntity._ignore_availability
private

Definition at line 346 of file calendar.py.

◆ _offset

homeassistant.components.google.calendar.GoogleCalendarEntity._offset
private

Definition at line 347 of file calendar.py.

◆ calendar_id

homeassistant.components.google.calendar.GoogleCalendarEntity.calendar_id

Definition at line 344 of file calendar.py.

◆ entity_description

homeassistant.components.google.calendar.GoogleCalendarEntity.entity_description

Definition at line 345 of file calendar.py.

◆ entity_id

homeassistant.components.google.calendar.GoogleCalendarEntity.entity_id

Definition at line 350 of file calendar.py.


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