ruma-client-api 0.14.1

Types for the endpoints in the Matrix client-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
55
56
57
58
59
60
61
62
63
64

//! `PUT /_matrix/client/*/user/{userId}/rooms/{roomId}/tags/{tag}`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3useruseridroomsroomidtagstag

    use ruma_common::{api::ruma_api, events::tag::TagInfo, RoomId, UserId};

    ruma_api! {
        metadata: {
            description: "Add a new tag to a room.",
            method: PUT,
            name: "create_tag",
            r0_path: "/_matrix/client/r0/user/:user_id/rooms/:room_id/tags/:tag",
            stable_path: "/_matrix/client/v3/user/:user_id/rooms/:room_id/tags/:tag",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The ID of the user creating the tag.
            #[ruma_api(path)]
            pub user_id: &'a UserId,

            /// The room to tag.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,

            /// The name of the tag to create.
            #[ruma_api(path)]
            pub tag: &'a str,

            /// Info about the tag.
            #[ruma_api(body)]
            pub tag_info: TagInfo,
        }

        #[derive(Default)]
        response: {}

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given user ID, room ID, tag and tag info.
        pub fn new(
            user_id: &'a UserId,
            room_id: &'a RoomId,
            tag: &'a str,
            tag_info: TagInfo,
        ) -> Self {
            Self { user_id, room_id, tag, tag_info }
        }
    }

    impl Response {
        /// Creates an empty `Response`.
        pub fn new() -> Self {
            Self {}
        }
    }
}