ruma_client_api/device/
delete_device.rs

Help
1//! `DELETE /_matrix/client/*/devices/{deviceId}`
2//!
3//! Delete a device for authenticated user.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#delete_matrixclientv3devicesdeviceid
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: DELETE,
19        rate_limited: false,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/devices/:device_id",
23            1.1 => "/_matrix/client/v3/devices/:device_id",
24        }
25    };
26
27    /// Request type for the `delete_device` endpoint.
28    #[request(error = UiaaResponse)]
29    pub struct Request {
30        /// The device to delete.
31        #[ruma_api(path)]
32        pub device_id: OwnedDeviceId,
33
34        /// Additional authentication information for the user-interactive authentication API.
35        #[serde(skip_serializing_if = "Option::is_none")]
36        pub auth: Option<AuthData>,
37    }
38
39    /// Response type for the `delete_device` endpoint.
40    #[response(error = UiaaResponse)]
41    #[derive(Default)]
42    pub struct Response {}
43
44    impl Request {
45        /// Creates a new `Request` with the given device ID.
46        pub fn new(device_id: OwnedDeviceId) -> Self {
47            Self { device_id, auth: None }
48        }
49    }
50
51    impl Response {
52        /// Creates an empty `Response`.
53        pub fn new() -> Self {
54            Self {}
55        }
56    }
57}
ruma_client_api/device/delete_device.rs

ruma_client_api/device/
delete_device.rs
