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

UikitBaseMessage

sealed interface UikitBaseMessage

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

Since

1.0.0

See also

ChatBaseMessage

CustomizableBaseMessage

EmptyBaseMessage

Inheritors

ChatBaseMessage

ChatUnknownMessage

CustomizableBaseMessage

EmptyBaseMessage

UikitAdminMessage

UikitFileMessage

UikitTimelineMessage

UikitUserMessage

Properties

abstract val createdAt: Long

The created timestamp of the message.

val UikitBaseMessage.isMine: Boolean

Checks if the UikitBaseMessage is sent by the current user.

abstract val isResendable: Boolean

The flag that indicates whether the message is resendable.

abstract val message: String

The message of the message.

abstract val messageId: Long

The message id of the message. This is set when the message is sent successfully.

abstract val requestId: String

The request id of the message. This is used to identify the message when the message is not sent yet (sendingStatus != SendingStatus.SUCCEEDED)

abstract val sender: UikitSender?

The sender of the message.

abstract val sendingStatus: <Error class: unknown class>

The sending status of the message.

undeliveredMemberCount

abstract val undeliveredMemberCount: Int

The undelivered member count of the message.

open val uniqueId: String

The unique id of the message. This is set to messageId if the message is sent successfully, otherwise requestId.

unreadMemberCount

abstract val unreadMemberCount: Int

The unread member count of the message.

abstract val updatedAt: Long

The updated timestamp of the message.

Functions

fun UikitBaseMessage?.displayMessage(): String

Returns the last message's display message to be shown in the channel list.

messageGroupingPosition

fun UikitBaseMessage.messageGroupingPosition(prevMessage: UikitBaseMessage?, nextMessage: UikitBaseMessage?): MessageGroupingPosition

Returns the message grouping position based on the previous and next messages. If the message is not sent successfully, it returns MessageGroupingPosition.Single. If the message is the head of the group, it returns MessageGroupingPosition.Head. If the message is the tail of the group, it returns MessageGroupingPosition.Tail. If the message is the only message in the group, it returns MessageGroupingPosition.Single.

fun UikitBaseMessage.nickname(): String

Returns the nickname of the sender or the unknown text if the sender is null.

fun UikitBaseMessage.profileUrl(): Any

Returns the profile url of the sender or an empty string if the sender is null.

fun UikitBaseMessage.sentAt(): String

Returns the sent time of the message in date time format.

fun UikitBaseMessage.uiType(): MessageType

Returns the MessageType based on the message.

fun UikitBaseMessage.unknown(mainColor: Color, subColor: Color): AnnotatedString

Returns the text for the unknown message type.