ruma_client_api/authenticated_media/
get_content.rs

Help
1//! `GET /_matrix/client/*/media/download/{serverName}/{mediaId}`
2//!
3//! Retrieve content from the media store.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv1mediadownloadservernamemediaid
9
10    use std::time::Duration;
11
12    use http::header::{CONTENT_DISPOSITION, CONTENT_TYPE};
13    use ruma_common::{
14        api::{request, response, Metadata},
15        http_headers::ContentDisposition,
16        metadata, IdParseError, MxcUri, OwnedServerName,
17    };
18
19    const METADATA: Metadata = metadata! {
20        method: GET,
21        rate_limited: true,
22        authentication: AccessToken,
23        history: {
24            unstable => "/_matrix/client/unstable/org.matrix.msc3916/media/download/:server_name/:media_id",
25            1.11 => "/_matrix/client/v1/media/download/:server_name/:media_id",
26        }
27    };
28
29    /// Request type for the `get_media_content` endpoint.
30    #[request(error = crate::Error)]
31    pub struct Request {
32        /// The server name from the mxc:// URI (the authoritory component).
33        #[ruma_api(path)]
34        pub server_name: OwnedServerName,
35
36        /// The media ID from the mxc:// URI (the path component).
37        #[ruma_api(path)]
38        pub media_id: String,
39
40        /// The maximum duration that the client is willing to wait to start receiving data, in the
41        /// case that the content has not yet been uploaded.
42        ///
43        /// The default value is 20 seconds.
44        #[ruma_api(query)]
45        #[serde(
46            with = "ruma_common::serde::duration::ms",
47            default = "ruma_common::media::default_download_timeout",
48            skip_serializing_if = "ruma_common::media::is_default_download_timeout"
49        )]
50        pub timeout_ms: Duration,
51    }
52
53    /// Response type for the `get_media_content` endpoint.
54    #[response(error = crate::Error)]
55    pub struct Response {
56        /// The content that was previously uploaded.
57        #[ruma_api(raw_body)]
58        pub file: Vec<u8>,
59
60        /// The content type of the file that was previously uploaded.
61        #[ruma_api(header = CONTENT_TYPE)]
62        pub content_type: Option<String>,
63
64        /// The value of the `Content-Disposition` HTTP header, possibly containing the name of the
65        /// file that was previously uploaded.
66        #[ruma_api(header = CONTENT_DISPOSITION)]
67        pub content_disposition: Option<ContentDisposition>,
68    }
69
70    impl Request {
71        /// Creates a new `Request` with the given media ID and server name.
72        pub fn new(media_id: String, server_name: OwnedServerName) -> Self {
73            Self {
74                media_id,
75                server_name,
76                timeout_ms: ruma_common::media::default_download_timeout(),
77            }
78        }
79
80        /// Creates a new `Request` with the given URI.
81        pub fn from_uri(uri: &MxcUri) -> Result<Self, IdParseError> {
82            let (server_name, media_id) = uri.parts()?;
83
84            Ok(Self::new(media_id.to_owned(), server_name.to_owned()))
85        }
86    }
87
88    impl Response {
89        /// Creates a new `Response` with the given file contents.
90        pub fn new(
91            file: Vec<u8>,
92            content_type: String,
93            content_disposition: ContentDisposition,
94        ) -> Self {
95            Self {
96                file,
97                content_type: Some(content_type),
98                content_disposition: Some(content_disposition),
99            }
100        }
101    }
102}
ruma_client_api/authenticated_media/get_content.rs

ruma_client_api/authenticated_media/
get_content.rs
