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