Skip to content

Commit afcea51

Browse files
Simon-LauxSeptias
andauthored
Document availability of realtime channels and how to test for it (#79)
* Document availability of realtime channels and how to test for it * Update src-docs/spec/joinRealtimeChannel.md Co-authored-by: Sebastian Klähn <[email protected]> --------- Co-authored-by: Sebastian Klähn <[email protected]>
1 parent 125a6ce commit afcea51

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src-docs/spec/joinRealtimeChannel.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ Per-app realtime channels are:
1818
Calling `joinRealtimeChannel` a second time without leaving the prior one
1919
will throw an error.
2020

21+
## Check if the API is available
22+
23+
This API is experimental and may not be implemented by every messenger yet.
24+
Check if it is available with `window.webxdc.joinRealtimeChannel !== undefined`
25+
26+
For Delta Chat, you need at least version 1.46 to enable the feature
27+
in the settings under `Settings -> Advanced -> Experimental Features -> Realtime Webxdc Channels`.
28+
Without enabling the feature, the API is available but not working.
29+
2130
## `realtimeChannel.setListener((data) => {})`
2231

2332
Start listening on the realtime channel using the specified callback.

0 commit comments

Comments
 (0)