diff options
author | Jonathan Weth <git@jonathanweth.de> | 2020-07-21 16:39:51 +0200 |
---|---|---|
committer | Jonathan Weth <git@jonathanweth.de> | 2020-07-21 16:39:51 +0200 |
commit | 4eb1dc6b06867a1f1906fa32ab6448d0a00b9700 (patch) | |
tree | 277af0c2e5269972fba47117ebc9a4c8c465520d /API.rst | |
parent | 817b979ddfe49da8d0d4661ca714f598f06b4a47 (diff) | |
download | RWA.Support.SessionService-4eb1dc6b06867a1f1906fa32ab6448d0a00b9700.tar.gz RWA.Support.SessionService-4eb1dc6b06867a1f1906fa32ab6448d0a00b9700.tar.bz2 RWA.Support.SessionService-4eb1dc6b06867a1f1906fa32ab6448d0a00b9700.zip |
Add API documentation for service
Diffstat (limited to 'API.rst')
-rw-r--r-- | API.rst | 35 |
1 files changed, 35 insertions, 0 deletions
@@ -0,0 +1,35 @@ +API documentation for Session Service +===================================== + +General information +------------------- + +Bus name: ``de.rwa.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:** + +:: + + {"id": <pid>, "url": "<url>", "pin": <pin>} + + +stop +^^^^ +Stop a remote session + +**Arguments:** pid/id (integer) + +**Return type:** none |