mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-09 10:26:30 +00:00
Add To-do list item due and description field developer documentation (#1981)
* 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:
parent
e86f14870c
commit
c15218afd8
@ -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 | None</code> | `None` | A unique identifier for the to-do item. This field is required for updates and the entity state.
|
||||
| summary | <code>string | None</code> | `None` | A title or summary of the To-do item. This field is required for the entity state.
|
||||
| status | <code>TodoItemStatus | 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 | None</code> | `None` | A title or summary of the to-do item. This field is required for the entity state.
|
||||
| status | <code>TodoItemStatus | 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 | datetime.datetime | 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 | 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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user