ruma_client_api/device/
delete_devices.rs

Help
1//! `POST /_matrix/client/*/delete_devices`
2//!
3//! Delete specified devices.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3delete_devices
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedDeviceId,
13    };
14
15    use crate::uiaa::{AuthData, UiaaResponse};
16
17    const METADATA: Metadata = metadata! {
18        method: POST,
19        rate_limited: false,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/delete_devices",
23            1.1 => "/_matrix/client/v3/delete_devices",
24        }
25    };
26
27    /// Request type for the `delete_devices` endpoint.
28    #[request(error = UiaaResponse)]
29    pub struct Request {
30        /// List of devices to delete.
31        pub devices: Vec<OwnedDeviceId>,
32
33        /// Additional authentication information for the user-interactive authentication API.
34        #[serde(skip_serializing_if = "Option::is_none")]
35        pub auth: Option<AuthData>,
36    }
37
38    /// Response type for the `delete_devices` endpoint.
39    #[response(error = UiaaResponse)]
40    #[derive(Default)]
41    pub struct Response {}
42
43    impl Request {
44        /// Creates a new `Request` with the given device list.
45        pub fn new(devices: Vec<OwnedDeviceId>) -> Self {
46            Self { devices, auth: None }
47        }
48    }
49
50    impl Response {
51        /// Creates an empty `Response`.
52        pub fn new() -> Self {
53            Self {}
54        }
55    }
56}
ruma_client_api/device/delete_devices.rs

ruma_client_api/device/
delete_devices.rs
