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-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add additional shopping list services (#16328)

Browse Source
This commit is contained in:
MHV33 2021-02-23 16:26:09 -06:00 committed by GitHub
parent 647dbaba88
commit 6bd2d5f4d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_integrations/shopping_list.markdown
View File

@ -22,16 +22,36 @@ 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.
| 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.complete_item` ### Service `shopping_list.complete_item`
Marks an item as completed in the shopping list. It does not remove the item.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------| |------------------------|----------|--------------------------------------------------------|
| `name` | no | Name of the item to mark as completed. Example: "Milk" | | `name` | no | Name of the item to mark as completed. Example: "Milk" |
### Service `shopping_list.incomplete_item`
Marks an item as incomplete in the shopping list.
| Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------|
| `name` | no | Name of the item to mark as incomplete. Example: "Milk" |
### Service `shopping_list.complete_all`
Marks all items as completed in the shopping list. It does not remove the items.
### Service `shopping_list.incomplete_all`
Marks all items as incomplete in the shopping list.
## Using in Automations ## Using in Automations
The simplest way use shopping list with automations (e.g., when entering a zone with shops) is to create a notification that can be clicked to open the shopping list. The simplest way use shopping list with automations (e.g., when entering a zone with shops) is to create a notification that can be clicked to open the shopping list.