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
//! `GET /_matrix/federation/*/event/{eventId}`
//!
//! Retrieves a single event.
pub mod v1 {
//! `/v1/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1eventeventid
use ruma_common::{
api::{request, response, Metadata},
metadata, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedServerName,
};
use serde_json::value::RawValue as RawJsonValue;
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: ServerSignatures,
history: {
1.0 => "/_matrix/federation/v1/event/:event_id",
}
};
/// Request type for the `get_event` endpoint.
#[request]
pub struct Request {
/// The event ID to get.
#[ruma_api(path)]
pub event_id: OwnedEventId,
}
/// Response type for the `get_event` endpoint.
#[response]
pub struct Response {
/// The `server_name` of the homeserver sending this transaction.
pub origin: OwnedServerName,
/// Time on originating homeserver when this transaction started.
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
/// The event.
#[serde(rename = "pdus", with = "ruma_common::serde::single_element_seq")]
pub pdu: Box<RawJsonValue>,
}
impl Request {
/// Creates a new `Request` with the given event id.
pub fn new(event_id: OwnedEventId) -> Self {
Self { event_id }
}
}
impl Response {
/// Creates a new `Response` with the given server name, timestamp, and event.
pub fn new(
origin: OwnedServerName,
origin_server_ts: MilliSecondsSinceUnixEpoch,
pdu: Box<RawJsonValue>,
) -> Self {
Self { origin, origin_server_ts, pdu }
}
}
}