ruma_client_api/
device.rs

1//! Endpoints for managing devices.
2
3use ruma_common::{MilliSecondsSinceUnixEpoch, OwnedDeviceId};
4use serde::{Deserialize, Serialize};
5
6pub mod delete_device;
7pub mod delete_devices;
8pub mod get_device;
9pub mod get_devices;
10pub mod update_device;
11
12/// Information about a registered device.
13#[derive(Clone, Debug, Deserialize, Hash, Serialize)]
14#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
15pub struct Device {
16    /// Device ID
17    pub device_id: OwnedDeviceId,
18
19    /// Public display name of the device.
20    pub display_name: Option<String>,
21
22    /// Most recently seen IP address of the session.
23    pub last_seen_ip: Option<String>,
24
25    /// Unix timestamp that the session was last active.
26    #[serde(skip_serializing_if = "Option::is_none")]
27    pub last_seen_ts: Option<MilliSecondsSinceUnixEpoch>,
28}
29
30impl Device {
31    /// Creates a new `Device` with the given device ID.
32    pub fn new(device_id: OwnedDeviceId) -> Self {
33        Self { device_id, display_name: None, last_seen_ip: None, last_seen_ts: None }
34    }
35}