webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-08-29 10:30:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs for DBus listDevices method (#768)

Browse source
This commit is contained in:
John Freed 2021-10-09 13:04:07 +02:00 • committed by GitHub
parent 179855272a
commit cadcc6c8ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

26
man/signal-cli-dbus.5.adoc
View file

@ -29,15 +29,18 @@ method(arg1<type>, arg2<type>, ...) -> return<type>
Where <type> is according to DBus specification: Where <type> is according to DBus specification:
* <s> : String * <a> : Array of ... (comma-separated list)
* <ay> : Byte Array * (...) : Struct (cannot be sent via `dbus-send`)
* <aay> : Array of Byte Arrays * <b> : Boolean (false|true) (boolean:)
* <as> : String Array * <i> : Signed 32-bit (int) integer (int32:)
* <ax> : Array of signed 64 bit integer * <o> : DBusPath object (objpath:)
* <b> : Boolean (0|1) * <s> : String (string:)
* <x> : Signed 64 bit integer * <x> : Signed 64-bit (long) integer (int64:)
* <y> : Unsigned 8-bit (byte) integer (byte:)
* <> : no return value * <> : 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. 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> Phone numbers always have the format +<countrycode><regional number>
@ -340,8 +343,11 @@ addDevice(deviceUri<s>) -> <>::
Exception: InvalidUri Exception: InvalidUri
listDevices() -> devices<as>:: listDevices() -> devices<a(oxs)>::
* devices : String array of linked 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 Exception: Failure
@ -370,7 +376,7 @@ Can be used to lift some rate-limits by solving a captcha.
Exception: IOErrorException Exception: IOErrorException
== Signalss == Signals
SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>):: 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. The sync message is received when the user sends a message from a linked device.