ruma_client_api/presence/
set_presence.rs

1//! `PUT /_matrix/client/*/presence/{userId}/status`
2//!
3//! Set presence status for this user.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3presenceuseridstatus
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        presence::PresenceState,
14        OwnedUserId,
15    };
16
17    const METADATA: Metadata = metadata! {
18        method: PUT,
19        rate_limited: true,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/presence/:user_id/status",
23            1.1 => "/_matrix/client/v3/presence/:user_id/status",
24        }
25    };
26
27    /// Request type for the `set_presence` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// The user whose presence state will be updated.
31        #[ruma_api(path)]
32        pub user_id: OwnedUserId,
33
34        /// The new presence state.
35        pub presence: PresenceState,
36
37        /// The status message to attach to this state.
38        #[serde(skip_serializing_if = "Option::is_none")]
39        pub status_msg: Option<String>,
40    }
41
42    /// Response type for the `set_presence` endpoint.
43    #[response(error = crate::Error)]
44    #[derive(Default)]
45    pub struct Response {}
46
47    impl Request {
48        /// Creates a new `Request` with the given user ID and presence state.
49        pub fn new(user_id: OwnedUserId, presence: PresenceState) -> Self {
50            Self { user_id, presence, status_msg: None }
51        }
52    }
53
54    impl Response {
55        /// Creates an empty `Response`.
56        pub fn new() -> Self {
57            Self {}
58        }
59    }
60}
ruma_client_api/presence/set_presence.rs

ruma_client_api/presence/
set_presence.rs
