Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-04-17 21:46:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

swap paramters in sendUpdate(); the 'descr' may be split up in the future, so it makes sense to have that at the end

Browse Source
This commit is contained in:
B. Petersen
2022-01-06 17:37:25 +01:00
committed by bjoern
parent 14e9afaf42
commit 8c2ea0fa26
5 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -21,15 +21,15 @@ no need to add `webxdc.js` to your ZIP-file):
### sendUpdate()
```js
window.webxdc.sendUpdate(descr, payload);
window.webxdc.sendUpdate(payload, descr);
```
Webxdc apps are usually shared in a chat and run independently on each peer.
To get a shared state, the peers use `sendUpdate()` to send updates to each other.
- `payload`: any javascript primitive, array or object.
- `descr`: short, human-readable description what this update is about.
this is shown eg. as a fallback text in an email program.
- `payload`: any javascript primitive, array or object.
All peers, including the sending one,
will receive the update by the callback given to `setUpdateListener()`.
@@ -130,7 +130,7 @@ The following example shows an input field and every input is show on all peers
function sendMsg() {
msg = document.getElementById("input").value;
window.webxdc.sendUpdate('Someone typed "'+msg+'".', msg);
window.webxdc.sendUpdate(msg, 'Someone typed "'+msg+'".');
}
function receiveUpdate(update) {