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
//! `GET /_matrix/federation/*/make_knock/{roomId}/{userId}`
//!
//! Send a request for a knock event template to a resident server.
pub mod v1 {
//! `/v1/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1make_knockroomiduserid
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedRoomId, OwnedUserId, RoomVersionId,
};
use serde_json::value::RawValue as RawJsonValue;
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: ServerSignatures,
history: {
unstable => "/_matrix/federation/unstable/xyz.amorgan.knock/make_knock/:room_id/:user_id",
1.1 => "/_matrix/federation/v1/make_knock/:room_id/:user_id",
}
};
/// Request type for the `create_knock_event_template` endpoint.
#[request]
pub struct Request {
/// The room ID that should receive the knock.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The user ID the knock event will be for.
#[ruma_api(path)]
pub user_id: OwnedUserId,
/// The room versions the sending has support for.
///
/// Defaults to `vec![RoomVersionId::V1]`.
#[ruma_api(query)]
pub ver: Vec<RoomVersionId>,
}
/// Response type for the `create_knock_event_template` endpoint.
#[response]
pub struct Response {
/// The version of the room where the server is trying to knock.
pub room_version: RoomVersionId,
/// An unsigned template event.
///
/// May differ between room versions.
pub event: Box<RawJsonValue>,
}
impl Request {
/// Creates a `Request` with the given room ID and user ID.
pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Self {
Self { room_id, user_id, ver: vec![RoomVersionId::V1] }
}
}
impl Response {
/// Creates a new `Response` with the given room version ID and event.
pub fn new(room_version: RoomVersionId, event: Box<RawJsonValue>) -> Self {
Self { room_version, event }
}
}
}