Module room 

Implements APIs for room management from the matrix spec

Structs

RoomComponent

Component implementing endpoint for client room management

Enums

InviteUserError 🔒

Error when inviting a user

JoinRoomByIdError 🔒

Errors that occur when joining a room

ReadReceiptOrReadMarkerError 🔒

Error type for both the read receipts and the read markers endpoints.

Functions

append_server_to_via 🔒

Compute the via from the request, and append the server name

ban_user_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/ban (See https://spec.matrix.org/v1.18/client-server-api/#post_matrixclientv3roomsroomidban).

create_member_event_content 🔒

Create the event content of a membership event

create_receipt_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/receipt/{receiptType}/{eventId} (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid).

create_room_handler 🔒

Handler for POST /_matrix/client/v3/createRoom (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3createroom).

forget_room_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/forget (See https://spec.matrix.org/v1.14/client-server-api/#post_matrixclientv3roomsroomidforget).

get_member_events_handler 🔒

Handler for GET /_matrix/client/v3/rooms/{roomId}/members (See https://spec.matrix.org/v1.14/client-server-api/#get_matrixclientv3roomsroomidmembers)

get_room_event_handler 🔒

Handler for GET /_matrix/client/v3/rooms/{roomId}/event/{eventId} (See https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomideventeventid).

get_state_events_for_key_handler 🔒

Handler for GET /_matrix/client/v3/rooms/{roomId}/state/{eventType}/{stateKey} (See https://spec.matrix.org/v1.15/client-server-api/#get_matrixclientv3roomsroomidstateeventtypestatekey).

get_state_events_handler 🔒

Handler for GET /_matrix/client/v3/rooms/{roomId}/state (See https://spec.matrix.org/v1.15/client-server-api/#get_matrixclientv3roomsroomidstate).

invite_user_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/invite (See https://spec.matrix.org/v1.15/client-server-api/#thirdparty_post_matrixclientv3roomsroomidinvite).

join_room 🔒

Add a joined event to a room for the user, with the correct username and ID

join_room_by_id_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/join (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidjoin).

join_room_by_id_or_alias_handler 🔒

Handler for POST /_matrix/client/v3/join/{roomIdOrAlias} (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3joinroomidoralias).

joined_rooms_handler 🔒

Handler for GET /_matrix/client/v3/joined_rooms (See https://spec.matrix.org/v1.18/client-server-api/#get_matrixclientv3joined_rooms).

kick_user_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/kick (See https://spec.matrix.org/v1.18/client-server-api/#post_matrixclientv3roomsroomidkick).

knock_room_handler 🔒

Handler for POST /_matrix/client/v3/knock/{roomIdOrAlias} (See https://spec.matrix.org/v1.15/client-server-api/#post_matrixclientv3knockroomidoralias).

leave_room_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/leave (See https://spec.matrix.org/v1.14/client-server-api/#post_matrixclientv3roomsroomidleave).

redact_event_handler 🔒

Handler for PUT /_matrix/client/v3/rooms/{roomId}/redact/{eventId}/{txnId} (See https://spec.matrix.org/v1.16/client-server-api/#redactions).

send_message_event_handler 🔒

Handler for PUT /_matrix/client/v3/rooms/{roomId}/send/{eventType}/{txnId} (See https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3roomsroomidsendeventtypetxnid).

send_state_event_handler 🔒

Handler for PUT /_matrix/client/v3/rooms/{roomId}/state/{eventType}/{stateKey} (See https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3roomsroomidstateeventtypestatekey).

set_read_marker_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/read_markers (See https://spec.matrix.org/v1.17/client-server-api/#post_matrixclientv3roomsroomidread_markers).

unban_user_handler 🔒

Handler for POST /_matrix/client/v3/rooms/{roomId}/unban (See https://spec.matrix.org/v1.18/client-server-api/#post_matrixclientv3roomsroomidunban).