mirror of
https://github.com/AsamK/signal-cli
synced 2025-09-02 20:40:38 +00:00
dbus methods: listIdentities, trust
rename listIdentity to listIdentities and more closely follow
behavior of the listIdentities command
update documentation
respond to issues raised by AsamK in initial pull request
This commit is contained in:
John Freed
parent
7ced8090fc
commit
af9000972e
3 changed files with 198 additions and 306 deletions
|
|
@ -7,7 +7,7 @@ vim:set ts=4 sw=4 tw=82 noet:
|
|||
|
||||
== Name
|
||||
|
||||
signal-cli-dbus - DBus API for signal-cli(1)
|
||||
DBus API for signal-cli - A commandline and dbus interface for the Signal messenger
|
||||
|
||||
== Synopsis
|
||||
|
||||
|
|
@ -29,125 +29,55 @@ method(arg1<type>, arg2<type>, ...) -> return<type>
|
|||
|
||||
Where <type> is according to DBus specification:
|
||||
|
||||
* <a> : Array of ...
|
||||
* <s> : String
|
||||
* <y> : Byte
|
||||
* <b> : Boolean (false|true)
|
||||
* <x> : Signed 64-bit integer (long)
|
||||
* <i> : Signed 32-bit integer (int)
|
||||
* <ay> : Byte Array
|
||||
* <aay> : Array of Byte Arrays
|
||||
* <as> : String Array
|
||||
* <ax> : Array of signed 64 bit integer
|
||||
* <b> : Boolean (0|1)
|
||||
* <v> : Variant
|
||||
* <x> : Signed 64 bit integer
|
||||
* <> : no return value
|
||||
* {...} : dictionary
|
||||
|
||||
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>
|
||||
|
||||
=== 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.
|
||||
== Methods
|
||||
|
||||
link() -> deviceLinkUri<s>::
|
||||
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
|
||||
updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>::
|
||||
* groupId : Byte array representing the internal 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)
|
||||
|
||||
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:
|
||||
Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
|
||||
|
||||
`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`
|
||||
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 1 if the existing avatar picture should be removed
|
||||
|
||||
Exception: Failure
|
||||
Exceptions: Failure
|
||||
|
||||
listAccounts() -> accountList<as>::
|
||||
* accountList : Array of all attached accounts in DBus object path form
|
||||
setContactBlocked(number<s>, block<b>) -> <>::
|
||||
* number : Phone number affected by method
|
||||
* block : 0=remove block , 1=blocked
|
||||
|
||||
Exceptions: None
|
||||
Messages from blocked numbers will no longer be forwarded via DBus.
|
||||
|
||||
register(number<s>, voiceVerification<b>) -> <>::
|
||||
* number : Phone number
|
||||
* voiceVerification : true = use voice verification; false = use SMS verification
|
||||
Exceptions: InvalidNumber
|
||||
|
||||
Exceptions: Failure, InvalidNumber, RequiresCaptcha
|
||||
setGroupBlocked(groupId<ay>, block<b>) -> <>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* block : 0=remove block , 1=blocked
|
||||
|
||||
registerWithCaptcha(number<s>, voiceVerification<b>, captcha<s>) -> <>::
|
||||
* number : Phone number
|
||||
* voiceVerification : true = use voice verification; false = use SMS verification
|
||||
* captcha : Captcha string
|
||||
Messages from blocked groups will no longer be forwarded via DBus.
|
||||
|
||||
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
|
||||
Exceptions: GroupNotFound
|
||||
|
||||
joinGroup(inviteURI<s>) -> <>::
|
||||
* inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App
|
||||
|
|
@ -155,120 +85,72 @@ joinGroup(inviteURI<s>) -> <>::
|
|||
Exceptions: Failure
|
||||
|
||||
quitGroup(groupId<ay>) -> <>::
|
||||
quitGroup(base64GroupId<s>) -> <>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* base64GroupId : String with base64 encoded group identifier
|
||||
* groupId : Byte array representing the internal 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()
|
||||
|
||||
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>, base64GroupId<s>) -> 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)
|
||||
* 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
|
||||
* 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)
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* timestamp : Can be used to identify the corresponding signal reply
|
||||
|
||||
Exceptions: GroupNotFound, Failure, AttachmentInvalid
|
||||
|
||||
sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
|
||||
sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, base64GroupId<s>) -> 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
|
||||
* base64GroupId : String with base64 encoded group identifier
|
||||
* timestamp : Long, can be used to identify the corresponding signal reply
|
||||
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
|
||||
|
||||
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 -> result<b>::
|
||||
* result : Currently always returns true
|
||||
|
||||
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
|
||||
Exceptions: Failure, AttachmentInvalid
|
||||
|
||||
sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
|
||||
sendMessage(message<s>, attachments<as>, recipients<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)
|
||||
* 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
|
||||
|
||||
Depending on the type of the recipient field this sends a message to one or multiple recipients.
|
||||
|
||||
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>, recipients<as>) -> timestamp<x>::
|
||||
* emoji : Unicode grapheme cluster of the emoji
|
||||
|
|
@ -283,11 +165,12 @@ Depending on the type of the recipient(s) field this sends a reaction to one or
|
|||
|
||||
Exceptions: Failure, InvalidNumber
|
||||
|
||||
sendReadReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamp : Array of Longs to identify the corresponding signal messages
|
||||
sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
|
||||
* targetSentTimestamp : Long representing timestamp of the message to delete
|
||||
* groupId : Byte array with base64 encoded group identifier
|
||||
* timestamp : Long, can be used to identify the corresponding signal reply
|
||||
|
||||
Exceptions: Failure, UntrustedIdentity
|
||||
Exceptions: Failure, GroupNotFound
|
||||
|
||||
sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
|
||||
sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
|
||||
|
|
@ -300,71 +183,115 @@ Depending on the type of the recipient(s) field this deletes a message with one
|
|||
|
||||
Exceptions: Failure, InvalidNumber
|
||||
|
||||
sendTyping(recipient<s>, stop<b>) -> <>::
|
||||
* recipient : Phone number of a single recipient
|
||||
* 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
|
||||
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
|
||||
|
||||
setContactName(number<s>,name<>) -> <>::
|
||||
* number : Phone number
|
||||
* name : Name to be set in contacts (in local storage with signal-cli)
|
||||
|
||||
Exceptions: InvalidNumber
|
||||
listIdentities() -> identities<a{sv}>::
|
||||
* contactNumber : Phone number of contact
|
||||
* identities : Array of dictionaries with key contactNumber and values listed below
|
||||
** trustLevel : String representation of trust level
|
||||
** dateAdded : String representation of date added
|
||||
** fingerprint : String representation of hexadecimal fingerprint
|
||||
** safetyNumber : String representation of safety number (10 or 11 space-separated six-digit numbers)
|
||||
|
||||
trust(number<s>, safetyNumber<s>) -> <>::
|
||||
* number : Phone number
|
||||
* safetyNumber : Verify the safety number associated with the phone number.
|
||||
|
||||
Exceptions: Failure, InvalidNumber
|
||||
|
||||
=== Other methods
|
||||
|
||||
listNumbers() -> numbers<as>::
|
||||
* 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)
|
||||
Returns an array of dictionaries for all contacts (obtained by listNumbers() and screened to exclude those with no identity information). For each dictionary, the key is the contactNumber and the value is a list of four strings: trustLevel, dateAdded, fingerprint, safetyNumber.
|
||||
|
||||
Exceptions: None
|
||||
|
||||
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
|
||||
listIdentities(contactNumber<s>) -> identity<{sv}>::
|
||||
* contactNumber : Phone number of contact
|
||||
* identity : Dictionary with key contactNumber and values listed below
|
||||
** trustLevel : String representation of trust level
|
||||
** dateAdded : String representation of date added
|
||||
** fingerprint : String representation of hexadecimal fingerprint
|
||||
** safetyNumber : String representation of safety number (10 or 11 space-separated six-digit numbers)
|
||||
|
||||
Exceptions: Failure, AttachmentInvalid
|
||||
Same as listIdentities(), but for one particular contact. Returns a dictionary where the key is the contactNumber and the value is a list of four strings: trustLevel, dateAdded, fingerprint, safetyNumber.
|
||||
|
||||
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: InvalidNumber
|
||||
|
||||
Exceptions: Failure
|
||||
trust(number<s>, safetyNumber<s>) -> <>::
|
||||
* number : Phone number
|
||||
* safetyNumber : String representation of safety number (10 or 11 space-separated six-digit numbers)
|
||||
|
||||
Verify the safety number associated with the phone number.
|
||||
|
||||
Exceptions: Failure, InvalidNumber
|
||||
|
||||
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()
|
||||
|
||||
getGroupName(groupId<ay>) -> groupName<s>::
|
||||
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
|
||||
|
||||
getGroupMembers(groupId<ay>) -> members<as>::
|
||||
members : String array with the phone numbers of all active members of a group
|
||||
groupId : Byte array representing the internal group identifier
|
||||
|
||||
Exceptions: None, if the group name is not found an empty array is returned
|
||||
|
||||
listNumbers() -> numbers<as>::
|
||||
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)
|
||||
|
||||
getContactNumber(name<s>) -> numbers<as>::
|
||||
* 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.
|
||||
|
||||
isContactBlocked(number<s>) -> state<b>::
|
||||
* number : Phone number
|
||||
* state : 1=blocked, 0=not blocked
|
||||
|
||||
Exceptions: None, for unknown numbers 0 (false) is returned
|
||||
|
||||
isGroupBlocked(groupId<ay>) -> state<b>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* state : 1=blocked, 0=not blocked
|
||||
|
||||
Exceptions: None, for unknown groups 0 (false) is returned
|
||||
|
||||
removePin() -> <>::
|
||||
|
||||
Removes registration PIN protection.
|
||||
|
||||
Exception: Failure
|
||||
|
||||
setPin(pin<s>) -> <>::
|
||||
* pin : PIN you set after registration (resets after 7 days of inactivity)
|
||||
|
||||
Sets a registration lock PIN, to prevent others from registering your number.
|
||||
|
||||
Exception: Failure
|
||||
|
||||
version() -> version<s>::
|
||||
* version : Version string of signal-cli
|
||||
|
||||
isRegistred -> result<b>::
|
||||
* result : Currently always returns 1=true
|
||||
|
||||
== Signals
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
The sync message is received when the user sends a message from a linked device.
|
||||
This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
|
||||
|
||||
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
|
||||
|
|
@ -375,66 +302,13 @@ 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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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/attachment1','/path/to/attachment2' 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/attachmnt1','/path/to/attachmnt2' 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`::
|
||||
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,8 +4,10 @@ import org.freedesktop.dbus.exceptions.DBusException;
|
|||
import org.freedesktop.dbus.exceptions.DBusExecutionException;
|
||||
import org.freedesktop.dbus.interfaces.DBusInterface;
|
||||
import org.freedesktop.dbus.messages.DBusSignal;
|
||||
import org.freedesktop.dbus.types.Variant;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* DBus interface for the org.asamk.Signal service.
|
||||
|
|
@ -63,7 +65,9 @@ public interface Signal extends DBusInterface {
|
|||
String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, byte[] groupId
|
||||
) throws Error.GroupNotFound, Error.Failure, Error.InvalidNumber, Error.InvalidGroupId;
|
||||
|
||||
List<String> listIdentity(String number) throws Error.InvalidNumber;
|
||||
List<Map<String, Variant<?>>> listIdentities();
|
||||
|
||||
Map<String, Variant<?>> listIdentities(String number) throws Error.InvalidNumber;
|
||||
|
||||
void trust(String number, String safetyNumber) throws Error.Failure, Error.InvalidNumber;
|
||||
|
||||
|
|
|
|||
|
|
@ -24,6 +24,7 @@ import org.asamk.signal.util.Util;
|
|||
import org.asamk.signal.util.Hex;
|
||||
|
||||
import org.freedesktop.dbus.exceptions.DBusExecutionException;
|
||||
import org.freedesktop.dbus.types.Variant;
|
||||
import org.whispersystems.libsignal.util.Pair;
|
||||
import org.whispersystems.libsignal.util.guava.Optional;
|
||||
import org.whispersystems.signalservice.api.groupsv2.GroupLinkNotActiveException;
|
||||
|
|
@ -36,6 +37,7 @@ import java.io.File;
|
|||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
|
|
@ -275,26 +277,38 @@ public class DbusSignalImpl implements Signal {
|
|||
}
|
||||
|
||||
@Override
|
||||
public List<String> listIdentity(String number) {
|
||||
public Map<String, Variant<?>> listIdentities(String number) {
|
||||
List<IdentityInfo> identities;
|
||||
IdentityInfo theirId;
|
||||
HashMap<String, Variant<?>> result = new HashMap<>();
|
||||
try {
|
||||
RecipientIdentifier.Single recipient = CommandUtil.getSingleRecipientIdentifier(number, m.getUsername());
|
||||
identities = m.getIdentities(recipient);
|
||||
} catch (UserErrorException e) {
|
||||
throw new Error.InvalidNumber("Invalid number: " + e.getMessage());
|
||||
}
|
||||
List<String> results = new ArrayList<String>();
|
||||
if (identities.isEmpty()) {return results;}
|
||||
theirId = identities.get(0);
|
||||
final SignalServiceAddress address = m.resolveSignalServiceAddress(theirId.getRecipientId());
|
||||
var safetyNumber = Util.formatSafetyNumber(m.computeSafetyNumber(address, theirId.getIdentityKey()));
|
||||
var scannableSafetyNumber = m.computeSafetyNumberForScanning(address, theirId.getIdentityKey());
|
||||
if (identities.isEmpty()) {return result;}
|
||||
IdentityInfo theirId = identities.get(0);
|
||||
|
||||
results.add(theirId.getTrustLevel().toString());
|
||||
results.add(theirId.getDateAdded().toString());
|
||||
results.add(Hex.toString(theirId.getFingerprint()));
|
||||
results.add(safetyNumber);
|
||||
final SignalServiceAddress address = m.resolveSignalServiceAddress(theirId.getRecipientId());
|
||||
String safetyNumber = Util.formatSafetyNumber(m.computeSafetyNumber(address, theirId.getIdentityKey()));
|
||||
result.put(number, new Variant<String[]>(new String[]{
|
||||
theirId.getTrustLevel().toString(),
|
||||
theirId.getDateAdded().toString(),
|
||||
Hex.toString(theirId.getFingerprint()),
|
||||
safetyNumber}));
|
||||
return result;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<Map<String, Variant<?>>> listIdentities() {
|
||||
List<String> numbers = listNumbers();
|
||||
List<Map<String, Variant<?>>> results = new ArrayList<>();
|
||||
for (String number:numbers) {
|
||||
Map<String, Variant<?>> identity = listIdentities(number);
|
||||
if (! identity.isEmpty()) {
|
||||
results.add(identity);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue