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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
//! Endpoints for the media repository.
/// [GET /_matrix/media/r0/download/{serverName}/{mediaId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-media-r0-download-servername-mediaid)
pub mod get_content {
use ruma_api_macros::ruma_api;
ruma_api! {
metadata {
description: "Retrieve content from the media store.",
method: GET,
name: "get_media_content",
path: "/_matrix/media/r0/download/:server_name/:media_id",
rate_limited: false,
requires_authentication: false,
}
request {
/// The media ID from the mxc:// URI (the path component).
#[ruma_api(path)]
pub media_id: String,
/// The server name from the mxc:// URI (the authoritory component).
#[ruma_api(path)]
pub server_name: String,
}
response {
/// The content that was previously uploaded.
#[ruma_api(body)]
pub file: Vec<u8>,
/// The content type of the file that was previously uploaded.
#[ruma_api(header = "CONTENT_TYPE")]
pub content_type: String,
/// The name of the file that was previously uploaded, if set.
#[ruma_api(header = "CONTENT_DISPOSITION")]
pub content_disposition: String,
}
}
}
/// [POST /_matrix/media/r0/upload](https://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-media-r0-upload)
pub mod create_content {
use ruma_api_macros::ruma_api;
ruma_api! {
metadata {
description: "Upload content to the media store.",
method: POST,
name: "create_media_content",
path: "/_matrix/media/r0/upload",
rate_limited: false,
requires_authentication: false,
}
request {
/// The content type of the file being uploaded.
#[ruma_api(header = "CONTENT_TYPE")]
pub content_type: String,
}
response {
/// The MXC URI for the uploaded content.
pub content_uri: String,
}
}
}
/// [GET /_matrix/media/r0/thumbnail/{serverName}/{mediaId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-media-r0-thumbnail-servername-mediaid)
pub mod get_content_thumbnail {
use ruma_api_macros::ruma_api;
/// The desired resizing method.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub enum Method {
/// Crop the original to produce the requested image dimensions.
#[serde(rename = "crop")]
Crop,
/// Maintain the original aspect ratio of the source image.
#[serde(rename = "scale")]
Scale,
}
ruma_api! {
metadata {
description: "Get a thumbnail of content from the media store.",
method: GET,
name: "get_content_thumbnail",
path: "/_matrix/media/r0/thumbnail/:server_name/:media_id",
rate_limited: false,
requires_authentication: false,
}
request {
/// The media ID from the mxc:// URI (the path component).
#[ruma_api(path)]
pub media_id: String,
/// The server name from the mxc:// URI (the authoritory component).
#[ruma_api(path)]
pub server_name: String,
/// The *desired* height of the thumbnail. The actual thumbnail may not match the size
/// specified.
#[ruma_api(query)]
pub height: Option<u64>,
/// The desired resizing method.
#[ruma_api(query)]
pub method: Option<Method>,
/// The *desired* width of the thumbnail. The actual thumbnail may not match the size
/// specified.
#[ruma_api(query)]
pub width: Option<u64>,
}
response {
/// A thumbnail of the requested content.
#[ruma_api(body)]
pub file: Vec<u8>,
}
}
}