Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-03 05:16:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

update dev-reference to reflect new promise feature for setup (#3220)

Browse Source 
* update dev-reference

* Update draft/webxdc-dev-reference.md

Co-authored-by: holger krekel  <holger@merlinux.eu>

* Update draft/webxdc-dev-reference.md

Co-authored-by: Simon Laux <Simon-Laux@users.noreply.github.com>
Co-authored-by: holger krekel  <holger@merlinux.eu>
This commit is contained in:
Sebastian Klähn
2022-04-19 15:43:05 +02:00
committed by GitHub
parent a8cf05ea5d
commit 8b2b9e1093
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
draft/webxdc-dev-reference.md
View File

@@ -54,12 +54,13 @@ and you won't get the update by `setUpdateListener()`.
### setUpdateListener() ### setUpdateListener()
```js ```js
window.webxdc.setUpdateListener((update) => {}, serial); window.webxdc.setUpdateListener((update) => {}, serial) -> Promise<void>;
``` ```
With `setUpdateListener()` you define a callback that receives the updates With `setUpdateListener()` you define a callback that receives the updates
sent by `sendUpdate()`. The callback is called for updates sent by you or other peers. sent by `sendUpdate()`. The callback is called for updates sent by you or other peers.
The `serial` specifies the last serial that you know about (defaults to 0). The `serial` specifies the last serial that you know about (defaults to 0).
The returned promise resolves when the listener has processed all the update messages known at the time when `setUpdateListener` was called.
Each `update` which is passed to the callback comes with the following properties: Each `update` which is passed to the callback comes with the following properties: