Merge pull request #3574 from element-hq/feature/bma/improveMediaModel

Clarify model for Event with attachment

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/EventContent.kt

@@ -30,10 +30,14 @@ data class MessageContent(
 data object RedactedContent : EventContent
 
 data class StickerContent(
-    val body: String,
+    val filename: String,
+    val body: String?,
     val info: ImageInfo,
     val source: MediaSource,
-) : EventContent
+) : EventContent {
+    val bestDescription: String
+        get() = body ?: filename
+}
 
 data class PollContent(
     val question: String,

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/MessageType.kt

@@ -18,24 +18,37 @@ import io.element.android.libraries.matrix.api.media.VideoInfo
 @Immutable
 sealed interface MessageType
 
+@Immutable
+sealed interface MessageTypeWithAttachment : MessageType {
+    val filename: String
+    val caption: String?
+    val formattedCaption: FormattedBody?
+
+    val bestDescription: String
+        get() = caption ?: filename
+}
+
 data class EmoteMessageType(
     val body: String,
     val formatted: FormattedBody?
 ) : MessageType
 
 data class ImageMessageType(
-    val body: String,
-    val formatted: FormattedBody?,
-    val filename: String?,
+    override val filename: String,
+    override val caption: String?,
+    override val formattedCaption: FormattedBody?,
     val source: MediaSource,
     val info: ImageInfo?
-) : MessageType
+) : MessageTypeWithAttachment
 
+// FIXME This is never used in production code.
 data class StickerMessageType(
-    val body: String,
+    override val filename: String,
+    override val caption: String?,
+    override val formattedCaption: FormattedBody?,
     val source: MediaSource,
     val info: ImageInfo?
-) : MessageType
+) : MessageTypeWithAttachment
 
 data class LocationMessageType(
     val body: String,
@@ -44,31 +57,37 @@ data class LocationMessageType(
 ) : MessageType
 
 data class AudioMessageType(
-    val body: String,
+    override val filename: String,
+    override val caption: String?,
+    override val formattedCaption: FormattedBody?,
     val source: MediaSource,
     val info: AudioInfo?,
-) : MessageType
+) : MessageTypeWithAttachment
 
 data class VoiceMessageType(
-    val body: String,
+    override val filename: String,
+    override val caption: String?,
+    override val formattedCaption: FormattedBody?,
     val source: MediaSource,
     val info: AudioInfo?,
     val details: AudioDetails?,
-) : MessageType
+) : MessageTypeWithAttachment
 
 data class VideoMessageType(
-    val body: String,
-    val formatted: FormattedBody?,
-    val filename: String?,
+    override val filename: String,
+    override val caption: String?,
+    override val formattedCaption: FormattedBody?,
     val source: MediaSource,
     val info: VideoInfo?
-) : MessageType
+) : MessageTypeWithAttachment
 
 data class FileMessageType(
-    val body: String,
+    override val filename: String,
+    override val caption: String?,
+    override val formattedCaption: FormattedBody?,
     val source: MediaSource,
     val info: FileInfo?
-) : MessageType
+) : MessageTypeWithAttachment
 
 data class NoticeMessageType(
     val body: String,