blob: 9cec20bda60dc607b0914063b645d2a76e68d4b2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
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
|
