Expand description
Implements APIs for room keys backups.
NOTE: This file contains a total of 14 endpoints. We sorted them with the same ordering as in [ruma::api::client::backup].
Structsยง
- Room
Keys Component - Component implementing the room keys backups
- Wrong
Backup ๐Version - Error thrown when the version specified does not match the current backup version.
Enumsยง
- Room
Keys ๐Error
Functionsยง
- add_
backup_ ๐keys_ for_ room_ handler - Handler for
PUT /_matrix/client/v3/room_keys/keys/{roomId}(See https://spec.matrix.org/v1.18/client-server-api/#put_matrixclientv3room_keyskeysroomid). - add_
backup_ ๐keys_ for_ session_ handler - Handler for
PUT /_matrix/client/v3/room_keys/keys/{roomId}/{sessionId}(See https://spec.matrix.org/v1.18/client-server-api/#put_matrixclientv3room_keyskeysroomidsessionid). - add_
backup_ ๐keys_ handler - Handler for
PUT /_matrix/client/v3/room_keys/keys(See https://spec.matrix.org/v1.18/client-server-api/#put_matrixclientv3room_keyskeys). - create_
backup_ ๐version_ handler - Handler for
POST /_matrix/client/v3/room_keys/version(See https://spec.matrix.org/v1.18/client-server-api/#post_matrixclientv3room_keysversion). - delete_
backup_ ๐keys_ for_ room_ handler - Handler for
DELETE /_matrix/client/v3/room_keys/keys/{roomId}(See https://spec.matrix.org/v1.18/client-server-api/#delete_matrixclientv3room_keyskeysroomid). - delete_
backup_ ๐keys_ for_ session_ handler - Handler for
DELETE /_matrix/client/v3/room_keys/keys/{roomId}/{sessionId}(See https://spec.matrix.org/v1.18/client-server-api/#delete_matrixclientv3room_keyskeysroomidsessionid). - delete_
backup_ ๐keys_ handler - Handler for
DELETE /_matrix/client/v3/room_keys/keys(See https://spec.matrix.org/v1.18/client-server-api/#delete_matrixclientv3room_keyskeys). - delete_
backup_ ๐version_ handler - Handler for
DELETE /_matrix/client/v3/room_keys/version/{version}(See https://spec.matrix.org/v1.18/client-server-api/#delete_matrixclientv3room_keysversionversion). - get_
backup_ ๐info_ handler - Handler for
GET /_matrix/client/v3/room_keys/version/{version}(See https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv3room_keysversionversion). - get_
backup_ ๐keys_ for_ room_ handler - Handler for
GET /_matrix/client/v3/room_keys/keys/{roomId}(See https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv3room_keyskeysroomid). - get_
backup_ ๐keys_ for_ session_ handler - Handler for
GET /_matrix/client/v3/room_keys/keys/{roomId}/{sessionId}(See https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv3room_keyskeysroomidsessionid). - get_
backup_ ๐keys_ handler - Handler for
GET /_matrix/client/v3/room_keys/keys(See https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv3room_keyskeys). - get_
latest_ ๐backup_ info_ handler - Handler for
GET /_matrix/client/v3/room_keys/version(See https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv3room_keysversion). - handle_
new_ ๐backups - Handles newly uploaded backup(s) and upserts the new one if they match the rules of should_keep_new_backup.
- should_
keep_ ๐new_ backup - Checks whether we should replace an existing backupโs data with the given new one.
- update_
backup_ ๐version_ handler - Handler for
PUT /_matrix/client/v3/room_keys/version/{version}(See https://spec.matrix.org/v1.18/client-server-api/#put_matrixclientv3room_keysversionversion).