urbanairship-message-center-compose/com.urbanairship.messagecenter.compose.ui/MessageCenterListState

MessageCenterListState

@Stable

class MessageCenterListState(source)

State holder for the Message Center list screen.

Properties

areAllMessagesSelected

val areAllMessagesSelected: Boolean

Whether every message in the list is selected.

highlightedMessageId

val highlightedMessageId: String?

The ID of the highlighted message, if any.

isEditing

val isEditing: Boolean

Whether the list is in editing mode.

isError

val isError: Boolean

Whether the list failed to load.

isLoading

val isLoading: Boolean

Whether the list is loading for the first time.

isRefreshing

val isRefreshing: Boolean

Whether the list is refreshing while displaying content.

messages

val messages: List<Message>

The list of messages when in content state, or an empty list otherwise.

selectedMessageIds

val selectedMessageIds: Set<String>

The IDs of the messages selected in editing mode.

Functions

delete

fun delete(messageIds: Set<String>)

Deletes the messages with the given messageIds.

deleteSelected

fun deleteSelected()

Deletes the messages selected in editing mode.

markRead

fun markRead(messageIds: Set<String>)

Marks the messages with the given messageIds as read.

markSelectedRead

fun markSelectedRead()

Marks the messages selected in editing mode as read.

refresh

fun refresh(onRefreshed: () -> Unit = {})

Refreshes the message list.

selectAll

fun selectAll()

Selects every message in the list.

selectNone

fun selectNone()

Clears the selection.

setEditing

fun setEditing(isEditing: Boolean)

Enters or exits editing mode. Exiting clears the selection.

setHighlighted

fun setHighlighted(messageId: String?)

Sets the highlighted message, or clears it if messageId is null.

setSelected

fun setSelected(messageId: String, isSelected: Boolean)

Selects or deselects the message with the given messageId in editing mode.