ruma-federation-api 0.16.0

Types for the endpoints in the Matrix server-server API.
Documentation 
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

//! `GET /_matrix/federation/*/query/presence_recipients`
pub mod msc4495 {
    //! [`/unstable/org.continuwuity.presence_v2.msc4495/`][MSC4495]
    //!
    //! [MSC4495]: https://github.com/matrix-org/matrix-spec-proposals/pull/4495

    use js_int::Int;
    use ruma_common::{
        OwnedUserId,
        api::{request, response},
        metadata,
    };

    use crate::authentication::ServerSignatures;

    metadata! {
        method: GET,
        rate_limited: false,
        authentication: ServerSignatures,
        path: "/_matrix/federation/unstable/org.continuwuity.presence_v2.msc4495/query/presence_recipients",
    }

    /// Request type for the `get_presence_recipients` endpoint.
    #[request]
    pub struct Request {
        /// The user ID to query. Must be local to the queried server.
        #[ruma_api(query)]
        pub user_id: OwnedUserId,
    }

    impl Request {
        /// Creates a new `Request` with the given user ID.
        pub fn new(user_id: OwnedUserId) -> Self {
            Self { user_id }
        }
    }

    /// Response type for the `get_presence_recipients` endpoint.
    #[response]
    pub struct Response {
        /// A unique identifier for the user's current recipient user set.
        pub stream_id: Int,

        /// An array of local recipients the user intends to push presence to.
        pub recipients: Vec<OwnedUserId>,
    }

    impl Response {
        /// Creates a new `Response` with the given stream ID and recipients.
        pub fn new(stream_id: Int, recipients: Vec<OwnedUserId>) -> Self {
            Self { stream_id, recipients }
        }
    }
}