mirror of
https://github.com/AsamK/signal-cli
synced 2025-09-02 20:40:38 +00:00
Documentation and consistent case sensitivity
This commit is contained in:
parent
1bf4fd688b
commit
de32a7db2f
3 changed files with 51 additions and 15 deletions
|
@ -531,6 +531,42 @@ removeDevice() -> <>::
|
|||
|
||||
Exceptions: Failure
|
||||
|
||||
=== Signal.Identity interface
|
||||
|
||||
The following methods listen to the Identities object path, which is constructed as follows:
|
||||
|
||||
<ACCOUNT_PATH> + "/Identities/" + identity
|
||||
|
||||
identity : Either the phone number of a contact with underscore (_) replacing plus (+) , or if not known its uuid
|
||||
|
||||
Identities have the following (case-sensitive) properties:
|
||||
|
||||
* Number<s> (read-only) : Phone number of the contact
|
||||
* Uuid<x> (read-only) : Internal uuid representing the contact
|
||||
* Fingerprint<x> (read-only) : Byte array representing the fingerprint
|
||||
* SafetyNumber<s> (read-only) : String representation of the safety number used to verify trust
|
||||
* TrustLevel<s> (read-only) : Current trust level (UNSTRUSTED, TRUSTED_UNVERIFIED, TRUSTED_VERIFIED)
|
||||
* AddedDate<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
|
||||
* ScannableSafetyNumber<x> (read-only) : Byte array representation of the safety number
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Identity string:$PROPERTY_NAME`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Identity`
|
||||
|
||||
trust() -> <>::
|
||||
|
||||
Establish trust with the given identity. TrustLevel will become TRUSTED_UNVERFIED
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
trustVerified(SafetyNumber<s>) -> <>::
|
||||
|
||||
Establish trust with the given identity using their safety number. TrustLevel will become TRUSTED_VERIFIED
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
=== Signal.Configuration interface
|
||||
|
||||
The configuration's object path, which exists only for primary devices, is constructed as follows:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue