1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
//! `GET /_matrix/client/*/rooms/{roomId}/messages`
//!
//! Get message events for a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidmessages
use js_int::{uint, UInt};
use ruma_common::{
api::{request, response, Direction, Metadata},
metadata,
serde::Raw,
OwnedRoomId,
};
use ruma_events::{AnyStateEvent, AnyTimelineEvent};
use crate::filter::RoomEventFilter;
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/:room_id/messages",
1.1 => "/_matrix/client/v3/rooms/:room_id/messages",
}
};
/// Request type for the `get_message_events` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The room to get events from.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The token to start returning events from.
///
/// This token can be obtained from a `prev_batch` token returned for each room by the
/// sync endpoint, or from a `start` or `end` token returned by a previous request to
/// this endpoint.
///
/// If this is `None`, the server will return messages from the start or end of the
/// history visible to the user, depending on the value of [`dir`][Self::dir].
#[ruma_api(query)]
pub from: Option<String>,
/// The token to stop returning events at.
///
/// This token can be obtained from a `prev_batch` token returned for each room by the
/// sync endpoint, or from a `start` or `end` token returned by a previous request to
/// this endpoint.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub to: Option<String>,
/// The direction to return events from.
#[ruma_api(query)]
pub dir: Direction,
/// The maximum number of events to return.
///
/// Default: `10`.
#[ruma_api(query)]
#[serde(default = "default_limit", skip_serializing_if = "is_default_limit")]
pub limit: UInt,
/// A [`RoomEventFilter`] to filter returned events with.
#[ruma_api(query)]
#[serde(
with = "ruma_common::serde::json_string",
default,
skip_serializing_if = "RoomEventFilter::is_empty"
)]
pub filter: RoomEventFilter,
}
/// Response type for the `get_message_events` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {
/// The token the pagination starts from.
pub start: String,
/// The token the pagination ends at.
#[serde(skip_serializing_if = "Option::is_none")]
pub end: Option<String>,
/// A list of room events.
#[serde(default)]
pub chunk: Vec<Raw<AnyTimelineEvent>>,
/// A list of state events relevant to showing the `chunk`.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub state: Vec<Raw<AnyStateEvent>>,
}
impl Request {
/// Creates a new `Request` with the given room ID and direction.
///
/// All other parameters will be defaulted.
pub fn new(room_id: OwnedRoomId, dir: Direction) -> Self {
Self {
room_id,
from: None,
to: None,
dir,
limit: default_limit(),
filter: RoomEventFilter::default(),
}
}
/// Creates a new `Request` with the given room ID and `dir` set to `Backward`.
///
/// If the returned request is sent without `from` being set, pagination will start at the
/// end of (the accessible part of) the room timeline.
///
/// # Example
///
/// ```rust
/// # use ruma_client_api::message::get_message_events;
/// # let room_id = ruma_common::owned_room_id!("!a:example.org");
/// # let token = "prev_batch token".to_owned();
/// let request = get_message_events::v3::Request::backward(room_id).from(token);
/// ```
pub fn backward(room_id: OwnedRoomId) -> Self {
Self::new(room_id, Direction::Backward)
}
/// Creates a new `Request` with the given room ID and `dir` set to `Forward`.
///
/// If the returned request is sent without `from` being set, pagination will start at the
/// beginning of (the accessible part of) the room timeline.
///
/// # Example
///
/// ```rust
/// # use ruma_client_api::message::get_message_events;
/// # let room_id = ruma_common::owned_room_id!("!a:example.org");
/// # let token = "end token".to_owned();
/// let request = get_message_events::v3::Request::forward(room_id).from(token);
/// ```
pub fn forward(room_id: OwnedRoomId) -> Self {
Self::new(room_id, Direction::Forward)
}
/// Creates a new `Request` from `self` with the `from` field set to the given value.
///
/// Since the field is public, you can also assign to it directly. This method merely acts
/// as a shorthand for that, because it is very common to set this field.
pub fn from(self, from: impl Into<Option<String>>) -> Self {
Self { from: from.into(), ..self }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Default::default()
}
}
fn default_limit() -> UInt {
uint!(10)
}
#[allow(clippy::trivially_copy_pass_by_ref)]
fn is_default_limit(val: &UInt) -> bool {
*val == default_limit()
}
#[cfg(all(test, feature = "client"))]
mod tests {
use js_int::uint;
use ruma_common::{
api::{Direction, MatrixVersion, OutgoingRequest, SendAccessToken},
owned_room_id,
};
use super::Request;
use crate::filter::{LazyLoadOptions, RoomEventFilter};
#[test]
fn serialize_some_room_event_filter() {
let room_id = owned_room_id!("!roomid:example.org");
let rooms = vec![room_id.to_owned()];
let filter = RoomEventFilter {
lazy_load_options: LazyLoadOptions::Enabled { include_redundant_members: true },
rooms: Some(rooms),
not_rooms: vec![
owned_room_id!("!room:example.org"),
owned_room_id!("!room2:example.org"),
owned_room_id!("!room3:example.org"),
],
not_types: vec!["type".into()],
..Default::default()
};
let req = Request {
room_id,
from: Some("token".to_owned()),
to: Some("token2".to_owned()),
dir: Direction::Backward,
limit: uint!(0),
filter,
};
let request: http::Request<Vec<u8>> = req
.try_into_http_request(
"https://homeserver.tld",
SendAccessToken::IfRequired("auth_tok"),
&[MatrixVersion::V1_1],
)
.unwrap();
assert_eq!(
"from=token\
&to=token2\
&dir=b\
&limit=0\
&filter=%7B%22not_types%22%3A%5B%22type%22%5D%2C%22not_rooms%22%3A%5B%22%21room%3Aexample.org%22%2C%22%21room2%3Aexample.org%22%2C%22%21room3%3Aexample.org%22%5D%2C%22rooms%22%3A%5B%22%21roomid%3Aexample.org%22%5D%2C%22lazy_load_members%22%3Atrue%2C%22include_redundant_members%22%3Atrue%7D",
request.uri().query().unwrap()
);
}
#[test]
fn serialize_default_room_event_filter() {
let room_id = owned_room_id!("!roomid:example.org");
let req = Request {
room_id,
from: Some("token".to_owned()),
to: Some("token2".to_owned()),
dir: Direction::Backward,
limit: uint!(0),
filter: RoomEventFilter::default(),
};
let request = req
.try_into_http_request::<Vec<u8>>(
"https://homeserver.tld",
SendAccessToken::IfRequired("auth_tok"),
&[MatrixVersion::V1_1],
)
.unwrap();
assert_eq!("from=token&to=token2&dir=b&limit=0", request.uri().query().unwrap(),);
}
}
}