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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
//! [POST /_matrix/client/unstable/org.matrix.msc3575/sync](https://github.com/matrix-org/matrix-doc/blob/kegan/sync-v3/proposals/3575-sync.md)
use std::{collections::BTreeMap, time::Duration};
use super::{DeviceLists, UnreadNotificationsCount};
use js_int::UInt;
use ruma_common::{
api::ruma_api,
events::{
AnyGlobalAccountDataEvent, AnyRoomAccountDataEvent, AnyStrippedStateEvent,
AnySyncStateEvent, AnySyncTimelineEvent, AnyToDeviceEvent, RoomEventType,
},
serde::{duration::opt_ms, Raw},
DeviceKeyAlgorithm, OwnedRoomId,
};
use serde::{Deserialize, Serialize};
ruma_api! {
metadata: {
description: "Get all new events in a sliding window of rooms since the last sync or a given point of time.",
method: POST,
name: "sync",
// added: 1.4,
// stable_path: "/_matrix/client/v4/sync",
unstable_path: "/_matrix/client/unstable/org.matrix.msc3575/sync",
rate_limited: false,
authentication: AccessToken,
}
#[derive(Default)]
request: {
/// A point in time to continue a sync from.
///
/// Should be a token from the `pos` field of a previous `/sync`
/// response.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub pos: Option<&'a str>,
/// Allows clients to know what request params reached the server,
/// functionally similar to txn IDs on /send for events.
#[serde(skip_serializing_if = "Option::is_none")]
pub txn_id: Option<&'a str>,
/// The maximum time to poll before responding to this request.
#[serde(
with = "opt_ms",
default,
skip_serializing_if = "Option::is_none",
)]
#[ruma_api(query)]
pub timeout: Option<Duration>,
/// The lists of rooms we're interested in.
pub lists: &'a [SyncRequestList],
/// Specific rooms and event types that we want to receive events from.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub room_subscriptions: BTreeMap<OwnedRoomId, RoomSubscription>,
/// Specific rooms we no longer want to receive events from.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub unsubscribe_rooms: &'a [OwnedRoomId],
/// Extensions API.
#[serde(default, skip_serializing_if = "ExtensionsConfig::is_empty")]
pub extensions: ExtensionsConfig,
}
response: {
/// Whether this response describes an initial sync (i.e. after the `pos` token has been
/// discard by the server?).
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub initial: bool,
/// The token to supply in the `pos` param of the next `/sync` request.
pub pos: String,
/// Updates to the sliding room list.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub lists: Vec<SyncList>,
/// The updates on rooms.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub rooms: BTreeMap<OwnedRoomId, SlidingSyncRoom>,
/// Extensions API.
#[serde(default, skip_serializing_if = "Extensions::is_empty")]
pub extensions: Extensions,
}
error: crate::Error
}
impl Request<'_> {
/// Creates an empty `Request`.
pub fn new() -> Self {
Default::default()
}
}
impl Response {
/// Creates a new `Response` with the given pos.
pub fn new(pos: String) -> Self {
Self {
initial: Default::default(),
pos,
lists: Default::default(),
rooms: Default::default(),
extensions: Default::default(),
}
}
}
/// Filter for a sliding sync list, set at request.
///
/// All fields are applied with AND operators, hence if `is_dm` is `true` and `is_encrypted` is
/// `true` then only encrypted DM rooms will be returned. The absence of fields implies no filter
/// on that criteria: it does NOT imply `false`.
///
/// Filters are considered _sticky_, meaning that the filter only has to be provided once and their
/// parameters 'sticks' for future requests until a new filter overwrites them.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SyncRequestListFilters {
/// Whether to return DMs, non-DM rooms or both.
///
/// Flag which only returns rooms present (or not) in the DM section of account data.
/// If unset, both DM rooms and non-DM rooms are returned. If false, only non-DM rooms
/// are returned. If true, only DM rooms are returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub is_dm: Option<bool>,
/// Only list rooms that are spaces of these or all.
///
/// A list of spaces which target rooms must be a part of. For every invited/joined
/// room for this user, ensure that there is a parent space event which is in this list. If
/// unset, all rooms are included. Servers MUST NOT navigate subspaces. It is up to the
/// client to give a complete list of spaces to navigate. Only rooms directly in these
/// spaces will be returned.
#[serde(skip_serializing_if = "Vec::is_empty")]
pub spaces: Vec<String>,
/// Whether to return encrypted, non-encrypted rooms or both.
///
/// Flag which only returns rooms which have an `m.room.encryption` state event. If
/// unset, both encrypted and unencrypted rooms are returned. If false, only unencrypted
/// rooms are returned. If true, only encrypted rooms are returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub is_encrypted: Option<bool>,
/// Whether to return invited Rooms, only joined rooms or both.
///
/// Flag which only returns rooms the user is currently invited to. If unset, both
/// invited and joined rooms are returned. If false, no invited rooms are returned. If
/// true, only invited rooms are returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub is_invite: Option<bool>,
/// Whether to return Rooms with tombstones, only rooms without tombstones or both.
///
/// Flag which only returns rooms which have an `m.room.tombstone` state event. If unset,
/// both tombstoned and un-tombstoned rooms are returned. If false, only un-tombstoned rooms
/// are returned. If true, only tombstoned rooms are returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub is_tombstoned: Option<bool>,
/// Only list rooms of given create-types or all.
///
/// If specified, only rooms where the `m.room.create` event has a `type` matching one
/// of the strings in this array will be returned. If this field is unset, all rooms are
/// returned regardless of type. This can be used to get the initial set of spaces for an
/// account.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub room_types: Vec<String>,
/// Only list rooms that are not of these create-types, or all.
///
/// Same as "room_types" but inverted. This can be used to filter out spaces from the room
/// list.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_room_types: Vec<String>,
/// Only list rooms matching the given string, or all.
///
/// Filter the room name. Case-insensitive partial matching e.g 'foo' matches 'abFooab'.
/// The term 'like' is inspired by SQL 'LIKE', and the text here is similar to '%foo%'.
#[serde(skip_serializing_if = "Option::is_none")]
pub room_name_like: Option<String>,
/// Filter the room based on its room tags.
///
/// If multiple tags are present, a room can have
/// any one of the listed tags (OR'd).
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub tags: Vec<String>,
/// Filter the room based on its room tags.
///
/// Takes priority over `tags`. For example, a room
/// with tags A and B with filters `tags:[A]` `not_tags:[B]` would NOT be included because
/// `not_tags` takes priority over `tags`. This filter is useful if your Rooms list does
/// NOT include the list of favourite rooms again.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_tags: Vec<String>,
/// Extensions may add further fields to the filters.
#[serde(flatten, default, skip_serializing_if = "BTreeMap::is_empty")]
pub extensions: BTreeMap<String, serde_json::Value>,
}
/// Sliding Sync Request for each list.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SyncRequestList {
/// Put this list into the all-rooms-mode.
///
/// Settings this to true will inform the server that, no matter how slow
/// that might be, the clients wants all rooms the filters apply to. When operating
/// in this mode, `ranges` and `sort` will be ignored there will be no movement operations
/// (`DELETE` followed by `INSERT`) as the client has the entire list and can work out whatever
/// sort order they wish. There will still be `DELETE` and `INSERT` operations when rooms are
/// left or joined respectively. In addition, there will be an initial `SYNC` operation to let
/// the client know which rooms in the rooms object were from this list.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub slow_get_all_rooms: bool,
/// The ranges of rooms we're interested in.
pub ranges: Vec<(UInt, UInt)>,
/// The sort ordering applied to this list of rooms. Sticky.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub sort: Vec<String>,
/// Required state for each room returned. An array of event type and state key tuples.
/// Note that elements of this array are NOT sticky so they must be specified in full when they
/// are changed. Sticky.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub required_state: Vec<(RoomEventType, String)>,
/// The maximum number of timeline events to return per room. Sticky.
#[serde(skip_serializing_if = "Option::is_none")]
pub timeline_limit: Option<UInt>,
/// Filters to apply to the list before sorting. Sticky.
#[serde(skip_serializing_if = "Option::is_none")]
pub filters: Option<SyncRequestListFilters>,
}
/// The RoomSubscriptions of the SlidingSync Request
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct RoomSubscription {
/// Required state for each room returned. An array of event type and state key tuples.
///
/// Note that elements of this array are NOT sticky so they must be specified in full when they
/// are changed. Sticky.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub required_state: Vec<(RoomEventType, String)>,
/// The maximum number of timeline events to return per room. Sticky.
#[serde(skip_serializing_if = "Option::is_none")]
pub timeline_limit: Option<UInt>,
}
/// Operation applied to the specific SlidingSyncList
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "UPPERCASE")]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub enum SlidingOp {
/// Full reset of the given window.
Sync,
/// Insert an item at the given point, moves all following entry by
/// one to the next Empty or Invalid field.
Insert,
/// Drop this entry, moves all following entry up by one.
Delete,
/// Mark these as invaldiated.
Invalidate,
}
/// Updates to joined rooms.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SyncList {
/// The sync operation to apply, if any.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub ops: Vec<SyncOp>,
/// The total number of rooms found for this filter.
pub count: UInt,
}
/// Updates to joined rooms.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SyncOp {
/// The sync operation to apply.
pub op: SlidingOp,
/// The range this list update applies to.
pub range: Option<(UInt, UInt)>,
/// Or the specific index the update applies to.
pub index: Option<UInt>,
/// The list of room_ids updates to apply.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub room_ids: Vec<OwnedRoomId>,
/// On insert and delete we are only receiving exactly one room_id.
pub room_id: Option<OwnedRoomId>,
}
/// Updates to joined rooms.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SlidingSyncRoom {
/// The name of the room as calculated by the server.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Was this an initial response.
#[serde(skip_serializing_if = "Option::is_none")]
pub initial: Option<bool>,
/// This is a direct message.
#[serde(skip_serializing_if = "Option::is_none")]
pub is_dm: Option<bool>,
/// This is not-yet-accepted invite, with the following sync state events
/// the room must be considered in invite state as long as the Option is not None
/// even if there are no state events.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub invite_state: Vec<Raw<AnyStrippedStateEvent>>,
/// Counts of unread notifications for this room.
#[serde(flatten, default, skip_serializing_if = "UnreadNotificationsCount::is_empty")]
pub unread_notifications: UnreadNotificationsCount,
/// The timeline of messages and state changes in the room.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub timeline: Vec<Raw<AnySyncTimelineEvent>>,
/// Updates to the state at the beginning of the `timeline`.
/// A list of state events.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub required_state: Vec<Raw<AnySyncStateEvent>>,
/// The prev_batch allowing you to paginate through the messages before the given ones.
#[serde(skip_serializing_if = "Option::is_none")]
pub prev_batch: Option<String>,
/// True if the number of events returned was limited by the limit on the filter.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub limited: bool,
/// The number of users with membership of `join`, including the client’s own user ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub joined_count: Option<UInt>,
/// The number of users with membership of `invite`.
#[serde(skip_serializing_if = "Option::is_none")]
pub invited_count: Option<UInt>,
}
impl SlidingSyncRoom {
/// Creates an empty `Room`.
pub fn new() -> Self {
Default::default()
}
}
/// Sliding-Sync extension configuration.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ExtensionsConfig {
/// Request to devices messages with the given config.
#[serde(skip_serializing_if = "Option::is_none")]
pub to_device: Option<ToDeviceConfig>,
/// Configure the end-to-end-encryption extension.
#[serde(skip_serializing_if = "Option::is_none")]
pub e2ee: Option<E2EEConfig>,
/// Configure the account data extension.
#[serde(skip_serializing_if = "Option::is_none")]
pub account_data: Option<AccountDataConfig>,
/// Extensions may add further fields to the list.
#[serde(flatten)]
other: BTreeMap<String, serde_json::Value>,
}
impl ExtensionsConfig {
fn is_empty(&self) -> bool {
self.to_device.is_none()
&& self.e2ee.is_none()
&& self.account_data.is_none()
&& self.other.is_empty()
}
}
/// Extensions specific response data.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Extensions {
/// To-device extension in response.
#[serde(skip_serializing_if = "Option::is_none")]
pub to_device: Option<ToDevice>,
/// E2EE extension in response.
#[serde(skip_serializing_if = "Option::is_none")]
pub e2ee: Option<E2EE>,
/// Account data extension in response.
#[serde(skip_serializing_if = "Option::is_none")]
pub account_data: Option<AccountData>,
}
impl Extensions {
/// Whether extension data was given.
///
/// True if neither to-device, e2ee nor account data are to be found.
pub fn is_empty(&self) -> bool {
self.to_device.is_none() && self.e2ee.is_none() && self.account_data.is_none()
}
}
/// To-device messages extension configuration.
///
/// According to [MSC3885](https://github.com/matrix-org/matrix-spec-proposals/pull/3885).
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ToDeviceConfig {
/// Activate or deactivate this extension. Sticky.
#[serde(skip_serializing_if = "Option::is_none")]
pub enabled: Option<bool>,
/// Max number of to-device messages per response.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<UInt>,
/// Give messages since this token only.
#[serde(skip_serializing_if = "Option::is_none")]
pub since: Option<String>,
}
/// To-device messages extension response.
///
/// According to [MSC3885](https://github.com/matrix-org/matrix-spec-proposals/pull/3885).
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ToDevice {
/// Fetch the next batch from this entry.
pub next_batch: String,
/// The to-device Events.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub events: Vec<Raw<AnyToDeviceEvent>>,
}
/// E2EE extension configuration.
///
/// According to [MSC3884](https://github.com/matrix-org/matrix-spec-proposals/pull/3884).
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct E2EEConfig {
/// Activate or deactivate this extension. Sticky.
#[serde(skip_serializing_if = "Option::is_none")]
pub enabled: Option<bool>,
}
/// E2EE extension response data.
///
/// According to [MSC3884](https://github.com/matrix-org/matrix-spec-proposals/pull/3884).
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct E2EE {
/// Information on E2EE device updates.
///
/// Only present on an incremental sync.
#[serde(default, skip_serializing_if = "DeviceLists::is_empty")]
pub device_lists: DeviceLists,
/// For each key algorithm, the number of unclaimed one-time keys
/// currently held on the server for a device.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub device_one_time_keys_count: BTreeMap<DeviceKeyAlgorithm, UInt>,
/// For each key algorithm, the number of unclaimed one-time keys
/// currently held on the server for a device.
///
/// The presence of this field indicates that the server supports
/// fallback keys.
#[serde(skip_serializing_if = "Option::is_none")]
pub device_unused_fallback_key_types: Option<Vec<DeviceKeyAlgorithm>>,
}
/// Account-data extension configuration.
///
/// Not yet part of the spec proposal. Taken from the reference implementation
/// <https://github.com/matrix-org/sliding-sync/blob/d77e21138d4886d27b3888d36cf3627f54f67590/sync3/extensions/account_data.go>
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct AccountDataConfig {
/// Activate or deactivate this extension. Sticky.
#[serde(skip_serializing_if = "Option::is_none")]
pub enabled: Option<bool>,
}
/// Account-data extension response data.
///
/// Not yet part of the spec proposal. Taken from the reference implementation
/// <https://github.com/matrix-org/sliding-sync/blob/d77e21138d4886d27b3888d36cf3627f54f67590/sync3/extensions/account_data.go>
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct AccountData {
/// The global private data created by this user.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub global: Vec<Raw<AnyGlobalAccountDataEvent>>,
/// The private data that this user has attached to each room.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub rooms: BTreeMap<OwnedRoomId, Vec<Raw<AnyRoomAccountDataEvent>>>,
}