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

implement Dbus updateAccount and listDevices

Browse source 
implement updateAccount(deviceName<s>) to change device name

implement listDevices

update documentation
This commit is contained in:
John Freed 2021-09-21 11:17:43 +02:00
parent 6c29d90503
commit b875465eff
4 changed files with 337 additions and 112 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -11,3 +11,4 @@ local.properties
.settings/ .settings/
out/ out/
.DS_Store .DS_Store
/bin/

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

@ -7,7 +7,7 @@ vim:set ts=4 sw=4 tw=82 noet:
== Name == Name
DBus API for signal-cli - A commandline and dbus interface for the Signal messenger signal-cli-dbus - DBus API for signal-cli(1)
== Synopsis == Synopsis
@ -29,53 +29,125 @@ method(arg1<type>, arg2<type>, ...) -> return<type>
Where <type> is according to DBus specification: Where <type> is according to DBus specification:
* <a> : Array of ...
* <s> : String * <s> : String
* <ay> : Byte Array * <y> : Byte
* <aay> : Array of Byte Arrays * <b> : Boolean (false|true)
* <as> : String Array * <x> : Signed 64-bit integer (long)
* <ax> : Array of signed 64 bit integer * <i> : Signed 32-bit integer (int)
* <b> : Boolean (0|1)
* <x> : Signed 64 bit integer
* <> : no return value * <> : no return value
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>
== Methods === Control methods
These methods are available if the daemon is started anonymously (without an explicit `-u USERNAME`).
Requests are sent to `/org/asamk/Signal`; requests related to individual accounts are sent to
`/org/asamk/Signal/_441234567890` where the + dialing code is replaced by an underscore (_).
Only `version()` is activated in single-user mode; the rest are disabled.
updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>:: link() -> deviceLinkUri<s>::
* groupId : Byte array representing the internal group identifier link(newDeviceName<s>) -> deviceLinkUri<s>::
* newName : New name of group (empty if unchanged) * newDeviceName : Name to give new device (defaults to "cli" if no name is given)
* members : String array of new members to be invited to group * deviceLinkUri : URI of newly linked device
* avatar : Filename of avatar picture to be set for group (empty if none)
Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound Returns a URI of the form "tsdevice:/?uuid=...". This can be piped to a QR encoder to create a display that
can be captured by a Signal smartphone client. For example:
updateProfile(newName<s>, about <s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>:: `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`
* newName : New name for your own profile (empty if unchanged)
* about : About message for profile (empty if unchanged)
* aboutEmoji : Emoji for profile (empty if unchanged)
* avatar : Filename of avatar picture for profile (empty if unchanged)
* remove : Set to 1 if the existing avatar picture should be removed
Exceptions: Failure Exception: Failure
setContactBlocked(number<s>, block<b>) -> <>:: listAccounts() -> accountList<as>::
* number : Phone number affected by method * accountList : Array of all attached accounts in DBus object path form
* block : 0=remove block , 1=blocked
Messages from blocked numbers will no longer be forwarded via DBus. Exceptions: None
Exceptions: InvalidNumber register(number<s>, voiceVerification<b>) -> <>::
* number : Phone number
* voiceVerification : true = use voice verification; false = use SMS verification
setGroupBlocked(groupId<ay>, block<b>) -> <>:: Exceptions: Failure, InvalidNumber, RequiresCaptcha
* groupId : Byte array representing the internal group identifier
* block : 0=remove block , 1=blocked
Messages from blocked groups will no longer be forwarded via DBus. registerWithCaptcha(number<s>, voiceVerification<b>, captcha<s>) -> <>::
* number : Phone number
* voiceVerification : true = use voice verification; false = use SMS verification
* captcha : Captcha string
Exceptions: GroupNotFound Exceptions: Failure, InvalidNumber, RequiresCaptcha
verify(number<s>, verificationCode<s>) -> <>::
* number : Phone number
* verificationCode : Code received from Signal after successful registration request
Command fails if PIN was set after previous registration; use verifyWithPin instead.
Exception: Failure, InvalidNumber
verifyWithPin(number<s>, verificationCode<s>, pin<s>) -> <>::
* number : Phone number
* verificationCode : Code received from Signal after successful registration request
* pin : PIN you set with setPin command after verifying previous registration
Exception: Failure, InvalidNumber
version() -> version<s>::
* version : Version string of signal-cli
Exceptions: None
=== Methods for groups
getGroupIds() -> groupList<aay>::
groupList : Array of Byte arrays representing the internal group identifiers
All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked()
Exceptions: None
getGroupIds(dummy<s>) -> groupList<as>::
* dummy : any string (ignored by method; forces output to be identical with getGroupIdsBase64)
* groupList : Array of strings representing the internal group identifiers
Exceptions: None
getGroupIdsBase64() -> groupList<as>::
* groupList : Array of strings representing the internal group identifiers
Exceptions: None
getGroupMembers(groupId<ay>) -> members<as>::
getGroupMembers(base64GroupId<s>) -> members<as>::
* members : String array with the phone numbers of all active members of a group
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
Exceptions: InvalidGroupId, Failure
getGroupName(groupId<ay>) -> groupName<s>::
getGroupName(base64GroupId<s>) -> groupName<s>::
* groupName : The display name of the group
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
Exceptions: InvalidGroupId, Failure
isGroupBlocked(groupId<ay>) -> state<b>::
isGroupBlocked(base64GroupId<s>) -> state<b>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
* state : false=not blocked, true=blocked
Exceptions: None; for unknown groups false is returned
isMember(groupId<ay>) -> active<b>::
isMember(base64GroupId<s>) -> active<b>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
* active : true=active member; false=not active member
InvalidGroupId, Failure
joinGroup(inviteURI<s>) -> <>:: joinGroup(inviteURI<s>) -> <>::
* inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App * inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App
@ -83,72 +155,126 @@ joinGroup(inviteURI<s>) -> <>::
Exceptions: Failure Exceptions: Failure
quitGroup(groupId<ay>) -> <>:: quitGroup(groupId<ay>) -> <>::
* groupId : Byte array representing the internal group identifier quitGroup(base64GroupId<s>) -> <>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
Note that quitting a group will not remove the group from the getGroupIds command, but set it inactive which can be tested with isMember() Note that quitting a group will not remove the group from the getGroupIds command, but set it inactive which can be tested with isMember()
Exceptions: GroupNotFound, Failure Exceptions: GroupNotFound, Failure
isMember(groupId<ay>) -> active<b>::
* groupId : Byte array representing the internal group identifier
Note that this method does not raise an Exception for a non-existing/unknown group but will simply return 0 (false)
sendEndSessionMessage(recipients<as>) -> <>::
* recipients : Array of phone numbers
Exceptions: Failure, InvalidNumber, UntrustedIdentity
sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>:: sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
* message : Text to send (can be UTF8) sendGroupMessage(message<s>, attachments<as>, base64GroupId<s>) -> timestamp<x>::
* attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under) * message : Text to send (can be UTF8)
* groupId : Byte array representing the internal group identifier * attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under)
* timestamp : Can be used to identify the corresponding signal reply * groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
* timestamp : Can be used to identify the corresponding signal reply
Exceptions: GroupNotFound, Failure, AttachmentInvalid Exceptions: GroupNotFound, Failure, AttachmentInvalid
sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>:: sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
* message : Text to send (can be UTF8) sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, base64GroupId<s>) -> timestamp<x>::
* attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under) * emoji : Unicode grapheme cluster of the emoji
* timestamp : Can be used to identify the corresponding signal reply * remove : Boolean, whether a previously sent reaction (emoji) should be removed
* targetAuthor : String with the phone number of the author of the message to which to react
* targetSentTimestamp : Long representing timestamp of the message to which to react
* groupId : Byte array with base64 encoded group identifier
* base64GroupId : String with base64 encoded group identifier
* timestamp : Long, can be used to identify the corresponding signal reply
Exceptions: Failure, AttachmentInvalid Exceptions: Failure, InvalidNumber, GroupNotFound
sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, base64GroupId<s>) -> timestamp<x>::
* targetSentTimestamp : Long representing timestamp of the message to delete
* groupId : Byte array with base64 encoded group identifier
* base64GroupId : String with base64 encoded group identifier
* timestamp : Long, can be used to identify the corresponding signal reply
Exceptions: Failure, GroupNotFound, InvalidGroupId
setGroupBlocked(groupId<ay>, block<b>) -> <>::
setGroupBlocked(base64GroupId<s>, block<b>) -> <>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
* block : false=remove block, true=blocked
Messages from blocked groups will no longer be forwarded via DBus.
Exceptions: GroupNotFound
updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>::
updateGroup(base64GroupId<s>, newName<s>, members<as>, avatar<s>) -> base64GroupId<s>::
* groupId : Byte array representing the internal group identifier
* base64GroupId : String with base64 encoded group identifier
* newName : New name of group (empty if unchanged)
* members : String array of new members to be invited to group
* avatar : Filename of avatar picture to be set for group (empty if none)
If groupId (or base64GroupId) is empty, creates a group with a random identifier
and returns it. Otherwise, updates group as indicated.
Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
=== Methods for individual(s)
getContactName(number<s>) -> name<s>::
* number : Phone number
* name : Contact's name in local storage (from the master device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
Exception: InvalidNumber
getContactNumber(name<s>) -> numbers<as>::
* numbers : String array of phone numbers
* name : Contact or profile name ("firstname lastname")
Searches contacts and known profiles for a given name and returns the list of all known numbers. May result in e.g. two entries if a contact and profile name is set.
Exception: Failure
isContactBlocked(number<s>) -> state<b>::
* number : Phone number
* state : true=blocked, false=not blocked
Exception: InvalidNumber for an incorrectly formatted phone number. For unknown numbers, false is returned, but no exception is raised.
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.
listIdentity(number<s>) -> identities<a(ssss)>::
* number : Phone number
* identities : Array of elements, each consisting of four strings: trust_level, date_added, fingerprint, safety_number
** trust_level : String representation of trust level
** date_added : String representation of date added
** fingerprint : String representation of hexadecimal fingerprint
** safety_number : String representation of safety number (10 or 11 space-separated six-digit numbers)
Exception: InvalidNumber
sendEndSessionMessage(recipients<as>) -> <>::
* recipients : Array of phone numbers
Exceptions: Failure, InvalidNumber, UntrustedIdentity
sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>:: sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>:: sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
* message : Text to send (can be UTF8) * message : Text to send (can be UTF8)
* attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under) * attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under)
* recipient : Phone number of a single recipient * recipient : Phone number of a single recipient
* recipients : Array of phone numbers * recipients : Array of phone numbers
* timestamp : Can be used to identify the corresponding signal reply * timestamp : Can be used to identify the corresponding signal reply
Depending on the type of the recipient field this sends a message to one or multiple recipients. Depending on the type of the recipient field this sends a message to one or multiple recipients.
Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
sendTyping(recipient<s>, stop<b>) -> <>::
* recipient : Phone number of a single recipient
* targetSentTimestamp : True, if typing state should be stopped
Exceptions: Failure, GroupNotFound, UntrustedIdentity
sendReadReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
* recipient : Phone number of a single recipient
* targetSentTimestamp : Array of Longs to identify the corresponding signal messages
Exceptions: Failure, UntrustedIdentity
sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
* emoji : Unicode grapheme cluster of the emoji
* remove : Boolean, whether a previously sent reaction (emoji) should be removed
* targetAuthor : String with the phone number of the author of the message to which to react
* targetSentTimestamp : Long representing timestamp of the message to which to react
* groupId : Byte array with base64 encoded group identifier
* timestamp : Long, can be used to identify the corresponding signal reply
Exceptions: Failure, InvalidNumber, GroupNotFound
sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>:: sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>:: sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
* emoji : Unicode grapheme cluster of the emoji * emoji : Unicode grapheme cluster of the emoji
@ -163,12 +289,11 @@ Depending on the type of the recipient(s) field this sends a reaction to one or
Exceptions: Failure, InvalidNumber Exceptions: Failure, InvalidNumber
sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>:: sendReadReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
* targetSentTimestamp : Long representing timestamp of the message to delete * recipient : Phone number of a single recipient
* groupId : Byte array with base64 encoded group identifier * targetSentTimestamp : Array of Longs to identify the corresponding signal messages
* timestamp : Long, can be used to identify the corresponding signal reply
Exceptions: Failure, GroupNotFound Exceptions: Failure, UntrustedIdentity
sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>:: sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>:: sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
@ -181,70 +306,83 @@ Depending on the type of the recipient(s) field this deletes a message with one
Exceptions: Failure, InvalidNumber Exceptions: Failure, InvalidNumber
getContactName(number<s>) -> name<s>:: sendTyping(recipient<s>, stop<b>) -> <>::
* number : Phone number * recipient : Phone number of a single recipient
* name : Contact's name in local storage (from the master device for a linked account, or the one set with setContactName); if not set, contact's profile name is used * targetSentTimestamp : True, if typing state should be stopped
Exceptions: Failure, GroupNotFound, UntrustedIdentity
setContactBlocked(number<s>, block<b>) -> <>::
* number : Phone number affected by method
* block : false=remove block , true=blocked
Messages from blocked numbers will no longer be forwarded via DBus.
Exceptions: InvalidNumber
setContactName(number<s>,name<>) -> <>:: setContactName(number<s>,name<>) -> <>::
* number : Phone number * number : Phone number
* name : Name to be set in contacts (in local storage with signal-cli) * name : Name to be set in contacts (in local storage with signal-cli)
getGroupIds() -> groupList<aay>:: Exceptions: InvalidNumber
groupList : Array of Byte arrays representing the internal group identifiers
All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked() trust(number<s>, safetyNumber<s>) -> <>::
* number : Phone number
* safetyNumber : Verify the safety number associated with the phone number.
getGroupName(groupId<ay>) -> groupName<s>:: Exceptions: Failure, InvalidNumber
groupName : The display name of the group
groupId : Byte array representing the internal group identifier
Exceptions: None, if the group name is not found an empty string is returned === Other methods
getGroupMembers(groupId<ay>) -> members<as>:: listDevices() -> devices<as>::
members : String array with the phone numbers of all active members of a group * devices : String array of linked devices
groupId : Byte array representing the internal group identifier
Exceptions: None, if the group name is not found an empty array is returned Exception: Failure
listNumbers() -> numbers<as>:: listNumbers() -> numbers<as>::
numbers : String array of all known numbers * numbers : String array of all known numbers
This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages) This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages)
getContactNumber(name<s>) -> numbers<as>:: Exceptions: None
* numbers : Array of phone number
* name : Contact or profile name ("firstname lastname")
Searches contacts and known profiles for a given name and returns the list of all known numbers. May result in e.g. two entries if a contact and profile name is set. sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
* message : Text to send (can be UTF8)
* attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under)
* timestamp : Can be used to identify the corresponding signal reply
isContactBlocked(number<s>) -> state<b>:: Exceptions: Failure, AttachmentInvalid
* number : Phone number
* state : 1=blocked, 0=not blocked
Exceptions: None, for unknown numbers 0 (false) is returned updateAccount(deviceName<s>) -> <>::
* deviceName : New name
isGroupBlocked(groupId<ay>) -> state<b>:: Set a new name for this device (main or linked).
* groupId : Byte array representing the internal group identifier
* state : 1=blocked, 0=not blocked
Exceptions: None, for unknown groups 0 (false) is returned Exception: Failure
updateProfile(newName<s>, about <s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
* newName : New name for your own profile (empty if unchanged)
* about : About message for profile (empty if unchanged)
* aboutEmoji : Emoji for profile (empty if unchanged)
* avatar : Filename of avatar picture for profile (empty if unchanged)
* remove : Set to true if the existing avatar picture should be removed
Exceptions: Failure
version() -> version<s>:: version() -> version<s>::
* version : Version string of signal-cli * version : Version string of signal-cli
isRegistred -> result<b>::
* result : Currently always returns 1=true
== Signals == 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.
ReceiptReceived (timestamp<x>, sender<s>):: ReceiptReceived (timestamp<x>, sender<s>)::
* timestamp : Integer value that can be used to associate this e.g. with a sendMessage() * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
* sender : Phone number of the sender * sender : Phone number of the sender
This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device The sync message is received when the user sends a message from a linked device.
MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>):: MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
* timestamp : Integer value that is used by the system to send a ReceiptReceived reply * timestamp : Integer value that is used by the system to send a ReceiptReceived reply
@ -255,13 +393,66 @@ MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as
This signal is received whenever we get a private message or a message is posted in a group we are an active member This signal is received whenever we get a private message or a message is posted in a group we are an active member
SyncMessageReceivedV2 (timestamp<x>, sender<s>, destination<s>, groupId<ay>, message<s>, mentions<a(sii)>, attachments<a(sssxibiiss)>)::
* timestamp : Integer value that is used by the system to send a ReceiptReceived reply
* sender : Phone number of the sender
* destination : UUID (legacy identifier) of the destination
* groupId : Byte array representing the internal group identifier (empty when private message)
* message : Message text
* mentions : Struct array of mentions: number, position, length
** number : String phone number
** position : Integer starting position of mention within message
** length : Integer length of mention within message
* attachments : Struct array of attachment metadata.
** contentType : String representing the MIME type of the attachment
** fileName : String representing file name if given by the Signal servers
** id : String representing remote identifier of attachment. This the name used by signal-cli to store the attachment, and the current user needs to have read access
** size : Long representing size of attachment in bytes
** keyLength : Integer representing key length
** voiceNote : boolean representing whether this attachment is a voice note
** width : Integer representation of width in pixels (0 if not image)
** height : Integer representation of height in pixels (0 if not image)
** caption : String representing photo caption
** blurHash : String representing blur hash
The sync message is received when the user sends a message from a linked device.
MessageReceivedV2(timestamp<x>, sender<s>, groupId<ay>, message<s>, mentions<a(sii)>, attachments<a(sssxibiiss)>)::
* timestamp : Integer value that is used by the system to send a ReceiptReceived reply
* sender : Phone number of the sender
* groupId : Byte array representing the internal group identifier (empty when private message)
* message : Message text
* mentions : Struct array of mentions: number, position, length
** number : String phone number
** position : Integer starting position of mention within message
** length : Integer length of mention within message
* attachments : Struct array of attachment metadata.
** contentType : String representing the MIME type of the attachment
** fileName : String representing file name if given by the Signal servers
** id : String representing remote identifier of attachment. This the name used by signal-cli to store the attachment, and the current user needs to have read access
** size : Long representing size of attachment in bytes
** keyLength : Integer representing key length
** voiceNote : boolean representing whether this attachment is a voice note
** width : Integer representation of width in pixels (0 if not image)
** height : Integer representation of height in pixels (0 if not image)
** caption : String representing photo caption
** blurHash : String representing blur hash
This signal is received whenever we get a private message or a message is posted in a group we are an active member
ReceiptReceived (timestamp<x>, sender<s>)::
* timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
* sender : Phone number of the sender
This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
== Examples == Examples
Send a text message (without attachment) to a contact:: Send a text message (without attachment) to a contact::
dbus-send --print-reply --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal org.asamk.Signal.sendMessage string:"Message text goes here" array:string: string:+123456789 dbus-send --print-reply --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal org.asamk.Signal.sendMessage string:"Message text goes here" array:string: string:+123456789
Send a group message:: Send a group message::
dbus-send --session --print-reply --type=method_call --dest=org.asamk.Signal /org/asamk/Signal org.asamk.Signal.sendGroupMessage string:'The message goes here' array:string:'/path/to/attachmnt1','/path/to/attachmnt2' array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185 dbus-send --session --print-reply --type=method_call --dest=org.asamk.Signal /org/asamk/Signal org.asamk.Signal.sendGroupMessage string:'The message goes here' array:string:'/path/to/attachment1','/path/to/attachment2' array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185
Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-u USERNAME`:: Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-u USERNAME`::
dbus-send --system --print-reply --type=method_call --dest='org.asamk.Signal' /org/asamk/Signal/_1234567890 org.asamk.Signal.getGroupName array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185 dbus-send --system --print-reply --type=method_call --dest='org.asamk.Signal' /org/asamk/Signal/_1234567890 org.asamk.Signal.getGroupName array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185

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

@ -83,6 +83,10 @@ public interface Signal extends DBusInterface {
boolean isRegistered(); boolean isRegistered();
List<String> listDevices() throws Error.Failure;
void updateAccount(String deviceName) throws Error.Failure;
void updateProfile( void updateProfile(
String name, String about, String aboutEmoji, String avatarPath, boolean removeAvatar String name, String about, String aboutEmoji, String avatarPath, boolean removeAvatar
) throws Error.Failure; ) throws Error.Failure;

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

@ -6,6 +6,7 @@ import org.asamk.signal.manager.AttachmentInvalidException;
import org.asamk.signal.manager.Manager; import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.NotMasterDeviceException; import org.asamk.signal.manager.NotMasterDeviceException;
import org.asamk.signal.manager.UntrustedIdentityException; import org.asamk.signal.manager.UntrustedIdentityException;
import org.asamk.signal.manager.api.Device;
import org.asamk.signal.manager.api.Message; import org.asamk.signal.manager.api.Message;
import org.asamk.signal.manager.api.RecipientIdentifier; import org.asamk.signal.manager.api.RecipientIdentifier;
import org.asamk.signal.manager.api.TypingAction; import org.asamk.signal.manager.api.TypingAction;
@ -60,6 +61,34 @@ public class DbusSignalImpl implements Signal {
return objectPath; return objectPath;
} }
@Override
public List<String> listDevices() {
List<Device> devices;
List<String> results = new ArrayList<String>();
try {
devices = m.getLinkedDevices();
} catch (IOException | Error.Failure e) {
throw new Error.Failure("Failed to get linked devices: " + e.getMessage());
}
for (var d : devices) {
var name = d.getName();
if (name == null) {name = "null";}
results.add(name);
}
return results;
}
@Override
public void updateAccount(String deviceName) {
try {
m.updateAccountAttributes(deviceName);
} catch (IOException | Signal.Error.Failure e) {
throw new Error.Failure("UpdateAccount error: " + e.getMessage());
}
}
@Override @Override
public long sendMessage(final String message, final List<String> attachments, final String recipient) { public long sendMessage(final String message, final List<String> attachments, final String recipient) {
var recipients = new ArrayList<String>(1); var recipients = new ArrayList<String>(1);