History

Bram van den Heuvel a68253cc43 Add MatrixTask description		2023-11-03 23:04:45 +01:00
..
Ban	Push /ban to spec versions v1.7 and v1.8	2023-09-22 14:43:04 +02:00
GetEvent	Proper format before refactor	2023-11-03 07:00:52 +01:00
GetMessages	Push /messages to spec versions v1.7 and v1.8	2023-09-22 15:01:28 +02:00
Invite	Push /invite to spec versions v1.7 and v1.8	2023-09-22 15:16:35 +02:00
JoinRoomById	Push /join-room-by-id to spec versions v1.7 and v1.8	2023-09-22 15:38:05 +02:00
JoinedMembers	Push /joined-members to spec versions v1.7 and v1.8	2023-09-22 15:21:25 +02:00
Leave	Push /leave to spec versions v1.7 and v1.8	2023-09-22 15:40:57 +02:00
LoginWithUsernameAndPassword	Push /login to spec versions 1.7 and 1.8	2023-09-22 16:08:20 +02:00
Redact	Push /redact to spec versions 1.7 and 1.8	2023-09-22 16:12:16 +02:00
SendMessageEvent	Push /send-message, /set-account-data, /sync and /sync to spec versions 1.7 and 1.8	2023-09-22 16:18:15 +02:00
SendStateKey	Push /send-message to spec versions 1.7 and 1.8	2023-09-22 16:14:20 +02:00
SetAccountData	Push /send-message, /set-account-data, /sync and /sync to spec versions 1.7 and 1.8	2023-09-22 16:18:15 +02:00
Sync	Push /send-message, /set-account-data, /sync and /sync to spec versions 1.7 and 1.8	2023-09-22 16:18:15 +02:00
Versions	Update login for all spec versions	2023-03-19 16:45:56 +01:00
WhoAmI	Push /send-message, /set-account-data, /sync and /sync to spec versions 1.7 and 1.8	2023-09-22 16:18:15 +02:00
Architecture.md	Add MatrixTask description	2023-11-03 23:04:45 +01:00
Chain.elm	Improve Task Chain	2023-11-03 22:43:28 +01:00
Helpers.elm	Improve Task Chain	2023-11-03 22:43:28 +01:00
README.md	Update spec description	2023-11-03 22:45:26 +01:00
Request.elm	Add status code errors	2023-04-18 14:55:11 +02:00
Snackbar.elm	Add settings to Vault type	2023-11-03 22:42:18 +01:00
Task.elm	LARGE refactor	2023-04-19 15:09:10 +02:00
VaultUpdate.elm	LARGE refactor	2023-04-19 15:09:10 +02: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.8	✔️	✔️
v1.7	✔️	✔️
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.8	✔️	✔️	✔️	⚡	✔️
v1.7	✔️	✔️	✔️	⚡	✔️
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.8	✔️	✔️	⚠️
v1.7	✔️	✔️	⚠️
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.8	✔️	✔️
v1.7	✔️	✔️
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	✔️	✔️