Kaladaran/briar
0
0
Fork 0
mirror of https://code.briarproject.org/briar/briar.git synced 2026-02-17 21:29:54 +01:00
Code Issues Projects Releases Wiki Activity

Update REST API docs.

Browse Source
This commit is contained in:
akwizgran
2019-05-27 17:43:23 +01:00
parent 14e604e21e
commit f979d44c96
1 changed files with 7 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
briar-headless/README.md
View File

@@ -143,7 +143,7 @@ The following events are relevant here:
* `PendingContactAddedEvent` * `PendingContactAddedEvent`
* `PendingContactStateChangedEvent` * `PendingContactStateChangedEvent`
* `PendingContactRemovedEvent` * `PendingContactRemovedEvent`
* `ContactAddedRemotelyEvent` (when the pending contact becomes an actual contact) * `ContactAddedEvent` (when the pending contact becomes an actual contact)
To remove a pending contact and abort the process of adding it: To remove a pending contact and abort the process of adding it:
@@ -287,28 +287,15 @@ it will send a JSON object to connected websocket clients:
Note that the JSON object in `data` is exactly what the REST API returns Note that the JSON object in `data` is exactly what the REST API returns
when listing private messages. when listing private messages.
### A new contact was added remotely ### A new contact was added
When the Briar peer adds a new contact remotely,
it will send a JSON object representing the new contact to connected websocket clients:
```json ```json
{ {
"data": { "data": {
"contact": { "contactId": 1,
"author": { "verified": false
"formatVersion": 1,
"id": "y1wkIzAimAbYoCGgWxkWlr6vnq1F8t1QRA/UMPgI0E0=",
"name": "Test",
"publicKey": "BDu6h1S02bF4W6rgoZfZ6BMjTj/9S9hNN7EQoV05qUo="
},
"contactId": 1,
"alias" : "A local nickname",
"handshakePublicKey": "XnYRd7a7E4CTqgAvh4hCxh/YZ0EPscxknB9ZcEOpSzY=",
"verified": true
}
}, },
"name": "ContactAddedRemotelyEvent", "name": "ContactAddedEvent",
"type": "event" "type": "event"
} }
``` ```
@@ -334,8 +321,8 @@ it will send a JSON object representing the new contact to connected websocket c
```json ```json
{ {
"data": { "data": {
"pendingContactId":"YqKjsczCuxScXohb5+RAYtFEwK71icoB4ldztV2gh7M=", "pendingContactId": "YqKjsczCuxScXohb5+RAYtFEwK71icoB4ldztV2gh7M=",
"state":"waiting_for_connection" "state": "waiting_for_connection"
}, },
"name": "PendingContactStateChangedEvent", "name": "PendingContactStateChangedEvent",
"type": "event" "type": "event"