]> nmode's Git Repositories - signal-cli/blob - man/signal-cli-dbus.5.adoc
Fix null pointer regression
[signal-cli] / man / signal-cli-dbus.5.adoc
1 /////
2 vim:set ts=4 sw=4 tw=82 noet:
3 /////
4
5 :quotes.~:
6
7 = signal-cli-dbus (5)
8 :doctype: manpage
9
10 == Name
11
12 signal-cli-dbus - A commandline and dbus interface for the Signal messenger
13
14 == Synopsis
15
16 *signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] [-o {plain-text,json}] daemon [--dbus] [--dbus-system]
17
18 *dbus-send* [--system | --session] [--print-reply] --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal[/_<phonenumber>] org.asamk.Signal.<method> [string:<string argument>] [array:<type>:<array argument>]
19
20 Note: when daemon was started without explicit `-a ACCOUNT`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_<phonenumber>`.
21
22 == Description
23
24 See signal-cli (1) for details on the application.
25
26 This documentation handles the supported methods when running signal-cli as a DBus daemon.
27
28 The method are described as follows:
29
30 method(arg1<type>, arg2<type>, ...) -> return<type>
31
32 Where <type> is according to DBus specification:
33
34 * <a> : Array of ... (comma-separated list) (array:)
35 * (...) : Struct (cannot be sent via `dbus-send`)
36 * <b> : Boolean (false|true) (boolean:)
37 * <i> : Signed 32-bit (int) integer (int32:)
38 * <o> : DBusPath object (objpath:)
39 * <s> : String (string:)
40 * <x> : Signed 64-bit (long) integer (int64:)
41 * <y> : Unsigned 8-bit (byte) integer (byte:)
42 * <> : no return value
43
44 The final parenthetical value (such as "boolean:") is the type indicator used by `dbus-send`.
45
46 Exceptions are the names of the Java Exceptions returned in the body field.
47 They typically contain an additional message with details.
48 All Exceptions begin with "org.asamk.Signal.Error." which is omitted here for better readability.
49
50 Phone numbers always have the format +<countrycode><regional number>
51
52 == Methods
53
54 === SignalControl interface
55
56 These methods are available if the daemon is started in multi-account mode (without an explicit `-a ACCOUNT`).
57 The exported `/org/asamk/Signal` object provides a SignalControl interface, with methods to manage accounts.
58 Individual accounts are exported as separate objects and provide a Signal interface, that's described below.
59 e.g. `/org/asamk/Signal/\_441234567890` where the + dialing code is replaced by an underscore (_).
60
61 link() -> deviceLinkUri<s>::
62 link(newDeviceName<s>) -> deviceLinkUri<s>::
63 * newDeviceName : Name to give new device (defaults to "cli" if no name is given)
64 * deviceLinkUri : URI of newly linked device
65
66 Returns a URI of the form "sgnl://linkdevice?uuid=...".
67 This can be piped to a QR encoder to create a display that can be captured by a Signal smartphone client.
68
69 For example:
70
71 [source,bash]
72 ----
73 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
74 ----
75
76 listAccounts() -> accountList<as>::
77 * accountList : Array of all attached accounts in DBus object path form
78
79 Exceptions: None
80
81 register(number<s>, voiceVerification<b>) -> <>::
82 * number : Phone number
83 * voiceVerification : true = use voice verification; false = use SMS verification
84
85 Exceptions: Failure, InvalidNumber, RequiresCaptcha
86
87 registerWithCaptcha(number<s>, voiceVerification<b>, captcha<s>) -> <>::
88 * number : Phone number
89 * voiceVerification : true = use voice verification; false = use SMS verification
90 * captcha : Captcha string
91
92 Exceptions: Failure, InvalidNumber, RequiresCaptcha
93
94 verify(number<s>, verificationCode<s>) -> <>::
95 * number : Phone number
96 * verificationCode : Code received from Signal after successful registration request
97
98 Command fails if PIN was set after previous registration; use verifyWithPin instead.
99
100 Exceptions: Failure, InvalidNumber
101
102 verifyWithPin(number<s>, verificationCode<s>, pin<s>) -> <>::
103 * number : Phone number
104 * verificationCode : Code received from Signal after successful registration request
105 * pin : PIN you set with setPin command after verifying previous registration
106
107 Exceptions: Failure, InvalidNumber
108
109 version() -> version<s>::
110 * version : Version string of signal-cli
111
112 Exceptions: None
113
114 === Signal interface
115
116 The following methods listen to the account's object path, which is constructed as follows:
117
118 - for single-account mode: "/org/asamk/Signal/"
119 - for multi-account mode: "/org/asamk/Signal/" + DBusNumber
120 * DBusNumber: account's phone number, with underscore (_) replacing plus (+)
121
122 getContactName(number<s>) -> name<s>::
123 * number : Phone number
124 * name : Contact's name in local storage (from the primary device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
125
126 Exceptions: None
127
128 getContactNumber(name<s>) -> numbers<as>::
129 * numbers : Array of phone number
130 * name : Contact or profile name ("firstname lastname")
131
132 Searches contacts and known profiles for a given name and returns the list of all known numbers.
133 May result in e.g. two entries if a contact and profile name is set.
134
135 Exceptions: None
136
137 getSelfNumber() -> number<s>::
138 * number : Your phone number
139
140 Exceptions: None
141
142 isContactBlocked(number<s>) -> blocked<b>::
143 * number : Phone number
144 * blocked : true=blocked, false=not blocked
145
146 For unknown numbers false is returned but no exception is raised.
147
148 Exceptions: InvalidPhoneNumber
149
150 isRegistered() -> result<b>::
151 isRegistered(number<s>) -> result<b>::
152 isRegistered(numbers<as>) -> results<ab>::
153 * number : Phone number
154 * numbers : String array of phone numbers
155 * result : true=number is registered, false=number is not registered
156 * results : Boolean array of results
157
158 For unknown numbers, false is returned, but no exception is raised.
159 If no number is given, returns true (indicating that you are registered).
160
161 Exceptions: InvalidNumber
162
163 listNumbers() -> numbers<as>::
164 * numbers : String array of all known numbers
165
166 This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages)
167
168 Exceptions: None
169
170 removePin() -> <>::
171
172 Removes registration PIN protection.
173
174 Exceptions: Failure
175
176 sendEndSessionMessage(recipients<as>) -> <>::
177 * recipients : Array of phone numbers
178
179 Exceptions: Failure, InvalidNumber, UntrustedIdentity
180
181 sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
182 sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
183 * message : Text to send (can be UTF8)
184 * 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)
185 * recipient : Phone number of a single recipient
186 * recipients : String array of phone numbers
187 * timestamp : Long, can be used to identify the corresponding Signal reply
188
189 Depending on the type of the recipient field this sends a message to one or multiple recipients.
190
191 Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
192
193 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
194 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
195 * emoji : Unicode grapheme cluster of the emoji
196 * remove : Boolean, whether a previously sent reaction (emoji) should be removed
197 * targetAuthor : String with the phone number of the author of the message to which to react
198 * targetSentTimestamp : Long representing timestamp of the message to which to react
199 * recipient : String with the phone number of a single recipient
200 * recipients : Array of strings with phone numbers, should there be more recipients
201 * timestamp : Long, can be used to identify the corresponding Signal reply
202
203 Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients.
204
205 Exceptions: Failure, InvalidNumber
206
207 sendPaymentNotification(receipt<ay>, note<s>, recipient<s>) -> timestamp<x>::
208 * receipt : Byte array with the payment receipt blob
209 * note : String with a note for the payment
210 * recipient : String with the phone number of a single recipient
211
212 * timestamp : Long, can be used to identify the corresponding Signal reply
213
214 Exceptions: Failure
215
216 sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
217 * message : Text to send (can be UTF8)
218 * 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)
219 * timestamp : Long, can be used to identify the corresponding Signal reply
220
221 Exceptions: Failure, AttachmentInvalid
222
223 sendReadReceipt(recipient<s>, targetSentTimestamps<ax>) -> <>::
224 * recipient : Phone number of a single recipient
225 * targetSentTimestamps : Array of Longs to identify the corresponding Signal messages
226
227 Exceptions: Failure, UntrustedIdentity
228
229 sendViewedReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
230 * recipient : Phone number of a single recipient
231 * targetSentTimestamp : Array of Longs to identify the corresponding signal messages
232
233 Exceptions: Failure, UntrustedIdentity
234
235 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
236 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
237 * targetSentTimestamp : Long representing timestamp of the message to delete
238 * recipient : String with the phone number of a single recipient
239 * recipients : Array of strings with phone numbers, should there be more recipients
240 * timestamp : Long, can be used to identify the corresponding signal reply
241
242 Depending on the type of the recipient(s) field this deletes a message with one or multiple recipients.
243
244 Exceptions: Failure, InvalidNumber
245
246 sendTyping(recipient<s>, stop<b>) -> <>::
247 * recipient : Phone number of a single recipient
248 * stop : True, if typing state should be stopped
249
250 Exceptions: Failure, UntrustedIdentity
251
252 setContactBlocked(number<s>, block<b>) -> <>::
253 * number : Phone number affected by method
254 * block : false=remove block, true=blocked
255
256 Messages from blocked numbers will no longer be forwarded via DBus.
257
258 Exceptions: InvalidNumber
259
260 setContactName(number<s>,name<>) -> <>::
261 * number : Phone number
262 * name : Name to be set in contacts (in local storage with signal-cli)
263
264 Exceptions: InvalidNumber, Failure
265
266 deleteContact(number<s>) -> <>::
267 * number : Phone number
268
269 Exceptions: Failure
270
271 deleteRecipient(number<s>) -> <>::
272 * number : Phone number
273
274 Exceptions: Failure
275
276 setExpirationTimer(number<s>, expiration<i>) -> <>::
277 * number : Phone number of recipient
278 * expiration : int32 for the number of seconds before messages to this recipient disappear.
279 Set to 0 to disable expiration.
280
281 Exceptions: Failure, InvalidNumber
282
283 setPin(pin<s>) -> <>::
284 * pin : PIN you set after registration (resets after 7 days of inactivity)
285
286 Sets a registration lock PIN, to prevent others from registering your number.
287
288 Exceptions: Failure
289
290 submitRateLimitChallenge(challenge<s>, captcha<s>) -> <>::
291 * challenge : The challenge token taken from the proof required error.
292 * captcha : The captcha token from the solved captcha on the Signal website.
293 Can be used to lift some rate-limits by solving a captcha.
294
295 Exception: IOErrorException
296
297 updateProfile(name<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
298 updateProfile(givenName<s>, familyName<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
299 * name : Name for your own profile (empty if unchanged)
300 * givenName : Given name for your own profile (empty if unchanged)
301 * familyName : Family name for your own profile (empty if unchanged)
302 * about : About message for profile (empty if unchanged)
303 * aboutEmoji : Emoji for profile (empty if unchanged)
304 * avatar : Filename of avatar picture for profile (empty if unchanged)
305 * remove : Set to true if the existing avatar picture should be removed
306
307 Exceptions: Failure
308
309 uploadStickerPack(stickerPackPath<s>) -> url<s>::
310 * stickerPackPath : Path to the manifest.json file or a zip file in the same directory
311 * url : URL of sticker pack after successful upload
312
313 Exceptions: Failure
314
315 version() -> version<s>::
316 * version : Version string of signal-cli
317
318 Exceptions: None
319
320 ==== Group related methods
321
322 createGroup(groupName<s>, members<as>, avatar<s>) -> groupId<ay>::
323 * groupName : String representing the display name of the group
324 * members : String array of new members to be invited to group
325 * avatar : Filename of avatar picture to be set for group (empty if none)
326 * groupId : Byte array representing the internal group identifier
327
328 Exceptions: AttachmentInvalid, Failure, InvalidNumber;
329
330 getGroup(groupId<ay>) -> objectPath<o>::
331 * groupId : Byte array representing the internal group identifier
332 * objectPath : DBusPath for the group
333
334 getGroupMembers(groupId<ay>) -> members<as>::
335 * groupId : Byte array representing the internal group identifier
336 * members : String array with the phone numbers of all active members of a group
337
338 Exceptions: None, if the group name is not found an empty array is returned
339
340 joinGroup(inviteURI<s>) -> <>::
341 * inviteURI : String starting with https://signal.group/#
342
343 Behavior of this method depends on the `requirePermission` parameter of the `enableLink` method.
344 If permission is required, `joinGroup` adds you to the requesting members list.
345 Permission may be granted based on the group's `PermissionAddMember` property (`ONLY_ADMINS` or `EVERY_MEMBER`).
346 If permission is not required, `joinGroup` admits you immediately to the group.
347
348 Exceptions: Failure
349
350 listGroups() -> groups<a(oays)>::
351 * groups : Array of Structs(objectPath, groupId, groupName)
352 ** objectPath : DBusPath
353 ** groupId : Byte array representing the internal group identifier
354 ** groupName : String representing the display name of the group
355
356 sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
357 * message : Text to send (can be UTF8)
358 * 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)
359 * groupId : Byte array representing the internal group identifier
360 * timestamp : Long, can be used to identify the corresponding Signal reply
361
362 Exceptions: GroupNotFound, Failure, AttachmentInvalid, InvalidGroupId
363
364 sendGroupTyping(groupId<ay>, stop<b>) -> <>::
365 * groupId : Byte array representing the internal group identifier
366 * stop : True, if typing state should be stopped
367
368 Exceptions: Failure, GroupNotFound, UntrustedIdentity
369
370 sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
371 * emoji : Unicode grapheme cluster of the emoji
372 * remove : Boolean, whether a previously sent reaction (emoji) should be removed
373 * targetAuthor : String with the phone number of the author of the message to which to react
374 * targetSentTimestamp : Long representing timestamp of the message to which to react
375 * groupId : Byte array representing the internal group identifier
376 * timestamp : Long, can be used to identify the corresponding signal reply
377
378 Exceptions: Failure, InvalidNumber, GroupNotFound, InvalidGroupId
379
380 sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
381 * targetSentTimestamp : Long representing timestamp of the message to delete
382 * groupId : Byte array with base64 encoded group identifier
383 * timestamp : Long, can be used to identify the corresponding signal reply
384
385 Exceptions: Failure, GroupNotFound, InvalidGroupId
386
387 ==== Device related methods
388
389 addDevice(deviceUri<s>) -> <>::
390 * 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.
391
392 getDevice(deviceId<x>) -> devicePath<o>::
393 * deviceId : Long representing a deviceId
394 * devicePath : DBusPath object for the device
395
396 Exceptions: DeviceNotFound
397
398 listDevices() -> devices<a(oxs)>::
399 * devices : Array of structs (objectPath, id, name)
400 ** objectPath : DBusPath representing the device's object path
401 ** id : Long representing the deviceId
402 ** name : String representing the device's name
403
404 Exceptions: InvalidUri
405
406 sendContacts() -> <>::
407
408 Sends a synchronization message with the local contacts list to all linked devices.
409 This command should only be used if this is the primary device.
410
411 Exceptions: Failure
412
413 sendSyncRequest() -> <>::
414
415 Sends a synchronization request to the primary device (for group, contacts, ...).
416 Only works if sent from a secondary device.
417
418 Exceptions: Failure
419
420 ==== Identity related methods
421
422 listIdentities() -> identities<a(oss)>::
423 * identities : Array of structs (objectPath, id, name)
424 ** objectPath : DBusPath representing the identity object path
425 ** uuid : Internal uuid of the identity
426 ** number : Phone number of the identity
427
428 Lists all know identities
429
430 getIdentity(Number<s>) -> identityPath<o>::
431 * Number : Phone number
432 * identityPath : DBusPath object for the identity
433
434 Gets the identity Dbus path for a given phone number
435
436 Exceptions: Failure
437
438 === Signal.Group interface
439
440 The following methods listen to the group's object path, which can be obtained from the listGroups() method and is constructed as follows:
441
442 <ACCOUNT_PATH> + "/Groups/" + DBusGroupId
443
444 DBusGroupId : groupId in base64 format, with underscore (_) replacing plus (+), equals (=), or slash (/)
445
446 Groups have the following (case-sensitive) properties:
447
448 * Id<ay> (read-only) : Byte array representing the internal group identifier
449 * Name<s> : Display name of the group
450 * Description<s> : Description of the group
451 * Avatar<s> (write-only) : Filename of the avatar
452 * IsBlocked<b> : true=member will not receive group messages; false=not blocked
453 * IsMember<b> (read-only) : always true (object path exists only for group members)
454 * IsAdmin<b> (read-only) : true=member has admin privileges; false=not admin
455 * MessageExpirationTimer<i> : int32 representing message expiration time for group
456 * Members<as> (read-only) : String array of group members' phone numbers
457 * PendingMembers<as> (read-only) : String array of pending members' phone numbers
458 * RequestingMembers<as> (read-only) : String array of requesting members' phone numbers
459 * Admins<as> (read-only) : String array of admins' phone numbers
460 * PermissionAddMember<s> : String representing who has permission to add members *ONLY_ADMINS, EVERY_MEMBER*
461 * PermissionEditDetails<s> : String representing who may edit group details *ONLY_ADMINS, EVERY_MEMBER*
462 * PermissionSendMessage<s> : String representing who post messages to group *ONLY_ADMINS, EVERY_MEMBER* (note that ONLY_ADMINS is equivalent to IsAnnouncementGroup)
463 * GroupInviteLink<s> (read-only) : String of the invitation link (starts with https://signal.group/#)
464
465 To get a property, use (replacing `--session` with `--system` if needed):
466 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Group string:$PROPERTY_NAME`
467
468 To set a property, use:
469 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Group string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE`
470
471 To get all properties, use:
472 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Group`
473
474 addAdmins(recipients<as>) -> <>::
475 * recipients : String array of phone numbers
476
477 Grant admin privileges to recipients.
478
479 Exceptions: Failure
480
481 addMembers(recipients<as>) -> <>::
482 * recipients : String array of phone numbers
483
484 Add recipients to group if they are pending members; otherwise add recipients to list of requesting members.
485 This command is also used to accept group invitations by adding yourself to a group.
486
487 Exceptions: Failure
488
489 disableLink() -> <>::
490
491 Disables the group's invitation link.
492
493 Exceptions: Failure
494
495 enableLink(requiresApproval<b>) -> <>::
496 * requiresApproval : true=add numbers using the link to the requesting members list
497
498 Enables the group's invitation link.
499
500 Exceptions: Failure
501
502 quitGroup() -> <>::
503 Exceptions: Failure, LastGroupAdmin
504
505 removeAdmins(recipients<as>) -> <>::
506 * recipients : String array of phone numbers
507
508 Remove admin privileges from recipients.
509
510 Exceptions: Failure
511
512 removeMembers(recipients<as>) -> <>::
513 * recipients : String array of phone numbers
514
515 Remove recipients from group.
516
517 Exceptions: Failure
518
519 resetLink() -> <>::
520
521 Resets the group's invitation link to a new random URL starting with https://signal.group/#
522
523 Exceptions: Failure
524
525 === Signal.Device interface
526
527 The following methods listen to the device's object path, which is constructed as follows:
528
529 <ACCOUNT_PATH> + "/Devices/" + deviceId
530
531 deviceId : Number representing the device identifier (obtained from listDevices() method)
532
533 Devices have the following (case-sensitive) properties:
534
535 * Id<x> (read-only) : Long representing the device identifier
536 * Created<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
537 * LastSeen<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
538 * Name<s> : String representing the display name of the device
539
540 To get a property, use (replacing `--session` with `--system` if needed):
541 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Device string:$PROPERTY_NAME`
542
543 To set a property, use:
544 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Device string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE`
545
546 To get all properties, use:
547 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Device`
548
549 removeDevice() -> <>::
550
551 Exceptions: Failure
552
553 === Signal.Identity interface
554
555 The following methods listen to the Identities object path, which is constructed as follows:
556
557 <ACCOUNT_PATH> + "/Identities/" + identity
558
559 identity : Either the phone number of a contact with underscore (_) replacing plus (+) , or if not known its uuid
560
561 Identities have the following (case-sensitive) properties:
562
563 * Number<s> (read-only) : Phone number of the contact
564 * Uuid<x> (read-only) : Internal uuid representing the contact
565 * Fingerprint<x> (read-only) : Byte array representing the fingerprint
566 * SafetyNumber<s> (read-only) : String representation of the safety number used to verify trust
567 * TrustLevel<s> (read-only) : Current trust level (UNSTRUSTED, TRUSTED_UNVERIFIED, TRUSTED_VERIFIED)
568 * AddedDate<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
569 * ScannableSafetyNumber<x> (read-only) : Byte array representation of the safety number
570
571 To get a property, use (replacing `--session` with `--system` if needed):
572 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Identity string:$PROPERTY_NAME`
573
574 To get all properties, use:
575 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Identity`
576
577 trust() -> <>::
578
579 Establish trust with the given identity.
580 TrustLevel will become TRUSTED_UNVERFIED
581
582 Exceptions: Failure
583
584 trustVerified(SafetyNumber<s>) -> <>::
585
586 Establish trust with the given identity using their safety number.
587 TrustLevel will become TRUSTED_VERIFIED
588
589 Exceptions: Failure
590
591 === Signal.Configuration interface
592
593 The configuration's object path, which exists only for primary devices, is constructed as follows:
594 <ACCOUNT_PATH> + "/Configuration"
595
596 Configurations have the following (case-sensitive) properties:
597
598 * ReadReceipts<b> : should send read receipts (true/false)
599 * UnidentifiedDeliveryIndicators<b> : should show unidentified delivery indicators (true/false)
600 * TypingIndicators<b> : should send/show typing indicators (true/false)
601 * LinkPreviews<b> : should generate link previews (true/false)
602
603 To get a property, use (replacing `--session` with `--system` if needed):
604 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Configuration string:$PROPERTY_NAME`
605
606 To set a property, use:
607 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Configuration string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE`
608
609 To get all properties, use:
610 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Configuration`
611
612 == Signals
613
614 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>, message<s>, attachments<as>)::
615 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
616 * sender : Phone number of the sender
617 * destination : DBus code for destination
618 * groupId : Byte array representing the internal group identifier (empty when private message)
619 * message : Message text
620 * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/)
621
622 The sync message is received when the user sends a message from a linked device.
623
624 ReceiptReceived (timestamp<x>, sender<s>)::
625 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
626 * sender : Phone number of the sender
627
628 This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
629
630 MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
631 * timestamp : Integer value that is used by the system to send a ReceiptReceived reply
632 * sender : Phone number of the sender
633 * groupId : Byte array representing the internal group identifier (empty when private message)
634 * message : Message text
635 * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/)
636
637 This signal is received whenever we get a private message or a message is posted in a group we are an active member
638
639 == Examples
640
641 Send a text message (without attachment) to a contact::
642 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
643
644 Send a group message::
645 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
646
647 Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-a ACCOUNT`::
648 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
649
650 == Authors
651
652 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
653 For more information about signal-cli development, see
654 <https://github.com/AsamK/signal-cli>.