Bram
/
elm-matrix-sdk-alpha
mirror of https://github.com/noordstar/elm-matrix-sdk-alpha
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

pull/1/head
Bram van den Heuvel 2023-03-24 14:19:25 +01:00
parent bf2cf7395a
commit 4de93e9039
1 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
src/Internal/Api/README.md
View File

@ -10,7 +10,7 @@ The icons have the following meaning:
- ✔️ = Supported
- ⚠️ = To be announced
- ⚡ = Under development - coming soon
- ⚡ = Under development
- ❌ = Not supported by SDK
- ⛔ = Not supported by spec
@ -38,43 +38,43 @@ Note that **under development** doesn't always mean that it _will be_ supported.
## Changing room member status
| **Spec version** | | Inviting | Joining room id | Leaving room |
| ---------------- | - | -------- | --------------- | ------------ |
| v1.6 || ✔️ | ✔️ | ✔️ |
| v1.5 || ✔️ | ✔️ | ✔️ |
| v1.4 || ✔️ | ✔️ | ✔️ |
| v1.3 || ✔️ | ✔️ | ✔️ |
| v1.2 || ✔️ | ✔️ | ✔️ |
| v1.1 || ✔️ | ✔️ | ✔️ |
| r0.6.1 || ✔️ | ✔️ | ✔️ |
| r0.6.0 || ✔️ | ✔️ | ✔️ |
| r0.5.0 || ✔️ | ✔️ | ✔️ |
| r0.4.0 || ✔️ | ✔️ | ✔️ |
| r0.3.0 || ✔️ | ✔️ | ✔️ |
| r0.2.0 || ✔️ | ✔️ | ✔️ |
| r0.1.0 || ✔️ | ✔️ | ✔️ |
| r0.0.1 || ✔️ | ✔️ | ✔️ |
| r0.0.0 || ✔️ | ✔️ | ✔️ |
| **Spec version** | | Inviting | Joining room id | Leaving room | Kick user | Ban user |
| ---------------- | - | -------- | --------------- | ------------ | --------- | -------- |
| v1.6 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| v1.5 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| v1.4 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| v1.3 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| v1.2 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| v1.1 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.6.1 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.6.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.5.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.4.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.3.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.2.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.1.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.0.1 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
| r0.0.0 || ✔️ | ✔️ | ✔️ | ⚡ | ✔️ |
## Getting events for a room
| **Spec version** | | Event | Joined members | Members | Current state | State event | Event at timestamp |
| ---------------- | - | ----- | -------------- | ------- | ------------ | ----------- | ------------------ |
| v1.6 || ✔️ | ✔️ | ⚡ | ⚡ | ⚡ | ⚠️ |
| v1.5 || ✔️ | ✔️ | ⚡ | ⚡ | ⚡ | ⛔ |
| v1.4 || ✔️ | ✔️ | ⚡ | ⚡ | ⚡ | ⛔ |
| v1.3 || ✔️ | ✔️ | ⚡ | ⚡ | ⚡ | ⛔ |
| v1.2 || ✔️ | ✔️ | ⚡ | ⚡ | ⚡ | ⛔ |
| v1.1 || ✔️ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.6.1 || ✔️ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.6.0 || ✔️ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.5.0 || ✔️ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.4.0 || ⛔ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.3.0 || ⛔ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.2.0 || ⛔ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.1.0 || ⛔ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.0.1 || ⛔ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| r0.0.0 || ⛔ | ✔️ | ⚠️ | ⚠️ | ⚠️ | ⛔ |
| **Spec version** | | Event | Joined members | Event at timestamp |
| ---------------- | - | ----- | -------------- | ------------------ |
| v1.6 || ✔️ | ✔️ | ⚠️ |
| v1.5 || ✔️ | ✔️ | ⛔ |
| v1.4 || ✔️ | ✔️ | ⛔ |
| v1.3 || ✔️ | ✔️ | ⛔ |
| v1.2 || ✔️ | ✔️ | ⛔ |
| v1.1 || ✔️ | ✔️ | ⛔ |
| r0.6.1 || ✔️ | ✔️ | ⛔ |
| r0.6.0 || ✔️ | ✔️ | ⛔ |
| r0.5.0 || ✔️ | ✔️ | ⛔ |
| r0.4.0 || ⛔ | ✔️ | ⛔ |
| r0.3.0 || ⛔ | ✔️ | ⛔ |
| r0.2.0 || ⛔ | ✔️ | ⛔ |
| r0.1.0 || ⛔ | ✔️ | ⛔ |
| r0.0.1 || ⛔ | ✔️ | ⛔ |
| r0.0.0 || ⛔ | ✔️ | ⛔ |
## Sending events to a room