Add endpoint for setting read markers

This commit is contained in:
Karlinde 2020-01-02 11:31:54 +01:00 committed by Jonas Platte
parent 61bdd1ba96
commit b3a26c499a
4 changed files with 40 additions and 0 deletions

View File

@ -18,6 +18,7 @@ Improvements:
* Add `r0::device` endpoints
* Add `r0::room::get_room_event` (introduced in r0.4.0)
* Add `r0::read_marker::set_read_marker` (introduced in r0.4.0)
# 0.5.0

View File

@ -15,6 +15,7 @@ pub mod message;
pub mod presence;
pub mod profile;
pub mod push;
pub mod read_marker;
pub mod receipt;
pub mod redact;
pub mod room;

3
src/r0/read_marker.rs Normal file
View File

@ -0,0 +1,3 @@
//! Endpoints for "fully read markers"
pub mod set_read_marker;

View File

@ -0,0 +1,35 @@
//! [POST /_matrix/client/r0/rooms/{roomId}/read_markers](https://matrix.org/docs/spec/client_server/r0.6.0#post-matrix-client-r0-rooms-roomid-read-markers)
use ruma_api::ruma_api;
use ruma_identifiers::{EventId, RoomId};
ruma_api! {
metadata {
description: "Sets the position of the read marker for a given room, and optionally the read receipt's location.",
method: POST,
name: "set_read_marker",
path: "/_matrix/client/r0/rooms/:room_id/read_markers",
rate_limited: true,
requires_authentication: true,
}
request {
/// The room ID to set the read marker in for the user.
#[ruma_api(path)]
pub room_id: RoomId,
/// The event ID the read marker should be located at.
/// The event MUST belong to the room.
#[serde(rename = "m.fully_read")]
pub fully_read: EventId,
/// The event ID to set the read receipt location at.
/// This is equivalent to calling the create_read_receipt endpoint and is
/// provided here to save that extra call.
#[serde(rename = "m.read", skip_serializing_if = "Option::is_none")]
pub read_receipt: Option<EventId>,
}
response {}
}