ruma_client_api/to_device/
send_event_to_device.rs

Help
1//! `PUT /_matrix/client/*/sendToDevice/{eventType}/{txnId}`
2//!
3//! Send an event to a device or devices.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3sendtodeviceeventtypetxnid
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata,
15        serde::Raw,
16        to_device::DeviceIdOrAllDevices,
17        OwnedTransactionId, OwnedUserId,
18    };
19    use ruma_events::{AnyToDeviceEventContent, ToDeviceEventType};
20
21    const METADATA: Metadata = metadata! {
22        method: PUT,
23        rate_limited: false,
24        authentication: AccessToken,
25        history: {
26            1.0 => "/_matrix/client/r0/sendToDevice/:event_type/:txn_id",
27            1.1 => "/_matrix/client/v3/sendToDevice/:event_type/:txn_id",
28        }
29    };
30
31    /// Request type for the `send_event_to_device` endpoint.
32    #[request(error = crate::Error)]
33    pub struct Request {
34        /// Type of event being sent to each device.
35        #[ruma_api(path)]
36        pub event_type: ToDeviceEventType,
37
38        /// The transaction ID for this event.
39        ///
40        /// Clients should generate a unique ID across requests within the
41        /// same session. A session is identified by an access token, and
42        /// persists when the [access token is refreshed].
43        ///
44        /// It will be used by the server to ensure idempotency of requests.
45        ///
46        /// [access token is refreshed]: https://spec.matrix.org/latest/client-server-api/#refreshing-access-tokens
47        #[ruma_api(path)]
48        pub txn_id: OwnedTransactionId,
49
50        /// Messages to send.
51        ///
52        /// Different message events can be sent to different devices in the same request, but all
53        /// events within one request must be of the same type.
54        pub messages: Messages,
55    }
56
57    /// Response type for the `send_event_to_device` endpoint.
58    #[response(error = crate::Error)]
59    #[derive(Default)]
60    pub struct Response {}
61
62    impl Request {
63        /// Creates a new `Request` with the given event type, transaction ID and raw messages.
64        pub fn new_raw(
65            event_type: ToDeviceEventType,
66            txn_id: OwnedTransactionId,
67            messages: Messages,
68        ) -> Self {
69            Self { event_type, txn_id, messages }
70        }
71    }
72
73    impl Response {
74        /// Creates an empty `Response`.
75        pub fn new() -> Self {
76            Self {}
77        }
78    }
79
80    /// Messages to send in a send-to-device request.
81    ///
82    /// Represented as a map of `{ user-ids => { device-ids => message-content } }`.
83    pub type Messages =
84        BTreeMap<OwnedUserId, BTreeMap<DeviceIdOrAllDevices, Raw<AnyToDeviceEventContent>>>;
85}
ruma_client_api/to_device/send_event_to_device.rs

ruma_client_api/to_device/
send_event_to_device.rs
