mirror of
https://github.com/AsamK/signal-cli
synced 2025-09-02 12:30:39 +00:00
Added DBus manpage
This commit is contained in:
Adimarantis
parent
dbd1d78efd
commit
f23ddd4310
1 changed files with 205 additions and 0 deletions
205
man/signal-cli-dbus.3.adoc
Executable file
205
man/signal-cli-dbus.3.adoc
Executable file
|
|
@ -0,0 +1,205 @@
|
|||
/////
|
||||
vim:set ts=4 sw=4 tw=82 noet:
|
||||
/////
|
||||
:quotes.~:
|
||||
|
||||
= signal-cli-dbus (3)
|
||||
|
||||
== Name
|
||||
|
||||
DBus API for signal-cli - A commandline and dbus interface for the Signal messenger
|
||||
|
||||
== Synopsis
|
||||
|
||||
*signal-cli* [--config CONFIG] daemon --dbus-system
|
||||
|
||||
*dbus-send* --system --type=method_call --print-reply --dest="org.asamk.Signal" /org/asamk/Signal org.asamk.Signal<method> [string:<string argument>] [array:<type>:<array argument>]
|
||||
|
||||
|
||||
== Description
|
||||
|
||||
See signal-cli (1) for details on the application.
|
||||
|
||||
This documentation handles the supported methods when running signal-cli as a DBus daemon.
|
||||
|
||||
The method are described as follows:
|
||||
|
||||
Return<type> = Method( arg1<type>, arg2<type>, ...)
|
||||
|
||||
Where type are according to DBus specification:
|
||||
|
||||
* <s> : String
|
||||
* <ay> : Byte Array
|
||||
* <aay> : Array of Byte Arrays
|
||||
* <as> : String Array
|
||||
* <b> : Boolean (0|1)
|
||||
* <x> : Signed 64 bit integer
|
||||
* <> : 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.
|
||||
|
||||
Phone numbers always have the format +<countrycode><regional number>
|
||||
|
||||
== Methods
|
||||
|
||||
groupID<ay> = updateGroup( groupID<ay>, new name<s>, members<as>,avatar<s>)::
|
||||
* groupID : Byte array representing the internal group identifier
|
||||
* new name : 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)
|
||||
|
||||
Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
|
||||
|
||||
<> = updateProfile(new name<s>,about <s>,aboutEmoji <s>,avatar<s>,remove<b>)::
|
||||
* new name : 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 picutre for profile (empty if unchanged)
|
||||
* remove : Set to 1 if the existing avatar picture should be removed
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
<> = setContactBlocked(number<s>, block<b>)::
|
||||
* number : Phone number affected by method
|
||||
* block : 0=remove block , 1=blocked
|
||||
|
||||
Messages from blocked numbers will no longer be forwarded via DBus.
|
||||
|
||||
Exceptions: InvalidNumber
|
||||
|
||||
<> = setGroupBlocked(groupID<ay>, block<b>)::
|
||||
* 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.
|
||||
|
||||
Exceptions: GroupNotFound
|
||||
|
||||
<> = joinGroup(inviteURI<s>)::
|
||||
* inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
<> = quitGroup(groupID<ay>)::
|
||||
* 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
|
||||
|
||||
active<b> isMember(groupID<ay>)::
|
||||
* groupID : Byte array representing the internal group identifier
|
||||
|
||||
Note that this method 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
|
||||
|
||||
timestamp<x> = sendGroupMessage(message<s>, attachments<as>, groupID<a>)::
|
||||
* 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
|
||||
|
||||
timestamp<> = sendNoteToSelfMessage(message<s>, attachments<as>)::
|
||||
* 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, AttachmentInvalid
|
||||
|
||||
timestamp<x> = sendMessage(message<s>, attachments<as>, recipient<s)::
|
||||
timestamp<x> = sendMessage(message<s>, attachments<as>, recipients<as>)::
|
||||
* 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
|
||||
* 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.
|
||||
|
||||
Expections: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
|
||||
|
||||
name<s> = getContactName(number<s>)::
|
||||
* number : Phone number
|
||||
* name : Name set in contacts (setContacts) or if not set the profile name
|
||||
|
||||
<> = setContactName(number<s>,name<>)::
|
||||
* number : Phone number
|
||||
* name : Name to be set in contacts (in local storage with signal-cli)
|
||||
|
||||
groupList<aay> getGroupIds()::
|
||||
groupList : Array of Byte arrays representing the internal group identifiers
|
||||
|
||||
All groups known are returned, regardsless of their active or blocked status. To query that use isMember() and isGroupBlocked()
|
||||
|
||||
groupName<> getGroupName(groupId<ay>)::
|
||||
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
|
||||
|
||||
members<as> getGroupMembers(groupId<ay>)::
|
||||
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
|
||||
|
||||
numbers<as> listNumbers()::
|
||||
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)
|
||||
|
||||
numbers<as> getContactNumber(name<s>)::
|
||||
* numbers : Array of phone number
|
||||
* name : Contact or profile name ("firstname lastname")
|
||||
|
||||
Searches contacts and know profiles for a given name and returns the list of all known names. May result in e.g. two entries if a contact and profile name is set.
|
||||
|
||||
state<b> isContactBlocked(number<s>)::
|
||||
* number : Phone number
|
||||
* state : 1=blocked, 0=not blocked
|
||||
|
||||
Exceptions: None, for unknown numbers 0 (false) is returned
|
||||
|
||||
state<b> isGroupBlocked(groupId<ay>)::
|
||||
* groupID : Byte array representing the internal group identifier
|
||||
* state : 1=blocked, 0=not blocked
|
||||
|
||||
Exceptions: None, for unknown groups 0 (false) is returned
|
||||
|
||||
version<s> version()::
|
||||
* version : Version string of signal-cli
|
||||
|
||||
result<b> isRegistred::
|
||||
* result : Currently always returns 1=true
|
||||
|
||||
== Signals
|
||||
|
||||
SyncMessageReceived (timestamp<x>,sender<s>,destination<s>,groupId<ay>,message<s>,attachments<as>)::
|
||||
Currently not used
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
* sender : Phone number of the sender
|
||||
* groupID : Byte array representing the internal group identifier (empty when private message)
|
||||
* message : Message text
|
||||
* attachments : String array of filenames for the attachments. These files are located in the signal-cli storage and the current user needs to have read access there
|
||||
|
||||
This signal is received whenever we get a private message or a message is posted in a group we are an active member
|
||||
|
||||
== Authors
|
||||
|
||||
Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
|
||||
For more information about signal-cli development, see
|
||||
<https://github.com/AsamK/signal-cli>.
|
||||
Loading…
Add table
Add a link
Reference in a new issue