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