chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client-api: Add support for dir parameter to /relations

Browse Source 
According to MSC3715
This commit is contained in:
Kévin Commaille 2022-09-30 21:49:48 +02:00 committed by Kévin Commaille
parent e2e123dd89
commit b695dee787
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
crates/ruma-client-api/CHANGELOG.md
View File

@ -15,6 +15,7 @@ Improvements:
* The fields added to `RoomEventFilter` were removed by MSC3856 * The fields added to `RoomEventFilter` were removed by MSC3856
* Add support for the threads list API (MSC3856 / Matrix 1.4) * Add support for the threads list API (MSC3856 / Matrix 1.4)
* Stabilize support for private read receipts * Stabilize support for private read receipts
* Add support for the pagination direction parameter to `/relations` (MSC3715 / Matrix 1.4)
# 0.15.1 # 0.15.1

15
crates/ruma-client-api/src/relations/get_relating_events.rs
View File

@ -10,6 +10,8 @@ pub mod v1 {
use js_int::UInt; use js_int::UInt;
use ruma_common::{api::ruma_api, events::AnyMessageLikeEvent, serde::Raw, EventId, RoomId}; use ruma_common::{api::ruma_api, events::AnyMessageLikeEvent, serde::Raw, EventId, RoomId};
use crate::Direction;
ruma_api! { ruma_api! {
metadata: { metadata: {
description: "Get the child events for a given parent event.", description: "Get the child events for a given parent event.",
@ -35,8 +37,8 @@ pub mod v1 {
/// ///
/// If `None`, results start at the most recent topological event known to the server. /// If `None`, results start at the most recent topological event known to the server.
/// ///
/// Can be a `next_batch` token from a previous call, or a returned `start` token from /// Can be a `next_batch` or `prev_batch` token from a previous call, or a returned
/// `/messages` or a `next_batch` token from `/sync`. /// `start` token from `/messages` or a `next_batch` token from `/sync`.
/// ///
/// Note that when paginating the `from` token should be "after" the `to` token in /// Note that when paginating the `from` token should be "after" the `to` token in
/// terms of topological ordering, because it is only possible to paginate "backwards" /// terms of topological ordering, because it is only possible to paginate "backwards"
@ -45,6 +47,13 @@ pub mod v1 {
#[ruma_api(query)] #[ruma_api(query)]
pub from: Option<&'a str>, pub from: Option<&'a str>,
/// The direction to return events from.
///
/// Defaults to [`Direction::Backward`].
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
#[ruma_api(query)]
pub dir: Direction,
/// The pagination token to stop returning results at. /// The pagination token to stop returning results at.
/// ///
/// If `None`, results continue up to `limit` or until there are no more events. /// If `None`, results continue up to `limit` or until there are no more events.
@ -96,7 +105,7 @@ pub mod v1 {
impl<'a> Request<'a> { impl<'a> Request<'a> {
/// Creates a new `Request` with the given room ID and parent event ID. /// Creates a new `Request` with the given room ID and parent event ID.
pub fn new(room_id: &'a RoomId, event_id: &'a EventId) -> Self { pub fn new(room_id: &'a RoomId, event_id: &'a EventId) -> Self {
Self { room_id, event_id, from: None, to: None, limit: None } Self { room_id, event_id, dir: Direction::default(), from: None, to: None, limit: None }
} }
} }