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

Public Member Functions

None __init__ (self, WithingsClient client, WithingsWorkoutDataUpdateCoordinator coordinator)
 
list[CalendarEventasync_get_events (self, HomeAssistant hass, datetime start_date, datetime end_date)
 
CalendarEvent|None event (self)
 
- Public Member Functions inherited from homeassistant.components.withings.coordinator.WithingsWorkoutDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, WithingsClient client)
 
- Public Member Functions inherited from homeassistant.components.withings.coordinator.WithingsDataUpdateCoordinator
None async_webhook_data_updated (self, NotificationCategory notification_category)
 
None webhook_subscription_listener (self, bool connected)
 
- 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[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_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, 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

 client
 
- Public Attributes inherited from homeassistant.components.withings.coordinator.WithingsWorkoutDataUpdateCoordinator
 notification_categories
 
- Public Attributes inherited from homeassistant.components.withings.coordinator.WithingsDataUpdateCoordinator
 name
 
 update_interval
 
 webhooks_connected
 
- 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
 

Static Private Attributes

string _attr_translation_key = "workout"
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.withings.coordinator.WithingsWorkoutDataUpdateCoordinator
 None
 
 str
 
- Static Public Attributes inherited from homeassistant.components.withings.coordinator.WithingsDataUpdateCoordinator
 bool
 
 None
 
 str
 
- 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 entity.

Definition at line 68 of file calendar.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.withings.calendar.WithingsWorkoutCalendarEntity.__init__ (   self,
WithingsClient  client,
WithingsWorkoutDataUpdateCoordinator   coordinator 
)
Create the Calendar entity.

Definition at line 75 of file calendar.py.

Member Function Documentation

◆ async_get_events()

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

Definition at line 87 of file calendar.py.

◆ event()

CalendarEvent | None homeassistant.components.withings.calendar.WithingsWorkoutCalendarEntity.event (   self)
Return the next upcoming event.

Reimplemented from homeassistant.components.calendar.CalendarEntity.

Definition at line 83 of file calendar.py.

Member Data Documentation

◆ _attr_translation_key

string homeassistant.components.withings.calendar.WithingsWorkoutCalendarEntity._attr_translation_key = "workout"
staticprivate

Definition at line 73 of file calendar.py.

◆ client

homeassistant.components.withings.calendar.WithingsWorkoutCalendarEntity.client

Definition at line 80 of file calendar.py.


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