jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-18 23:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CalendarEvent table to include a mention of required timezone

Browse Source
This commit is contained in:
Allen Porter 2022-03-30 14:48:30 +00:00
parent 8b03cd649e
commit 5edf0f2b1d
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/core/entity/calendar.md
View File

@ -49,10 +49,10 @@ class MyCalendar(CalendarEntity):
A `CalendarEvent` represents an individual event on a calendar.
| Name | Type | Default | Description |
| ----------- | ---------------- | ------------ | -------------------------------------------------------------------- |
| start | datetime or date | **Required** | The start (inclusive) of the event. Must be before `end`. Both `start` and `end` must be the same type. |
| end | datetime or date | **Required** | The end (exclusive) of the event. Must be after `start`. |
| summary | string | **Required** | A title or summary of the event. |
| location | string | `None` | A geographic location of the event. |
| description | string | `None` | A detailed description of the event. |
| Name | Type | Default | Description |
| ----------- | ---------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| start | datetime or date | **Required** | The start (inclusive) of the event. Must be before `end`. Both `start` and `end` must be the same type. As a datetime, must be in UTC timezone. |
| end | datetime or date | **Required** | The end (exclusive) of the event. Must be after `start`. As a datetime, must be in UTC timezone. |
| summary | string | **Required** | A title or summary of the event. |
| location | string | `None` | A geographic location of the event. |
| description | string | `None` | A detailed description of the event. |