]> nmode's Git Repositories - signal-cli/blobdiff - man/signal-cli-dbus.5.adoc
implement Dbus isRegistered() methods (#729)
[signal-cli] / man / signal-cli-dbus.5.adoc
index 5d65c48fc64b77e7825b544cc231c8cc11c2f937..6b5d1a8607c2b6652776b4b98e1dc186acb425fb 100755 (executable)
@@ -322,8 +322,15 @@ Exception: Failure
 version() -> version<s>::
 * version : Version string of signal-cli
 
-isRegistred -> result<b>::
-* result : Currently always returns 1=true
+isRegistered() -> result<b>::
+isRegistered(number<s>) -> result<b>::
+isRegistered(numbers<as>) -> results<ab>::
+* number  : Phone number
+* numbers : String array of phone numbers
+* result  : true=number is registered, false=number is not registered
+* results : Boolean array of results
+
+Exception: InvalidNumber for an incorrectly formatted phone number. For unknown numbers, false is returned, but no exception is raised. If no number is given, returns whether you are registered (presumably true).
 
 addDevice(deviceUri<s>) -> <>::
 * deviceUri : URI in the form of tsdevice:/?uuid=... Normally received from Signal desktop or smartphone app