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

client-api: Add support for recursion on the get_relating_events endpoints

Browse Source 
According to MSC3981 / Matrix 1.10
This commit is contained in:
Kévin Commaille 2024-03-22 22:21:14 +01:00 committed by Kévin Commaille
parent 5495b85aa3
commit 1d66031f8b
4 changed files with 79 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -33,6 +33,8 @@ Improvements:
authentication, according to MSC4026 / Matrix 1.10.
- Allow `account::register::v3` and `account::login::v3` to accept
authentication for appservices.
- Add support for recursion on the `get_relating_events` endpoints, according to
MSC3981 / Matrix 1.10
# 0.17.4

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

@ -77,6 +77,18 @@ pub mod v1 {
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub limit: Option<UInt>,
/// Whether to include events which relate indirectly to the given event.
///
/// These are events related to the given event via two or more direct relationships.
///
/// It is recommended that homeservers traverse at least 3 levels of relationships.
/// Implementations may perform more but should be careful to not infinitely recurse.
///
/// Default to `false`.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
#[ruma_api(query)]
pub recurse: bool,
}
/// Response type for the `get_relating_events` endpoint.
@ -103,19 +115,33 @@ pub mod v1 {
/// batch/page.
#[serde(skip_serializing_if = "Option::is_none")]
pub prev_batch: Option<String>,
/// If `recurse` was set on the request, the depth to which the server recursed.
///
/// If `recurse` was not set, this field must be absent.
#[serde(skip_serializing_if = "Option::is_none")]
recursion_depth: Option<UInt>,
}
impl Request {
/// Creates a new `Request` with the given room ID and parent event ID.
pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId) -> Self {
Self { room_id, event_id, dir: Direction::default(), from: None, to: None, limit: None }
Self {
room_id,
event_id,
dir: Direction::default(),
from: None,
to: None,
limit: None,
recurse: false,
}
}
}
impl Response {
/// Creates a new `Response` with the given chunk.
pub fn new(chunk: Vec<Raw<AnyMessageLikeEvent>>) -> Self {
Self { chunk, next_batch: None, prev_batch: None }
Self { chunk, next_batch: None, prev_batch: None, recursion_depth: None }
}
}
}

22
crates/ruma-client-api/src/relations/get_relating_events_with_rel_type.rs
View File

@ -75,6 +75,18 @@ pub mod v1 {
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub limit: Option<UInt>,
/// Whether to include events which relate indirectly to the given event.
///
/// These are events related to the given event via two or more direct relationships.
///
/// It is recommended that homeservers traverse at least 3 levels of relationships.
/// Implementations may perform more but should be careful to not infinitely recurse.
///
/// Default to `false`.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
#[ruma_api(query)]
pub recurse: bool,
}
/// Response type for the `get_relating_events_with_rel_type` endpoint.
@ -102,19 +114,25 @@ pub mod v1 {
/// batch/page.
#[serde(skip_serializing_if = "Option::is_none")]
pub prev_batch: Option<String>,
/// If `recurse` was set on the request, the depth to which the server recursed.
///
/// If `recurse` was not set, this field must be absent.
#[serde(skip_serializing_if = "Option::is_none")]
recursion_depth: Option<UInt>,
}
impl Request {
/// Creates a new `Request` with the given room ID, parent event ID and relationship type.
pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId, rel_type: RelationType) -> Self {
Self { room_id, event_id, rel_type, from: None, to: None, limit: None }
Self { room_id, event_id, rel_type, from: None, to: None, limit: None, recurse: false }
}
}
impl Response {
/// Creates a new `Response` with the given chunk.
pub fn new(chunk: Vec<Raw<AnyMessageLikeEvent>>) -> Self {
Self { chunk, next_batch: None, prev_batch: None }
Self { chunk, next_batch: None, prev_batch: None, recursion_depth: None }
}
}
}

31
crates/ruma-client-api/src/relations/get_relating_events_with_rel_type_and_event_type.rs
View File

@ -82,6 +82,18 @@ pub mod v1 {
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub limit: Option<UInt>,
/// Whether to include events which relate indirectly to the given event.
///
/// These are events related to the given event via two or more direct relationships.
///
/// It is recommended that homeservers traverse at least 3 levels of relationships.
/// Implementations may perform more but should be careful to not infinitely recurse.
///
/// Default to `false`.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
#[ruma_api(query)]
pub recurse: bool,
}
/// Response type for the `get_relating_events_with_rel_type_and_event_type` endpoint.
@ -109,6 +121,12 @@ pub mod v1 {
/// batch/page.
#[serde(skip_serializing_if = "Option::is_none")]
pub prev_batch: Option<String>,
/// If `recurse` was set on the request, the depth to which the server recursed.
///
/// If `recurse` was not set, this field must be absent.
#[serde(skip_serializing_if = "Option::is_none")]
recursion_depth: Option<UInt>,
}
impl Request {
@ -120,14 +138,23 @@ pub mod v1 {
rel_type: RelationType,
event_type: TimelineEventType,
) -> Self {
Self { room_id, event_id, rel_type, event_type, from: None, to: None, limit: None }
Self {
room_id,
event_id,
rel_type,
event_type,
from: None,
to: None,
limit: None,
recurse: false,
}
}
}
impl Response {
/// Creates a new `Response` with the given chunk.
pub fn new(chunk: Vec<Raw<AnyMessageLikeEvent>>) -> Self {
Self { chunk, next_batch: None, prev_batch: None }
Self { chunk, next_batch: None, prev_batch: None, recursion_depth: None }
}
}
}