Skip to main content

Module room_keys

Module room_keys 

Source
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ยง

RoomKeysComponent
Component implementing the room keys backups
WrongBackupVersion ๐Ÿ”’
Error thrown when the version specified does not match the current backup version.

Enumsยง

RoomKeysError ๐Ÿ”’

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