From 1e718bb44ffaae8690db05121ddc5203caf669f6 Mon Sep 17 00:00:00 2001 From: Valere Date: Thu, 25 Jun 2020 14:44:14 +0200 Subject: [PATCH] javadoc --- .../matrix/android/api/session/file/FileService.kt | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt index d5ec14f6a7..bafd4f36c6 100644 --- a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt +++ b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/file/FileService.kt @@ -50,8 +50,7 @@ interface FileService { /** * Download a file. - * Result will be a decrypted file, stored in the cache folder. id parameter will be used to create a sub folder to avoid name collision. - * You can pass the eventId + * Result will be a decrypted file, stored in the cache folder. url parameter will be used to create unique filename to avoid name collision. */ fun downloadFile( downloadMode: DownloadMode, @@ -70,9 +69,19 @@ interface FileService { */ fun getTemporarySharableURI(mxcUrl: String, mimeType: String?): Uri? + /** + * Get information on the given file. + * Mimetype should be the same one as passed to downloadFile (limitation for now) + */ fun fileState(mxcUrl: String, mimeType: String?) : FileState + /** + * Clears all the files downloaded by the service + */ fun clearCache() + /** + * Get size of cached files + */ fun getCacheSize() : Int }