SendbirdUIKit-Compose/com.sendbird.uikit.core.data.model.message/UikitFileMessage

UikitFileMessage

sealed interface UikitFileMessage : UikitBaseMessage

Represents the interface for a file message in the Sendbird Compose Uikit.

Since

1.0.0

See also

Inheritors

Properties

Link copied to clipboard
val UikitFileMessage.isFile: Boolean

Returns whether the file message is a file, checked by the UikitFileMessage.type. Anything other than an image or a video is considered as a file.

Link copied to clipboard
val UikitFileMessage.isImage: Boolean

Returns whether the file message is an image, checked by the UikitFileMessage.type. 'svg' type is not considered as an image.

Link copied to clipboard
val UikitFileMessage.isVideo: Boolean

Returns whether the file message is a video, checked by the UikitFileMessage.type.

Link copied to clipboard
val UikitFileMessage.originalCacheKey: String

Returns the cache key for the original image.

Link copied to clipboard
abstract val params: <Error class: unknown class>?

The params used in sending the file message. This is only available when the message is not sent. It will be null if the message is sent successfully.

Link copied to clipboard
abstract val plainUrl: String

The plain url of the file. This is the plain url without the auth key.

Link copied to clipboard
abstract val thumbnail: <Error class: unknown class>?

The thumbnail of the file.

Link copied to clipboard
val UikitFileMessage.thumbnailCacheKey: String

Returns the cache key for the thumbnail image.

Link copied to clipboard
abstract val type: String

The mime type of the file.

Link copied to clipboard
abstract val url: String

The url of the file. The url differs from the plainUrl in that it contains the auth key if the file requires authentication.

Functions

Link copied to clipboard
fun UikitFileMessage?.displayFileMessage(): String

Returns the display message for the file message.

Link copied to clipboard
@Composable
fun UikitFileMessage.fileIcon(): Painter

Returns the icon for the file message which are not images or videos.

Link copied to clipboard
fun UikitFileMessage.fileName(): String

Returns the file name for the file message or the default file name if the message is empty.

Link copied to clipboard
fun UikitFileMessage.originalMediaInfo(): MediaInfo

Returns the original MediaInfo for the file message.

Link copied to clipboard
fun UikitFileMessage.thumbnailMediaInfo(): MediaInfo

Returns the thumbnail MediaInfo for the file message.