mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-06 06:53:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(timeline): Document media caching of send_attachment

Browse Source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille
2024-12-10 13:05:17 +01:00
committed by Benjamin Bouvier
parent 7295f29055
commit a562f73b1e
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/matrix-sdk-ui/src/timeline/mod.rs
View File

@@ -532,6 +532,12 @@ impl Timeline {
/// If the encryption feature is enabled, this method will transparently
/// encrypt the room message if the room is encrypted.
///
/// The attachment and its optional thumbnail are stored in the media cache
/// and can be retrieved at any time, by calling
/// [`Media::get_media_content()`] with the `MediaSource` that can be found
/// in the corresponding `TimelineEventItem`, and using a
/// `MediaFormat::File`.
///
/// # Arguments
///
/// * `path` - The path of the file to be sent.
@@ -540,6 +546,8 @@ impl Timeline {
///
/// * `config` - An attachment configuration object containing details about
/// the attachment like a thumbnail, its size, duration etc.
///
/// [`Media::get_media_content()`]: matrix_sdk::Media::get_media_content
#[instrument(skip_all)]
pub fn send_attachment(
&self,