ruma_client_api/push/
get_pushrule_enabled.rs

Help
1//! `GET /_matrix/client/*/pushrules/global/{kind}/{ruleId}/enabled`
2//!
3//! This endpoint gets whether the specified push rule is enabled.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3pushrulesglobalkindruleidenabled
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13    };
14
15    use crate::push::RuleKind;
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: false,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/pushrules/global/:kind/:rule_id/enabled",
23            1.1 => "/_matrix/client/v3/pushrules/global/:kind/:rule_id/enabled",
24        }
25    };
26
27    /// Request type for the `get_pushrule_enabled` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// The kind of rule
31        #[ruma_api(path)]
32        pub kind: RuleKind,
33
34        /// The identifier for the rule.
35        #[ruma_api(path)]
36        pub rule_id: String,
37    }
38
39    /// Response type for the `get_pushrule_enabled` endpoint.
40    #[response(error = crate::Error)]
41    pub struct Response {
42        /// Whether the push rule is enabled or not.
43        pub enabled: bool,
44    }
45
46    impl Request {
47        /// Creates a new `Request` with the given rule kind and rule ID.
48        pub fn new(kind: RuleKind, rule_id: String) -> Self {
49            Self { kind, rule_id }
50        }
51    }
52
53    impl Response {
54        /// Creates a new `Response` with the given enabled flag.
55        pub fn new(enabled: bool) -> Self {
56            Self { enabled }
57        }
58    }
59}
ruma_client_api/push/get_pushrule_enabled.rs

ruma_client_api/push/
get_pushrule_enabled.rs
