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

Public Member Functions

None __init__ (self, str name, str country, str|None province, str language, HolidayBase obj_holidays, str unique_id)
 
None async_added_to_hass (self)
 
list[CalendarEventasync_get_events (self, HomeAssistant hass, datetime start_date, datetime end_date)
 
CalendarEvent|None event (self)
 
datetime get_next_interval (self, datetime now)
 
None point_in_time_listener (self, datetime time_date)
 
CalendarEvent|None update_event (self, datetime now)
 
- Public Member Functions inherited from homeassistant.components.calendar.CalendarEntity
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.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)
 
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)
 

Public Attributes

 unsub
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

 None
 
- 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
 

Private Member Functions

None _update_state_and_setup_listener (self)
 

Private Attributes

 _attr_device_info
 
 _attr_event
 
 _attr_unique_id
 
 _country
 
 _language
 
 _location
 
 _obj_holidays
 
 _province
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = False
 

Detailed Description

Representation of a Holiday Calendar element.

Definition at line 87 of file calendar.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.holiday.calendar.HolidayCalendarEntity.__init__ (   self,
str  name,
str  country,
str | None  province,
str  language,
HolidayBase  obj_holidays,
str  unique_id 
)
Initialize HolidayCalendarEntity.

Definition at line 96 of file calendar.py.

Member Function Documentation

◆ _update_state_and_setup_listener()

None homeassistant.components.holiday.calendar.HolidayCalendarEntity._update_state_and_setup_listener (   self)
private
Update state and setup listener for next interval.

Definition at line 123 of file calendar.py.

◆ async_added_to_hass()

None homeassistant.components.holiday.calendar.HolidayCalendarEntity.async_added_to_hass (   self)
Set up first update.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 137 of file calendar.py.

◆ async_get_events()

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

Definition at line 166 of file calendar.py.

◆ event()

CalendarEvent | None homeassistant.components.holiday.calendar.HolidayCalendarEntity.event (   self)
Return the next upcoming event.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 162 of file calendar.py.

◆ get_next_interval()

datetime homeassistant.components.holiday.calendar.HolidayCalendarEntity.get_next_interval (   self,
datetime  now 
)
Compute next time an update should occur.

Definition at line 118 of file calendar.py.

◆ point_in_time_listener()

None homeassistant.components.holiday.calendar.HolidayCalendarEntity.point_in_time_listener (   self,
datetime  time_date 
)
Get the latest data and update state.

Definition at line 132 of file calendar.py.

◆ update_event()

CalendarEvent | None homeassistant.components.holiday.calendar.HolidayCalendarEntity.update_event (   self,
datetime  now 
)
Return the next upcoming event.

Definition at line 141 of file calendar.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.holiday.calendar.HolidayCalendarEntity._attr_device_info
private

Definition at line 111 of file calendar.py.

◆ _attr_event

homeassistant.components.holiday.calendar.HolidayCalendarEntity._attr_event
private

Definition at line 126 of file calendar.py.

◆ _attr_has_entity_name

bool homeassistant.components.holiday.calendar.HolidayCalendarEntity._attr_has_entity_name = True
staticprivate

Definition at line 90 of file calendar.py.

◆ _attr_name

homeassistant.components.holiday.calendar.HolidayCalendarEntity._attr_name = None
staticprivate

Definition at line 91 of file calendar.py.

◆ _attr_should_poll

bool homeassistant.components.holiday.calendar.HolidayCalendarEntity._attr_should_poll = False
staticprivate

Definition at line 93 of file calendar.py.

◆ _attr_unique_id

homeassistant.components.holiday.calendar.HolidayCalendarEntity._attr_unique_id
private

Definition at line 110 of file calendar.py.

◆ _country

homeassistant.components.holiday.calendar.HolidayCalendarEntity._country
private

Definition at line 106 of file calendar.py.

◆ _language

homeassistant.components.holiday.calendar.HolidayCalendarEntity._language
private

Definition at line 109 of file calendar.py.

◆ _location

homeassistant.components.holiday.calendar.HolidayCalendarEntity._location
private

Definition at line 108 of file calendar.py.

◆ _obj_holidays

homeassistant.components.holiday.calendar.HolidayCalendarEntity._obj_holidays
private

Definition at line 116 of file calendar.py.

◆ _province

homeassistant.components.holiday.calendar.HolidayCalendarEntity._province
private

Definition at line 107 of file calendar.py.

◆ None

homeassistant.components.holiday.calendar.HolidayCalendarEntity.None
static

Definition at line 92 of file calendar.py.

◆ unsub

homeassistant.components.holiday.calendar.HolidayCalendarEntity.unsub

Definition at line 127 of file calendar.py.


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