diff options
author | Jonathan Weth <git@jonathanweth.de> | 2020-07-21 17:39:59 +0200 |
---|---|---|
committer | Jonathan Weth <git@jonathanweth.de> | 2020-07-21 17:39:59 +0200 |
commit | 741d4498f76f743df42a7dfa7906700e9c754658 (patch) | |
tree | 01e1c16fbbaf6afa5e9014d6c19cf84f6b723839 /API.rst | |
parent | 4eb1dc6b06867a1f1906fa32ab6448d0a00b9700 (diff) | |
download | RWA.Support.SessionService-741d4498f76f743df42a7dfa7906700e9c754658.tar.gz RWA.Support.SessionService-741d4498f76f743df42a7dfa7906700e9c754658.tar.bz2 RWA.Support.SessionService-741d4498f76f743df42a7dfa7906700e9c754658.zip |
Add trigger option and API methods for updating and getting session status
Diffstat (limited to 'API.rst')
-rw-r--r-- | API.rst | 28 |
1 files changed, 28 insertions, 0 deletions
@@ -26,6 +26,34 @@ Start a new remote session and register it in RWA {"id": <pid>, "url": "<url>", "pin": <pin>} +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 |