aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnna (navi) Figueiredo Gomes <navi@vlhl.dev>2023-10-11 12:00:29 +0200
committerAnna (navi) Figueiredo Gomes <navi@vlhl.dev>2023-10-11 12:00:29 +0200
commit62257bbb9a20a6cbb339c0b09038cba065f7e680 (patch)
tree49c5077489115a266f3eaab0771e6caab6bbea05
parentc00bb3cb24d22cfe417874228dd4086729da8fa3 (diff)
ext-action-binder: improve description for trigger types
Signed-off-by: Anna (navi) Figueiredo Gomes <navi@vlhl.dev>
-rw-r--r--staging/ext-action-binder/ext-action-binder-v1.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/staging/ext-action-binder/ext-action-binder-v1.xml b/staging/ext-action-binder/ext-action-binder-v1.xml
index a32c463..7840ebc 100644
--- a/staging/ext-action-binder/ext-action-binder-v1.xml
+++ b/staging/ext-action-binder/ext-action-binder-v1.xml
@@ -69,8 +69,8 @@
<description summary="sets the namespace:name of a binding">
Sets the namespace:name of the binding. This a kind of action.
</description>
- <arg name="action_namespace" type="string" summary="the action namespace" />
- <arg name="action_name" type="string" summary="the action name" />
+ <arg name="namespace" type="string" summary="the action namespace" />
+ <arg name="name" type="string" summary="the action name" />
</request>
<request name="set_description">
@@ -124,9 +124,16 @@
<enum name="trigger_type">
<description summary="type of binding triggered">
- Depending on the user configuration, an action can be either one-off or
+ Depending on the user configuration, an action can be either one_shot or
sustained. The client must handle all the three event types and either make
sense of them or ignore them properly.
+
+ one_shot actions are for events that don't have a defined "end", like a laptop
+ lid closing, or a gesture. The client should not expect to recieve a released or
+ ending event for that action.
+
+ sustained actions have a start and an end. after a 'pressed' event is sent, a
+ 'released' event should eventually be sent as well.
</description>
<entry name="one_shot" value="0"
summary="a one shot action was triggered" />