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
//! `POST /_matrix/client/*/publicRooms`
//!
//! Get the list of rooms in this homeserver's public directory.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3publicrooms
use js_int::UInt;
use ruma_common::{
api::{request, response, Metadata},
directory::{Filter, PublicRoomsChunk, RoomNetwork},
metadata, OwnedServerName,
};
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/publicRooms",
1.1 => "/_matrix/client/v3/publicRooms",
}
};
/// Request type for the `get_public_rooms_filtered` endpoint.
#[request(error = crate::Error)]
#[derive(Default)]
pub struct Request {
/// The server to fetch the public room lists from.
///
/// `None` means the server this request is sent to.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub server: Option<OwnedServerName>,
/// Limit for the number of results to return.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<UInt>,
/// Pagination token from a previous request.
#[serde(skip_serializing_if = "Option::is_none")]
pub since: Option<String>,
/// Filter to apply to the results.
#[serde(default, skip_serializing_if = "Filter::is_empty")]
pub filter: Filter,
/// Network to fetch the public room lists from.
#[serde(flatten, skip_serializing_if = "ruma_common::serde::is_default")]
pub room_network: RoomNetwork,
}
/// Response type for the `get_public_rooms_filtered` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {
/// A paginated chunk of public rooms.
pub chunk: Vec<PublicRoomsChunk>,
/// A pagination token for the response.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_batch: Option<String>,
/// A pagination token that allows fetching previous results.
#[serde(skip_serializing_if = "Option::is_none")]
pub prev_batch: Option<String>,
/// An estimate on the total number of public rooms, if the server has an estimate.
#[serde(skip_serializing_if = "Option::is_none")]
pub total_room_count_estimate: Option<UInt>,
}
impl Request {
/// Creates an empty `Request`.
pub fn new() -> Self {
Default::default()
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Default::default()
}
}
}