stream-chat-android-compose/io.getstream.chat.android.compose.viewmodel.mediapreview/MediaGalleryPreviewViewModel

MediaGalleryPreviewViewModel

class MediaGalleryPreviewViewModel(chatClient: ChatClient, clientState: ClientState, messageId: String, skipEnrichUrl: Boolean = false) : ViewModel

A ViewModel capable of loading images, playing videos.

Parameters

chatClient

The low level chat client used for API calls.

clientState

Used to collect client state information such as the connectivity status.

messageId

The ID of the message containing the attachments to be previewed.

skipEnrichUrl

If set to true will skip enriching URLs when you update the message by deleting an attachment contained within it. Set to false by default.

Constructors

MediaGalleryPreviewViewModel

constructor(chatClient: ChatClient, clientState: ClientState, messageId: String, skipEnrichUrl: Boolean = false)

Properties

connectionState

var connectionState: ConnectionState

Represent the header title of the gallery screen.

isSharingInProgress

var isSharingInProgress: Boolean

If we are preparing a file for sharing or not.

isShowingGallery

var isShowingGallery: Boolean

Shows or hides the media gallery menu in the UI.

isShowingOptions

var isShowingOptions: Boolean

Shows or hides the media options menu and overlay in the UI.

message

var message: Message

Represents the message that we observe to show the UI data.

promptedAttachment

var promptedAttachment: Attachment?

If an attachment needs a prompt to be shared due to a large file size this value will be non-null.

user

val user: StateFlow<User?>

The currently logged in user.

Functions

deleteCurrentMediaAttachment

fun deleteCurrentMediaAttachment(currentMediaAttachment: Attachment, skipEnrichUrl: Boolean = this.skipEnrichUrl)

Deletes the current media attachment from the message we're observing, if possible.

toggleGallery

fun toggleGallery(isShowingGallery: Boolean)

Toggles if we're showing the gallery screen.

toggleMediaOptions

fun toggleMediaOptions(isShowingOptions: Boolean)

Toggles if we're showing the media options menu.

Inherited functions

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

getCloseable

fun <T : AutoCloseable> getCloseable(key: String): T?