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