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
69
70
71
72
73
74
75
76
77
78
//! [GET /_matrix/federation/v1/user/devices/{userId}](https://matrix.org/docs/spec/server_server/r0.1.4#get-matrix-federation-v1-user-devices-userid)

use js_int::UInt;
use ruma_api::ruma_api;
use ruma_common::encryption::DeviceKeys;
use ruma_identifiers::{DeviceId, UserId};
use serde::{Deserialize, Serialize};

ruma_api! {
    metadata: {
        description: "Gets information on all of the user's devices.",
        name: "get_devices",
        method: GET,
        path: "/_matrix/federation/v1/user/devices/:user_id",
        rate_limited: false,
        authentication: ServerSignatures,
    }

    request: {
        /// The user ID to retrieve devices for.
        ///
        /// Must be a user local to the receiving homeserver.
        #[ruma_api(path)]
        pub user_id: &'a UserId,
    }

    response: {
        /// The user ID devices were requested for.
        pub user_id: Box<UserId>,

        /// A unique ID for a given user_id which describes the version of the returned device list.
        ///
        /// This is matched with the `stream_id` field in `m.device_list_update` EDUs in order to
        /// incrementally update the returned device_list.
        pub stream_id: UInt,

        /// The user's devices.
        pub devices: Vec<UserDevice>,
    }
}

impl<'a> Request<'a> {
    /// Creates a new `Request` with the given user id.
    pub fn new(user_id: &'a UserId) -> Self {
        Self { user_id }
    }
}

impl Response {
    /// Creates a new `Response` with the given user id and stream id.
    ///
    /// The device list will be empty.
    pub fn new(user_id: Box<UserId>, stream_id: UInt) -> Self {
        Self { user_id, stream_id, devices: Vec::new() }
    }
}

/// Information about a user's device.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct UserDevice {
    /// The device ID.
    pub device_id: Box<DeviceId>,

    /// Identity keys for the device.
    pub keys: DeviceKeys,

    /// Optional display name for the device
    #[serde(skip_serializing_if = "Option::is_none")]
    pub device_display_name: Option<String>,
}

impl UserDevice {
    /// Creates a new `UserDevice` with the given device id and keys.
    pub fn new(device_id: Box<DeviceId>, keys: DeviceKeys) -> Self {
        Self { device_id, keys, device_display_name: None }
    }
}