diff options
| -rw-r--r-- | API.rst | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/API.rst b/API.rst deleted file mode 100644 index 9cec20b..0000000 --- a/API.rst +++ /dev/null @@ -1,69 +0,0 @@ -API documentation for Session Service -===================================== - -General information -------------------- - -Bus name: ``org.ArcticaProject.RWA`` - -Object name: ``/RWA`` - -Methods -------- - -start -^^^^^ -Start a new remote session and register it in RWA - -**Arguments:** none - -**Return type:** string (JSON) - -**Structure of returned JSON (success):** - -:: - - {"status": "success", "id": <pid>, "url": "<url>", "pin": <pin>} - -**Structure of returned JSON (error):** - -:: - - {"status": "error"} - - -status -^^^^^^ -Return the status of a session - -.. note:: - - This uses the last status version got by the update service in the background. - -**Arguments:** pid/id (integer) - -**Return type:** string (JSON) - - -**Structure of returned JSON:** - -:: - - {"id": <pid>, "status": <status>} - -**Possible status options:** - -- ``running``: The session is running and ready for connecting. -- ``joined``: The session is running and a the remote connected to the session. - -refresh_status -^^^^^^^^^^^^^^ -Same as ``status``, but updates status from Django before returning it here. - -stop -^^^^ -Stop a remote session - -**Arguments:** pid/id (integer) - -**Return type:** none |