stream-chat-android-ui-common/io.getstream.chat.android.ui.common.state.messages.list

Package-level declarations

Types

AudioPlayerState

data class AudioPlayerState(val current: AudioPlayerState.CurrentAudioState = CurrentAudioState(), val seekTo: IntFloatMap = intFloatMapOf())

Represents the state of the audio player.

data class CancelGiphy(val message: Message) : GiphyAction

Cancel the ephemeral message.

CustomModerationOption

data class CustomModerationOption(val text: Int, val extraData: Map<String, Any> = emptyMap()) : ModeratedMessageOption

Custom actions that you can define for moderated messages.

DateSeparatorItemState

data class DateSeparatorItemState(val date: Date) : MessageListItemState

Represents a date separator inside the message list.

DeletedMessageVisibility

enum DeletedMessageVisibility : Enum<DeletedMessageVisibility>

Intended to be used for regulating visibility of deleted messages and filtering them out accordingly.

object DeleteMessage : ModeratedMessageOption

Prompts the user to delete the message if the message was flagged by moderation.

object EditMessage : ModeratedMessageOption

Prompts the user to edit the message if the message was flagged by moderation.

EmptyThreadPlaceholderItemState

data object EmptyThreadPlaceholderItemState : MessageListItemState

Represents an empty thread placeholder item inside thread messages list.

sealed class GiphyAction

Represents the list of actions users can take with ephemeral giphy messages.

HasMessageListItemState

sealed class HasMessageListItemState : MessageListItemState

Represents either regular or system message item inside a message list.

object MessageFocused : MessageFocusState

Represents the state when the message is currently being focused.

MessageFocusRemoved

object MessageFocusRemoved : MessageFocusState

Represents the state when we've removed the focus from the message.

MessageFocusState

sealed class MessageFocusState

Represents the message focus state, in case the user jumps to a message.

MessageFooterVisibility

sealed class MessageFooterVisibility

Intended to be used for regulating the visibility of a single message footer visibility.

MessageItemState

data class MessageItemState(val message: Message = Message(), val parentMessageId: String? = null, val isMine: Boolean = false, val isInThread: Boolean = false, val showMessageFooter: Boolean = false, val currentUser: User? = null, val groupPosition: List<MessagePosition> = listOf(MessagePosition.NONE), val isMessageRead: Boolean = false, val deletedMessageVisibility: DeletedMessageVisibility = DeletedMessageVisibility.ALWAYS_HIDDEN, val focusState: MessageFocusState? = null, val messageReadBy: List<ChannelUserRead> = emptyList()) : HasMessageListItemState

Represents a message item inside the messages list.

MessageListItemState

sealed class MessageListItemState

Represents a list item inside a message list.

MessageListState

data class MessageListState(val messageItems: List<MessageListItemState> = emptyList(), val endOfNewMessagesReached: Boolean = true, val endOfOldMessagesReached: Boolean = false, val isLoading: Boolean = false, val isLoadingNewerMessages: Boolean = false, val isLoadingOlderMessages: Boolean = false, val currentUser: User? = User(), val parentMessageId: String? = null, val unreadCount: Int = 0, val newMessageState: NewMessageState? = null, val selectedMessageState: SelectedMessageState? = null)

Holds the state of the messages list screen.

MessageOptionsUserReactionAlignment

enum MessageOptionsUserReactionAlignment : Enum<MessageOptionsUserReactionAlignment>

Determines the alignment of the reaction icon inside user reactions.

MessagePosition

enum MessagePosition : Enum<MessagePosition>

Represents the group position of a message, if the message is in a group. Otherwise represented as NONE.

ModeratedMessageOption

sealed class ModeratedMessageOption

Represents possible options user can take upon moderating a message.

data class MyOwn(val ts: Long?) : NewMessageState

If the message is our own (we sent it), we scroll to the bottom of the list.

NewMessageState

sealed class NewMessageState

Represents the state when a new message arrives to the channel.

data class Other(val ts: Long?) : NewMessageState

If the message is someone else's (we didn't send it), we show a "New message" bubble.

SelectedMessageFailedModerationState

data class SelectedMessageFailedModerationState(val message: Message, val ownCapabilities: Set<String>) : SelectedMessageState

Represents a state when the moderated message was selected.

SelectedMessageOptionsState

data class SelectedMessageOptionsState(val message: Message, val ownCapabilities: Set<String>) : SelectedMessageState

Represents a state when a message was selected.

SelectedMessageReactionsPickerState

data class SelectedMessageReactionsPickerState(val message: Message, val ownCapabilities: Set<String>) : SelectedMessageState

Represents a state when the show more reactions button was clicked.

SelectedMessageReactionsState

data class SelectedMessageReactionsState(val message: Message, val ownCapabilities: Set<String>) : SelectedMessageState

Represents a state when message reactions were selected.

SelectedMessageState

sealed class SelectedMessageState

Represents a state when a message or its reactions were selected.

object SendAnyway : ModeratedMessageOption

Prompts the user to send the message anyway if the message was flagged by moderation.

data class SendGiphy(val message: Message) : GiphyAction

Send the selected giphy message to the channel.

data class ShuffleGiphy(val message: Message) : GiphyAction

Perform the giphy shuffle operation.

StartOfTheChannelItemState

data class StartOfTheChannelItemState(val channel: Channel) : MessageListItemState

Represents the start of the channel inside a message list.

SystemMessageItemState

data class SystemMessageItemState(val message: Message) : HasMessageListItemState

Represents a system message inside the message list.

ThreadDateSeparatorItemState

data class ThreadDateSeparatorItemState(val date: Date, val replyCount: Int) : MessageListItemState

Represents a date separator inside thread messages list.

TypingItemState

data class TypingItemState(val typingUsers: List<User>) : MessageListItemState

Represents a typing indicator item inside a message list.

UnreadSeparatorItemState

data class UnreadSeparatorItemState(val unreadCount: Int) : MessageListItemState

Represents an unread separator item inside a message list.

Functions

defaultMessageModerationOptions

fun defaultMessageModerationOptions(): List<ModeratedMessageOption>

Inherited functions

getUserReactionAlignment

fun Int.getUserReactionAlignment(): MessageOptionsUserReactionAlignment

isStartAlignment

fun MessageOptionsUserReactionAlignment.isStartAlignment(isMine: Boolean): Boolean

Determines if the user reaction should be aligned to start or end.

fun MessageListItemState.stringify(): String

Returns a string representation of the MessageListItemState.