Documentation

examples/Actions.md

@@ -0,0 +1,52 @@
+# Actions
+
+A simple example using a scene as a `tap`` menu item.
+
+```json
+{
+  "entity": "scene.telly_watching",
+  "name": "Telly Scene",
+  "type": "tap",
+  "tap_action": {
+    "service": "scene.turn_on"
+  }
+},
+```
+
+Any menu item with an action (`tap`, `template`, or `toggle`), may have a confirmation view added. For consistency this is always done via the `tap_action` JSON object, even though for a `toggle` menu item there will only ever be a single field inside. For the `toggle` menu item, the confirmation is presented on both `on` and `off` directions. There is no option for asymmetry, i.e. only in one direction.
+
+```json
+  "tap_action": {
+    "confirm": true
+  }
+```
+
+For example:
+
+```json
+{
+  "entity": "switch.garage_door",
+  "name": "Garage Door",
+  "type": "toggle",
+  "tap_action": {
+    "confirm": true
+  }
+}
+```
+
+Note that for notify events, you _must_ not supply an `entity_id` or the API call will fail. There are other examples too.
+
+```json
+{
+  "name": "Message",
+  "type": "tap",
+  "tap_action": {
+    "service": "notify.mobile_app_on_phone",
+    "data": {
+      "title": "This is a title",
+      "message": "This is the message"
+    },
+    "confirm": true
+  }
+}
+```