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
//! `POST /_matrix/client/*/rooms/{roomId}/receipt/{receiptType}/{eventId}`
//!
//! Send a receipt event to a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreceiptreceipttypeeventid
use ruma_common::{
api::{request, response, Metadata},
metadata,
serde::{OrdAsRefStr, PartialEqAsRefStr, PartialOrdAsRefStr, StringEnum},
OwnedEventId, OwnedRoomId,
};
use ruma_events::receipt::ReceiptThread;
use crate::PrivOwnedStr;
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: true,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/:room_id/receipt/:receipt_type/:event_id",
1.1 => "/_matrix/client/v3/rooms/:room_id/receipt/:receipt_type/:event_id",
}
};
/// Request type for the `create_receipt` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The room in which to send the event.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The type of receipt to send.
#[ruma_api(path)]
pub receipt_type: ReceiptType,
/// The event ID to acknowledge up to.
#[ruma_api(path)]
pub event_id: OwnedEventId,
/// The thread this receipt applies to.
///
/// *Note* that this must be the default value if used with
/// [`ReceiptType::FullyRead`].
///
/// Defaults to [`ReceiptThread::Unthreaded`].
#[serde(
rename = "thread_id",
default,
skip_serializing_if = "ruma_common::serde::is_default"
)]
pub thread: ReceiptThread,
}
/// Response type for the `create_receipt` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given room ID, receipt type and event ID.
pub fn new(
room_id: OwnedRoomId,
receipt_type: ReceiptType,
event_id: OwnedEventId,
) -> Self {
Self { room_id, receipt_type, event_id, thread: ReceiptThread::default() }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
/// The type of receipt.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, PartialOrdAsRefStr, OrdAsRefStr, PartialEqAsRefStr, Eq, StringEnum)]
#[non_exhaustive]
pub enum ReceiptType {
/// A [public read receipt].
///
/// Indicates that the given event has been presented to the user.
///
/// This receipt is federated to other users.
///
/// [public read receipt]: https://spec.matrix.org/latest/client-server-api/#receipts
#[ruma_enum(rename = "m.read")]
Read,
/// A [private read receipt].
///
/// Indicates that the given event has been presented to the user.
///
/// This read receipt is not federated so only the user and their homeserver
/// are aware of it.
///
/// [private read receipt]: https://spec.matrix.org/latest/client-server-api/#private-read-receipts
#[ruma_enum(rename = "m.read.private")]
ReadPrivate,
/// A [fully read marker].
///
/// Indicates that the given event has been read by the user.
///
/// This is actually not a receipt, but a piece of room account data. It is
/// provided here for convenience.
///
/// [fully read marker]: https://spec.matrix.org/latest/client-server-api/#fully-read-markers
#[ruma_enum(rename = "m.fully_read")]
FullyRead,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}
}