aboutsummaryrefslogtreecommitdiffstats
path: root/docs/afm-user-daemon.md
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2016-11-14 11:43:46 +0100
committerJosé Bollo <jose.bollo@iot.bzh>2016-11-14 13:54:22 +0100
commita1f7f7d2cd79c9391368d0c017452566a5edc44c (patch)
treee1f507900d7526fec3a3cf3c73671d8260045ad4 /docs/afm-user-daemon.md
parentb6ac54640c918aecaf2f28edf82f8217154b12f3 (diff)
afm-user-daemon: Adds method "once"
Adds the method "once" that is intended to start an application in local mode if it doesn't already run. Returns the state of the running application. Change-Id: I4dfff06fa2d3e95f13a2436a2f1af9174799ddcf Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs/afm-user-daemon.md')
-rw-r--r--docs/afm-user-daemon.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/afm-user-daemon.md b/docs/afm-user-daemon.md
index cb54b10..37cf0e4 100644
--- a/docs/afm-user-daemon.md
+++ b/docs/afm-user-daemon.md
@@ -398,7 +398,7 @@ user sessions.
The **afm-user-daemon** is listening on destination name
***org.AGL.afm.user*** at object path ***/org/AGL/afm/user***
on interface ***org.AGL.afm.user*** for following members:
- ***runnables***, ***detail***, ***start***, ***terminate***,
+ ***runnables***, ***detail***, ***start***, ***once***, ***terminate***,
***pause***, ***resume***, ***runners***, ***state***,
***install*** and ***uninstall***.
@@ -464,6 +464,10 @@ Here is the summary of ***afm-util***:
start an instance of the widget of id
+ - **afm-util once id **:
+
+ run once an instance of the widget of id
+
- **afm-util terminate rid **:
terminate the running instance rid
@@ -634,6 +638,26 @@ The field "mode" is a string equal to either "local" or "remote".
---
+#### Method org.AGL.afm.user.once
+
+**Description**:
+
+**Input**: the *id* of the application
+
+Either just a string:
+
+ "appli@x.y"
+
+Or an object containing field "id" of type string.
+
+ {"id":"appli@x.y"}
+
+**output**: The *state* of the application retrieved or launched.
+See *org.AGL.afm.user.state* to get a description of the returned
+object.
+
+---
+
#### Method org.AGL.afm.user.terminate
**Description**: Terminates the application attached to *runid*.