afm-user-daemon: Adds method "once"

[src/app-framework-main.git] / docs / afm-user-daemon.md

diff --git a/docs/afm-user-daemon.md b/docs/afm-user-daemon.md
index cb54b10..37cf0e4 100644 (file)
--- 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*.