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
elm-matrix-sdk-alpha/src/Internal/Api
History
Bram van den Heuvel c45ecd2da3 Add /whoami API endpoint 2023-03-24 14:56:31 +01:00
..
Ban Add ban API 2023-03-24 14:14:58 +01:00
GetEvent Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
GetMessages Get older messages from a chat 2023-03-22 15:22:57 +01:00
Invite Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
JoinRoomById Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
JoinedMembers Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
Leave Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
LoginWithUsernameAndPassword Get older messages from a chat 2023-03-22 15:22:57 +01:00
Redact Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
SendMessageEvent Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
SendStateKey Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
Sync Upgrade to spec version v1.6 2023-03-16 10:32:03 +01:00
Versions Update login for all spec versions 2023-03-19 16:45:56 +01:00
WhoAmI Add /whoami API endpoint 2023-03-24 14:56:31 +01:00
Chain.elm Eliminate unused code 2023-03-14 22:31:55 +01:00
Credentials.elm Add complex functions for API endpoints 2023-03-14 22:11:15 +01:00
Helpers.elm Eliminate unused code 2023-03-14 22:31:55 +01:00
README.md Update documentation 2023-03-24 14:19:25 +01:00
Request.elm Eliminate unused code 2023-03-14 22:31:55 +01:00
Task.elm Add event to get older events 2023-03-23 22:45:26 +01:00
VaultUpdate.elm Add ban API 2023-03-24 14:14:58 +01:00

README.md

API Support

Different Matrix spec versions have different rules. The Elm SDK doesn't just assume that the spec remains the same in new versions, and instead requires developers to explicitly implement each version.

This file explains what features are supported in which spec versions.

DISCLAIMER: All information in this file is prone to change! I am a single developer creating this in their spare time, and even though I try to be consistent, I may decide (not) to develop certain parts of the API at any time!

The icons have the following meaning:

  • ✔️ = Supported
  • ⚠️ = To be announced
  • ⚡ = Under development
  • ❌ = Not supported by SDK
  • ⛔ = Not supported by spec

Note that under development doesn't always mean that it will be supported.

Communication

Spec version Syncing Redaction
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 ❌ ✔️

Changing room member status

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 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

Spec version Message event State event
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 ✔️ ✔️