Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.google.calendar Namespace Reference

Classes

class  GoogleCalendarEntity
 
class  GoogleCalendarEntityDescription
 

Functions

CalendarEvent _get_calendar_event (Event event)
 
list[GoogleCalendarEntityDescription_get_entity_descriptions (HomeAssistant hass, ConfigEntry config_entry, Calendar calendar_item, Mapping[str, Any] calendar_info)
 
None async_create_event (GoogleCalendarEntity entity, ServiceCall call)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string OPAQUE = "opaque"
 
string RRULE_PREFIX = "RRULE:"
 
string SERVICE_CREATE_EVENT = "create_event"
 
 SYNC_EVENT_MIN_TIME = timedelta(days=-90)
 

Detailed Description

Support for Google Calendar Search binary sensors.

Function Documentation

◆ _get_calendar_event()

CalendarEvent homeassistant.components.google.calendar._get_calendar_event ( Event  event)
private
Return a CalendarEvent from an API event.

Definition at line 492 of file calendar.py.

◆ _get_entity_descriptions()

list[GoogleCalendarEntityDescription] homeassistant.components.google.calendar._get_entity_descriptions ( HomeAssistant  hass,
ConfigEntry  config_entry,
Calendar  calendar_item,
Mapping[str, Any]  calendar_info 
)
private
Create entity descriptions for the calendar.

The entity descriptions are based on the type of Calendar from the API
and optional calendar_info yaml configuration that is the older way to
configure calendars before they supported UI based config.

The yaml config may map one calendar to multiple entities and they do not
have a unique id. The yaml config also supports additional options like
offsets or search.

Definition at line 109 of file calendar.py.

◆ async_create_event()

None homeassistant.components.google.calendar.async_create_event ( GoogleCalendarEntity  entity,
ServiceCall  call 
)
Add a new event to calendar.

Definition at line 514 of file calendar.py.

◆ async_setup_entry()

None homeassistant.components.google.calendar.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the google calendar platform.

Definition at line 192 of file calendar.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.google.calendar._LOGGER = logging.getLogger(__name__)
private

Definition at line 76 of file calendar.py.

◆ OPAQUE

string homeassistant.components.google.calendar.OPAQUE = "opaque"

Definition at line 85 of file calendar.py.

◆ RRULE_PREFIX

string homeassistant.components.google.calendar.RRULE_PREFIX = "RRULE:"

Definition at line 89 of file calendar.py.

◆ SERVICE_CREATE_EVENT

string homeassistant.components.google.calendar.SERVICE_CREATE_EVENT = "create_event"

Definition at line 91 of file calendar.py.

◆ SYNC_EVENT_MIN_TIME

homeassistant.components.google.calendar.SYNC_EVENT_MIN_TIME = timedelta(days=-90)

Definition at line 80 of file calendar.py.