elm-matrix-sdk-alpha/src/Internal/Api
Bram van den Heuvel 92e9527854 Add complex functions for API endpoints
The Vault will now get an event after having sent it to see what it looks like.

If the user has an expired access token, the Vault will get a new token on the next sync.
2023-03-14 22:11:15 +01:00
..
GetEvent Add complex functions for API endpoints 2023-03-14 22:11:15 +01:00
Invite Refactor: connect API tasks to Context 2023-03-14 15:18:23 +01:00
JoinedMembers Refactor: connect API tasks to Context 2023-03-14 15:18:23 +01:00
LoginWithUsernameAndPassword Fix bugs 2023-03-14 16:12:44 +01:00
Redact Refactor: connect API tasks to Context 2023-03-14 15:18:23 +01:00
SendMessageEvent Refactor: connect API tasks to Context 2023-03-14 15:18:23 +01:00
SendStateKey Refactor: connect API tasks to Context 2023-03-14 15:18:23 +01:00
Sync Rename CredUpdate -> VaultUpdate 2023-03-14 15:50:23 +01:00
Versions Refactor: connect API tasks to Context 2023-03-14 15:18:23 +01:00
Chain.elm Fix ASCII snake 2023-03-14 15:51:40 +01:00
Credentials.elm Add complex functions for API endpoints 2023-03-14 22:11:15 +01:00
Helpers.elm Finish files before API end functions refactor 2023-02-21 16:57:58 +01:00
README.md Add invite sending 2023-03-07 14:10:47 +01:00
Request.elm Add complex functions for API endpoints 2023-03-14 22:11:15 +01:00
Task.elm Add complex functions for API endpoints 2023-03-14 22:11:15 +01:00
VaultUpdate.elm Add complex functions for API endpoints 2023-03-14 22:11:15 +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 - coming soon
  • = 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
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 ✔️ ⚠️ ⚠️ ⚠️

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