webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-09-02 12:30:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation and consistent case sensitivity

Browse source
This commit is contained in:
Adimarantis 2023-06-05 09:16:21 +02:00
parent 1bf4fd688b
commit de32a7db2f
3 changed files with 51 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -531,6 +531,42 @@ removeDevice() -> <>::
Exceptions: Failure 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 === Signal.Configuration interface
The configuration's object path, which exists only for primary devices, is constructed as follows: The configuration's object path, which exists only for primary devices, is constructed as follows:

14
src/main/java/org/asamk/Signal.java
View file

@ -585,13 +585,13 @@ public interface Signal extends DBusInterface {
} }
} }
@DBusProperty(name = "number", type = String.class, access = DBusProperty.Access.READ) @DBusProperty(name = "Number", type = String.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "uuid", type = String.class, access = DBusProperty.Access.READ) @DBusProperty(name = "Uuid", type = String.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "fingerprint", type = Byte[].class, access = DBusProperty.Access.READ) @DBusProperty(name = "Fingerprint", type = Byte[].class, access = DBusProperty.Access.READ)
@DBusProperty(name = "safetyNumber", type = String.class, access = DBusProperty.Access.READ) @DBusProperty(name = "SafetyNumber", type = String.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "trustLevel", type = String.class, access = DBusProperty.Access.READ) @DBusProperty(name = "TrustLevel", type = String.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "addedDate", type = Integer.class, access = DBusProperty.Access.READ) @DBusProperty(name = "AddedDate", type = Integer.class, access = DBusProperty.Access.READ)
@DBusProperty(name = "scannableSafetyNumber", type = Byte[].class, access = DBusProperty.Access.READ) @DBusProperty(name = "ScannableSafetyNumber", type = Byte[].class, access = DBusProperty.Access.READ)
interface Identity extends DBusInterface, Properties { interface Identity extends DBusInterface, Properties {
void trust() throws Error.Failure; void trust() throws Error.Failure;

16
src/main/java/org/asamk/signal/dbus/DbusSignalImpl.java
View file

@ -1045,7 +1045,7 @@ public class DbusSignalImpl implements Signal {
exportObject(object); exportObject(object);
this.identities.add(new StructIdentity(new DBusPath(object.getObjectPath()), this.identities.add(new StructIdentity(new DBusPath(object.getObjectPath()),
emptyIfNull(i.recipient().getIdentifier()), emptyIfNull(i.recipient().getIdentifier()),
i.recipient().getLegacyIdentifier())); i.recipient().getLegacyIdentifier()));
}); });
} }
@ -1084,13 +1084,13 @@ public class DbusSignalImpl implements Signal {
public DbusSignalIdentityImpl(final org.asamk.signal.manager.api.Identity identity) { public DbusSignalIdentityImpl(final org.asamk.signal.manager.api.Identity identity) {
this.identity=identity; this.identity=identity;
super.addPropertiesHandler(new DbusInterfacePropertiesHandler("org.asamk.Signal.Identity", super.addPropertiesHandler(new DbusInterfacePropertiesHandler("org.asamk.Signal.Identity",
List.of(new DbusProperty<>("number", () -> identity.recipient().number().orElse("")), List.of(new DbusProperty<>("Number", () -> identity.recipient().number().orElse("")),
new DbusProperty<>("uuid", () -> identity.recipient().uuid().map(UUID::toString).orElse("")), new DbusProperty<>("Uuid", () -> identity.recipient().uuid().map(UUID::toString).orElse("")),
new DbusProperty<>("fingerprint", () -> identity.getFingerprint()), new DbusProperty<>("Fingerprint", () -> identity.getFingerprint()),
new DbusProperty<>("safetyNumber", identity::safetyNumber), new DbusProperty<>("SafetyNumber", identity::safetyNumber),
new DbusProperty<>("scannableSafetyNumber", identity::scannableSafetyNumber), new DbusProperty<>("ScannableSafetyNumber", identity::scannableSafetyNumber),
new DbusProperty<>("trustLevel", identity::trustLevel), new DbusProperty<>("TrustLevel", identity::trustLevel),
new DbusProperty<>("addedDate", identity::dateAddedTimestamp) new DbusProperty<>("AddedDate", identity::dateAddedTimestamp)
))); )));
} }