ruma_client_api/config/
get_global_account_data.rs

Help
1//! `GET /_matrix/client/*/user/{userId}/account_data/{type}`
2//!
3//! Gets global account data for a user.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3useruseridaccount_datatype
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedUserId,
15    };
16    use ruma_events::{AnyGlobalAccountDataEventContent, GlobalAccountDataEventType};
17
18    const METADATA: Metadata = metadata! {
19        method: GET,
20        rate_limited: false,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/client/r0/user/:user_id/account_data/:event_type",
24            1.1 => "/_matrix/client/v3/user/:user_id/account_data/:event_type",
25        }
26    };
27
28    /// Request type for the `get_global_account_data` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// User ID of user for whom to retrieve data.
32        #[ruma_api(path)]
33        pub user_id: OwnedUserId,
34
35        /// Type of data to retrieve.
36        #[ruma_api(path)]
37        pub event_type: GlobalAccountDataEventType,
38    }
39
40    /// Response type for the `get_global_account_data` endpoint.
41    #[response(error = crate::Error)]
42    pub struct Response {
43        /// Account data content for the given type.
44        ///
45        /// Since the inner type of the `Raw` does not implement `Deserialize`, you need to use
46        /// `.deserialize_as::<T>()` or `.cast_ref::<T>().deserialize_with_type()` for event
47        /// types with a variable suffix (like [`SecretStorageKeyEventContent`]) to
48        /// deserialize it.
49        ///
50        /// [`SecretStorageKeyEventContent`]: ruma_events::secret_storage::key::SecretStorageKeyEventContent
51        #[ruma_api(body)]
52        pub account_data: Raw<AnyGlobalAccountDataEventContent>,
53    }
54
55    impl Request {
56        /// Creates a new `Request` with the given user ID and event type.
57        pub fn new(user_id: OwnedUserId, event_type: GlobalAccountDataEventType) -> Self {
58            Self { user_id, event_type }
59        }
60    }
61
62    impl Response {
63        /// Creates a new `Response` with the given account data.
64        pub fn new(account_data: Raw<AnyGlobalAccountDataEventContent>) -> Self {
65            Self { account_data }
66        }
67    }
68}
ruma_client_api/config/get_global_account_data.rs

ruma_client_api/config/
get_global_account_data.rs
