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

some refinements

Browse Source
This commit is contained in:
holger krekel
2022-01-14 11:30:29 +01:00
parent c9a70f149d
commit 87fba3edbb
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,7 +2,9 @@
## Webxdc File Format ## Webxdc File Format
- a **Webxdc app** is a **ZIP-file** with the extension `.xdc` - a **Webxdc app** or **XDC app** is a **ZIP-file** with the extension `.xdc`
- They are send (as attachment) to a chat and run independently on
each receiving and sending peer.
- the ZIP-file must contain at least the file `index.html` - the ZIP-file must contain at least the file `index.html`
- if the Webxdc app is started, `index.html` is opened in a restricted webview - if the Webxdc app is started, `index.html` is opened in a restricted webview
that allow accessing resources only from the ZIP-file that allow accessing resources only from the ZIP-file
@@ -24,12 +26,12 @@ no need to add `webxdc.js` to your ZIP-file):
window.webxdc.sendUpdate(payload, descr); window.webxdc.sendUpdate(payload, descr);
``` ```
Webxdc apps are usually shared in a chat and run independently on each peer. webxdc app instances (on each peer) use `sendUpdate()` to share state updates with each other.with an object containing:
To get a shared state, the peers use `sendUpdate()` to send updates to each other.
- `payload`: any javascript primitive, array or object. - `payload`: any javascript primitive, array or object.
- `descr`: short, human-readable description what this update is about. - `descr`: short, human-readable description what this state update is about.
this is shown eg. as a fallback text in an email program. this is shown eg. as a fallback text if the receiving peer
lacks capabilities to run webxdc apps safely.
All peers, including the sending one, All peers, including the sending one,
will receive the update by the callback given to `setUpdateListener()`. will receive the update by the callback given to `setUpdateListener()`.
@@ -41,12 +43,12 @@ window.webxdc.setUpdateListener((update) => {});
``` ```
With `setUpdateListener()` you define a callback that receives the updates With `setUpdateListener()` you define a callback that receives the updates
sent by `sendUpdate()`. sent by `sendUpdate()`:
- `update`: passed to the callback on updates. - `update`: passed to the callback on updates.
- `update.payload`: equals the payload given to `sendUpdate()` - `update.payload`: equals the payload given to `sendUpdate()`
The callback is called for updates sent by you or other peers. The callback is called for state updates sent by you or other peers's app instances.
### getAllUpdates() ### getAllUpdates()
@@ -154,4 +156,4 @@ For a more advanved example, see https://github.com/r10s/webxdc-poll/ .
you may want to transpile your code down to an older js version eg. with https://babeljs.io you may want to transpile your code down to an older js version eg. with https://babeljs.io
- there are tons of ideas for enhancements of the API and the file format, - there are tons of ideas for enhancements of the API and the file format,
eg. in the future, we will may define icon- and manifest-files, eg. in the future, we will may define icon- and manifest-files,
allow to aggregate the state or add metadata. allow to aggregate the state or add metadata.