Implement viewedReceipt

[signal-cli] / man / signal-cli-dbus.5.adoc

diff --git a/man/signal-cli-dbus.5.adoc b/man/signal-cli-dbus.5.adoc
index f38afc93c5bc1dcc4d2c25dea31f0eaeadb153fd..1bc0b879fd201928c646d684b6d3bd8b03895488 100755 (executable)
--- a/man/signal-cli-dbus.5.adoc
+++ b/man/signal-cli-dbus.5.adoc
@@ -58,7 +58,7 @@ link(newDeviceName<s>) -> deviceLinkUri<s>::
 * newDeviceName : Name to give new device (defaults to "cli" if no name is given)
 * deviceLinkUri : URI of newly linked device
 
 * newDeviceName : Name to give new device (defaults to "cli" if no name is given)
 * deviceLinkUri : URI of newly linked device
 

-Returns a URI of the form "sgnl://linkdevice/?uuid=...". This can be piped to a QR encoder to create a display that
+Returns a URI of the form "sgnl://linkdevice?uuid=...". This can be piped to a QR encoder to create a display that

 can be captured by a Signal smartphone client. For example:
 
 `dbus-send --session --dest=org.asamk.Signal --type=method_call --print-reply /org/asamk/Signal org.asamk.Signal.link string:"My secondary client"|tr '\n' '\0'|sed 's/.*string //g'|sed 's/\"//g'|qrencode -s10 -tANSI256`
 can be captured by a Signal smartphone client. For example:
 
 `dbus-send --session --dest=org.asamk.Signal --type=method_call --print-reply /org/asamk/Signal org.asamk.Signal.link string:"My secondary client"|tr '\n' '\0'|sed 's/.*string //g'|sed 's/\"//g'|qrencode -s10 -tANSI256`


@@ -129,7 +129,7 @@ Exceptions: None, if the group name is not found an empty array is returned
 joinGroup(inviteURI<s>) -> <>::
 * inviteURI : String starting with https://signal.group/#
 
 joinGroup(inviteURI<s>) -> <>::
 * inviteURI : String starting with https://signal.group/#
 

-If the link requires admin approval, this adds you to the requesting members list. Otherwise, this adds you to the pending members list.
+Behavior of this method depends on the `requirePermission` parameter of the `enableLink` method. If permission is required, `joinGroup` adds you to the requesting members list. Permission may be granted based on the group's `PermissionAddMember` property (`ONLY_ADMINS` or `EVERY_MEMBER`). If permission is not required, `joinGroup` admits you immediately to the group.

 
 Exceptions: Failure
 
 
 Exceptions: Failure
 


@@ -203,7 +203,7 @@ To get all properties, use:
 addAdmins(recipients<as>) -> <>::
 * recipients  : String array of phone numbers
 
 addAdmins(recipients<as>) -> <>::
 * recipients  : String array of phone numbers
 

-Grant admit privileges to recipients.
+Grant admin privileges to recipients.

 
 Exceptions: Failure
 
 
 Exceptions: Failure
 


@@ -311,7 +311,7 @@ The following methods listen to the recipient's object path, which is constructe
 * DBusNumber  : recipient's phone number, with underscore (_) replacing plus (+)
 
 addDevice(deviceUri<s>) -> <>::
 * DBusNumber  : recipient's phone number, with underscore (_) replacing plus (+)
 
 addDevice(deviceUri<s>) -> <>::

-* deviceUri : URI in the form of "sgnl://linkdevice/?uuid=..." (formerly "tsdevice:/?uuid=...") Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method.
+* deviceUri : URI in the form of "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method.

 
 getDevice(deviceId<x>) -> devicePath<o>::
 * deviceId   : Long representing a deviceId
 
 getDevice(deviceId<x>) -> devicePath<o>::
 * deviceId   : Long representing a deviceId


@@ -462,6 +462,12 @@ sendReadReceipt(recipient<s>, targetSentTimestamps<ax>) -> <>::
 
 Exceptions: Failure, UntrustedIdentity
 
 
 Exceptions: Failure, UntrustedIdentity
 

+sendViewedReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
+* recipient             : Phone number of a single recipient
+* targetSentTimestamp   : Array of Longs to identify the corresponding signal messages
+
+Exceptions: Failure, UntrustedIdentity
+

 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 * targetSentTimestamp : Long representing timestamp of the message to delete
 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 * targetSentTimestamp : Long representing timestamp of the message to delete