ruwuma/src/r0/media/get_content_thumbnail.rs
2019-02-06 20:36:39 +01:00

53 lines
1.7 KiB
Rust

//! [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)
use ruma_api_macros::ruma_api;
use serde::{Deserialize, Serialize};
/// 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>,
}
}