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-21 08:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add To-do list item due and description field developer documentation (#1981)

Browse Source 
* Add To-do list item due and description fields

* Don't allow floating datetimes

* Add missing words

* Tiny tweak

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Allen Porter 2023-11-28 04:02:50 -08:00 committed by GitHub
parent e86f14870c
commit c15218afd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/core/entity/todo.md
View File

@ -31,6 +31,9 @@ and are combined using the bitwise or (`|`) operator.
| `DELETE_TODO_ITEM` | Entity implements the methods to allow deletion of to-do items. |
| `UPDATE_TODO_ITEM` | Entity implements the methods to allow update of to-do items. |
| `MOVE_TODO_ITEM` | Entity implements the methods to re-order to-do items. |
| `DUE_DATE` | Entity implements to-do item `due` field as a `datetime.date`. |
| `DUE_DATETIME` | Entity implements to-do item `due` field as a `datetime.datetime`. |
| `DESCRIPTION` | Entity implements to-do item `description` field. |
## Methods
@ -108,5 +111,7 @@ update.
| Name | Type | Default | Description |
| ----------- | ---------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| uid | <code>string &#124; None</code> | `None` | A unique identifier for the to-do item. This field is required for updates and the entity state.
| summary | <code>string &#124; None</code> | `None` | A title or summary of the To-do item. This field is required for the entity state.
| status | <code>TodoItemStatus &#124; None</code> | `None` | Defines the overall status for the To-do item, either `NEEDS_ACTION` or `COMPLETE`. This field is required for the entity state.
| summary | <code>string &#124; None</code> | `None` | A title or summary of the to-do item. This field is required for the entity state.
| status | <code>TodoItemStatus &#124; None</code> | `None` | Defines the overall status for the to-do item, either `NEEDS_ACTION` or `COMPLETE`. This field is required for the entity state.
| due | <code>datetime.date &#124; datetime.datetime &#124; None</code> | `None` | The date and time that a to-do is expected to be completed. The types supported depend on `TodoListEntityFeature.DUE_DATE` or `TodoListEntityFeature.DUE_DATETIME` or both being set. As a datetime, must have a timezone.
| description | <code>string &#124; None</code> | `None` | A more complete description of the to-do item than that provided by the summary. Only supported when `TodoListEntityFeature.DESCRIPTION` is set.