X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/8416d4ac475af5c512d963bf79e62e933592e20a..3c40b11:/man/signal-cli-dbus.5.adoc diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc index 56b28ddf..508a7881 100755 --- a/man/signal-cli-dbus.5.adoc +++ b/man/signal-cli-dbus.5.adoc @@ -29,15 +29,18 @@ method(arg1, arg2, ...) -> return Where is according to DBus specification: -* : String -* : Byte Array -* : Array of Byte Arrays -* : String Array -* : Array of signed 64 bit integer -* : Boolean (0|1) -* : Signed 64 bit integer +* : Array of ... (comma-separated list, array:) +* (...) : Struct (cannot be sent via `dbus-send`) +* : Boolean (false|true) (boolean:) +* : Signed 32-bit (int) integer (int32:) +* : DBusPath object (objpath:) +* : String (string:) +* : Signed 64-bit (long) integer (int64:) +* : 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 + @@ -340,8 +343,11 @@ addDevice(deviceUri) -> <>:: Exception: InvalidUri -listDevices() -> devices:: -* devices : String array of linked devices +listDevices() -> devices:: +* 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 @@ -383,8 +389,14 @@ Update Signal configurations and sync them to linked devices. Only works from pr Exceptions: IOError, UserError -== Signals +submitRateLimitChallenge(challenge, captcha) -> <>:: +* 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, sender, destination, groupId,message, attachments):: The sync message is received when the user sends a message from a linked device.