stream-chat-android-compose/io.getstream.chat.android.compose.viewmodel.messages/AttachmentsPickerViewModel

AttachmentsPickerViewModel

class AttachmentsPickerViewModel(storageHelper: StorageHelperWrapper, channelState: StateFlow<ChannelState?>) : ViewModel

ViewModel responsible for handling the state and business logic of attachments.

Used to load file and media images that are then connected to the UI. It also keeps state of the selected items and prepares items before sending them.

Constructors

constructor(storageHelper: StorageHelperWrapper, channelState: StateFlow<ChannelState?>)

Properties

attachments

var attachments: List<AttachmentPickerItemState>

List of attachments available, from the system.

attachmentsPickerMode

var attachmentsPickerMode: AttachmentsPickerMode

Currently selected picker mode. Images, Files or MediaCapture.

channel

val channel: Channel

The information for the current Channel.

files

var files: List<AttachmentPickerItemState>

List of files available, from the system.

hasPickedAttachments

val hasPickedAttachments: Boolean

Gives us info if there are any attachment items that are selected.

hasPickedFiles

val hasPickedFiles: Boolean

Gives us info if there are any file items that are selected.

hasPickedImages

val hasPickedImages: Boolean

Gives us info if there are any image items that are selected.

images

var images: List<AttachmentPickerItemState>

List of images available, from the system.

isShowingAttachments

var isShowingAttachments: Boolean

Gives us information if we're showing the attachments picker or not.

polls

var polls: List<AttachmentPickerItemState>

List of polls available, from the system.

Functions

changeAttachmentPickerMode

fun changeAttachmentPickerMode(attachmentsPickerMode: AttachmentsPickerMode, hasPermission: () -> Boolean = { true })

Changes the currently selected AttachmentsPickerMode and loads the required data. If no permission is granted will not try and load data to avoid crashes.

changeAttachmentState

fun changeAttachmentState(showAttachments: Boolean)

Notifies the ViewModel if we should show attachments or not.

changeSelectedAttachments

fun changeSelectedAttachments(attachmentItem: AttachmentPickerItemState)

Triggered when an AttachmentMetaData is selected in the list. Added or removed from the corresponding list, be it files or images, based on attachmentsPickerMode.

dismissAttachments

fun dismissAttachments()

Triggered when we dismiss the attachments picker. We reset the state to show images and clear the items for now, until the user needs them again.

getAttachmentsFromMetaData