From 4de93e9039e0881aa496082c3ad8a0a2fe84a576 Mon Sep 17 00:00:00 2001 From: Bram van den Heuvel Date: Fri, 24 Mar 2023 14:19:25 +0100 Subject: [PATCH] Update documentation --- src/Internal/Api/README.md | 70 +++++++++++++++++++------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/src/Internal/Api/README.md b/src/Internal/Api/README.md index 62bc102..30877ff 100644 --- a/src/Internal/Api/README.md +++ b/src/Internal/Api/README.md @@ -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