update docs for DBus listDevices method (#768)

[signal-cli] / man / signal-cli-dbus.5.adoc

diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc
index e7cd083f16305891151f167b6dec0dffcaa370d8..8168c421bf30b6b884abd22542bf138b6f7c0822 100755 (executable)
--- a/man/signal-cli-dbus.5.adoc
+++ b/man/signal-cli-dbus.5.adoc
@@ -29,15 +29,18 @@ method(arg1<type>, arg2<type>, ...) -> return<type>
 
 Where <type> is according to DBus specification:
 
-* <s>   : String
-* <ay>  : Byte Array
-* <aay> : Array of Byte Arrays
-* <as>  : String Array
-* <ax>  : Array of signed 64 bit integer
-* <b>   : Boolean (0|1)
-* <x>   : Signed 64 bit integer
+* <a>   : Array of ... (comma-separated list)
+* (...) : Struct (cannot be sent via `dbus-send`)
+* <b>   : Boolean (false|true) (boolean:)
+* <i>   : Signed 32-bit (int) integer (int32:)
+* <o>   : DBusPath object (objpath:)
+* <s>   : String (string:)
+* <x>   : Signed 64-bit (long) integer (int64:)
+* <y>   : Unsigned 8-bit (byte) integer (byte:)
 * <>    : no return value
 
+The final parenthetical value (such as "boolean:") is the type indicator used by `dbus-send`.
+
 Exceptions are the names of the Java Exceptions returned in the body field. They typically contain an additional message with details. All Exceptions begin with "org.asamk.Signal.Error." which is omitted here for better readability.
 
 Phone numbers always have the format +<countrycode><regional number>
@@ -340,8 +343,11 @@ addDevice(deviceUri<s>) -> <>::
 
 Exception: InvalidUri
 
-listDevices() -> devices<as>::
-* devices  : String array of linked devices
+listDevices() -> devices<a(oxs)>::
+* devices      : Array of structs (objectPath, id, name)
+** objectPath   : DBusPath representing the device's object path
+** id           : Long representing the deviceId
+** name         : String representing the device's name
 
 Exception: Failure
 
@@ -363,8 +369,14 @@ uploadStickerPack(stickerPackPath<s>) -> url<s>::
 
 Exception: Failure
 
-== Signals
+submitRateLimitChallenge(challenge<s>, captcha<s>) -> <>::
+* challenge : The challenge token taken from the proof required error.
+* captcha   : The captcha token from the solved captcha on the Signal website..
+Can be used to lift some rate-limits by solving a captcha.
 
+Exception: IOErrorException
+
+== Signals
 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
 The sync message is received when the user sends a message from a linked device.