Inheritance diagram for homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity:

Collaboration diagram for homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity:

Public Member Functions
list[CalendarEvent]	async_get_events (self, HomeAssistant hass, datetime start_date, datetime end_date)

list[CalendarEvent]	due_dailies (self, datetime start_date, datetime\|None end_date=None)

date	end_date (self, datetime recurrence, datetime\|None end=None)

CalendarEvent\|None	event (self)

dict[str, bool\|None]\|None	extra_state_attributes (self)

list[datetime]	get_recurrence_dates (self, rrule recurrences, datetime start_date, datetime\|None end_date=None)

datetime	today (self)

Public Member Functions inherited from homeassistant.components.habitica.calendar.HabiticaCalendarEntity
None	__init__ (self, HabiticaDataUpdateCoordinator coordinator)

Public Member Functions inherited from homeassistant.components.habitica.entity.HabiticaBase
None	__init__ (self, HabiticaDataUpdateCoordinator coordinator, EntityDescription entity_description)

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.habitica.coordinator.HabiticaDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, HabitipyAsync habitipy)

None	execute (self, Callable[[HabiticaDataUpdateCoordinator], Any] func)

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.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[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)

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)

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
	entity_description

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

Additional Inherited Members
Public Attributes inherited from homeassistant.components.habitica.entity.HabiticaBase
	entity_description

Public Attributes inherited from homeassistant.components.habitica.coordinator.HabiticaDataUpdateCoordinator
	api

	content

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.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Habitica dailies calendar entity.

Definition at line 128 of file calendar.py.

Member Function Documentation

◆ async_get_events()

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

Return calendar events within a datetime range.

Definition at line 219 of file calendar.py.

◆ due_dailies()

list[CalendarEvent] homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.due_dailies	(		self,
		datetime	start_date,
		datetime \| None	end_date = `None`
	)

Get dailies and recurrences for a given period or the next upcoming.

Definition at line 169 of file calendar.py.

◆ end_date()

date homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.end_date	(		self,
		datetime	recurrence,
		datetime \| None	end = `None`
	)

Calculate the end date for a yesterdaily.

The enddates of events from yesterday move forward to the end
of the current day (until the cron resets the dailies) to show them
as still active events on the calendar state entity (state: on).

Events in the calendar view will show all-day events on their due day

Definition at line 143 of file calendar.py.

◆ event()

CalendarEvent | None homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.event ( self )

Return the next upcoming event.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 215 of file calendar.py.

◆ extra_state_attributes()

dict[str, bool | None] | None homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.extra_state_attributes ( self )

Return entity specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 227 of file calendar.py.

◆ get_recurrence_dates()

list[datetime] homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.get_recurrence_dates	(		self,
		rrule	recurrences,
		datetime	start_date,
		datetime \| None	end_date = `None`
	)

Calculate recurrence dates based on start_date and end_date.

Definition at line 158 of file calendar.py.

◆ today()

datetime homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.today ( self )

Habitica daystart.

Definition at line 137 of file calendar.py.

Member Data Documentation

◆ entity_description

homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity.entity_description

static

Initial value:

=  CalendarEntityDescription(
        key=HabiticaCalendar.DAILIES,
        translation_key=HabiticaCalendar.DAILIES,
    )

Definition at line 131 of file calendar.py.

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

core/homeassistant/components/habitica/calendar.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Additional Inherited Members