ruma_client_api/appservice/
request_ping.rs

Help
1//! `POST /_matrix/client/*/appservice/{appserviceId}/ping}`
2//!
3//! Ask the homeserver to ping the application service to ensure the connection works.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/application-service-api/#post_matrixclientv1appserviceappserviceidping
9
10    use std::time::Duration;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata, OwnedTransactionId,
15    };
16
17    const METADATA: Metadata = metadata! {
18        method: POST,
19        rate_limited: false,
20        authentication: AppserviceToken,
21        history: {
22            unstable => "/_matrix/client/unstable/fi.mau.msc2659/appservice/:appservice_id/ping",
23            1.7 => "/_matrix/client/v1/appservice/:appservice_id/ping",
24        }
25    };
26
27    /// Request type for the `request_ping` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// The appservice ID of the appservice to ping.
31        ///
32        /// This must be the same as the appservice whose `as_token` is being used to authenticate
33        /// the request.
34        #[ruma_api(path)]
35        pub appservice_id: String,
36
37        /// Transaction ID that is passed through to the `POST /_matrix/app/v1/ping` call.
38        #[serde(skip_serializing_if = "Option::is_none")]
39        pub transaction_id: Option<OwnedTransactionId>,
40    }
41
42    /// Response type for the `request_ping` endpoint.
43    #[response(error = crate::Error)]
44    pub struct Response {
45        /// The duration in milliseconds that the `POST /_matrix/app/v1/ping` request took from the
46        /// homeserver's point of view.
47        #[serde(with = "ruma_common::serde::duration::ms", rename = "duration_ms")]
48        pub duration: Duration,
49    }
50
51    impl Request {
52        /// Creates a new `Request` with the given appservice ID.
53        pub fn new(appservice_id: String) -> Self {
54            Self { appservice_id, transaction_id: None }
55        }
56    }
57
58    impl Response {
59        /// Creates an `Response` with the given duration.
60        pub fn new(duration: Duration) -> Self {
61            Self { duration }
62        }
63    }
64}
ruma_client_api/appservice/request_ping.rs

ruma_client_api/appservice/
request_ping.rs
