49 lines
1.4 KiB
Rust
49 lines
1.4 KiB
Rust
//! Types for the *m.receipt* event.
|
|
|
|
use std::collections::HashMap;
|
|
|
|
use js_int::UInt;
|
|
use ruma_events_macros::ruma_event;
|
|
use ruma_identifiers::{EventId, RoomId, UserId};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
ruma_event! {
|
|
/// Informs the client of new receipts.
|
|
ReceiptEvent {
|
|
kind: Event,
|
|
event_type: Receipt,
|
|
fields: {
|
|
/// The unique identifier for the room associated with this event.
|
|
pub room_id: RoomId,
|
|
},
|
|
content_type_alias: {
|
|
/// The payload for `ReceiptEvent`.
|
|
///
|
|
/// A mapping of event ID to a collection of receipts for this event ID. The event ID is the ID of
|
|
/// the event being acknowledged and *not* an ID for the receipt itself.
|
|
HashMap<EventId, Receipts>
|
|
},
|
|
}
|
|
}
|
|
|
|
/// A collection of receipts.
|
|
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
|
|
pub struct Receipts {
|
|
/// A collection of users who have sent *m.read* receipts for this event.
|
|
#[serde(rename = "m.read")]
|
|
#[serde(default)]
|
|
pub read: Option<UserReceipts>,
|
|
}
|
|
|
|
/// A mapping of user ID to receipt.
|
|
///
|
|
/// The user ID is the entity who sent this receipt.
|
|
pub type UserReceipts = HashMap<UserId, Receipt>;
|
|
|
|
/// An acknowledgement of an event.
|
|
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
|
|
pub struct Receipt {
|
|
/// The timestamp (milliseconds since the Unix epoch) when the receipt was sent.
|
|
pub ts: Option<UInt>,
|
|
}
|