jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add shopping item removal service (#25109)

Browse Source
This commit is contained in:
Philip Allgaier 2022-12-02 12:41:22 +01:00 committed by GitHub
parent 2ff4a7d540
commit 2b5228d255
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_integrations/shopping_list.markdown
View File

@ -23,15 +23,23 @@ You can add or remove items from your shopping list by using the following servi
### Service `shopping_list.add_item` ### Service `shopping_list.add_item`
Adds an item to the shopping list. Add an item to the shopping list.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------| |------------------------|----------|--------------------------------------------------------|
| `name` | no | Name of the item to add. Example: "Milk" | | `name` | no | Name of the item to add. Example: "Milk" |
### Service `shopping_list.remove_item`
Remove the first item with matching name from the shopping list.
| Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------|
| `name` | no | Name of the item to remove. Example: "Milk" |
### Service `shopping_list.complete_item` ### Service `shopping_list.complete_item`
Marks an item as completed in the shopping list. It does not remove the item. Mark the first item with matching name as completed in the shopping list. It does not remove the item.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------| |------------------------|----------|--------------------------------------------------------|
@ -39,7 +47,7 @@ Marks an item as completed in the shopping list. It does not remove the item.
### Service `shopping_list.incomplete_item` ### Service `shopping_list.incomplete_item`
Marks an item as incomplete in the shopping list. Mark the first item with matching name as incomplete in the shopping list.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------| |------------------------|----------|--------------------------------------------------------|
@ -47,11 +55,11 @@ Marks an item as incomplete in the shopping list.
### Service `shopping_list.complete_all` ### Service `shopping_list.complete_all`
Marks all items as completed in the shopping list. It does not remove the items. Mark all items as completed in the shopping list (without removing them from the list).
### Service `shopping_list.incomplete_all` ### Service `shopping_list.incomplete_all`
Marks all items as incomplete in the shopping list. Mark all items as incomplete in the shopping list.
### Service `shopping_list.clear_completed_items` ### Service `shopping_list.clear_completed_items`