NexconnChatSDK/ai.nexconn.chat.message/Message

Message

public final class Message

Message envelope class.

Contains general message properties (ID, sender, timestamp, etc.) and the message content body content.

General fields (ID, sender, timestamp, etc.) are stored in Message.
Specific content (text, image, etc.) is stored in content as a MessageContent subclass.

val message: Message = ...
when (val content = message.content) {
    is TextMessage -> println("Text: ${content.text}")
    is ImageMessage -> println("Image: ${content.remoteUrl}")
    is FileMessage -> println("File: ${content.name}")
}

Parameters

channelIdentifier

Channel identifier containing channel type and channel ID

content

Message content body

Properties

channelIdentifier

private final ChannelIdentifier channelIdentifier

Channel identifier containing channel type and channel ID.

clientId

private final Integer clientId

Auto-increment ID in the local database message table (client-side local ID).

content

private MessageContent content

Message content body.

directedUserIds

private List<String> directedUserIds

Directed user ID list (only effective for group / community channels; null for direct channels).

direction

private MessageDirection direction

Message direction (send / receive).

disableNotification

private final Boolean disableNotification

Whether push notification is disabled for this message.

disableUpdateLastMessage

private Boolean disableUpdateLastMessage

Whether to prevent this message from updating the channel's latest message.

hasChanged

private final Boolean hasChanged

Whether the message has been modified (community channel messages only).

isCounted

private final Boolean isCounted

Whether this message is counted for unread count.

isPersisted

private final Boolean isPersisted

Whether this message is persisted in local storage.

isStatusMessage

private final Boolean isStatusMessage

Whether this is a status-only message (not stored or counted).

messageId

private final String messageId

Server-side unique message ID (globally unique within the same app).

messageType

private final String messageType

Message type identifier. See ai.nexconn.chat.message.model.MessageType for built-in types.

metadata

private Map<String, String> metadata

Message metadata in key-value format, supports remote sync.

modifyInfo

private MessageModifyInfo modifyInfo

Message modification info.

needReceipt

private Boolean needReceipt

Whether this message requires a read receipt.

receivedStatusInfo

private MessageReceivedStatusInfo receivedStatusInfo

Message received status info.

senderUserId

private String senderUserId

Sender user ID.

sentReceipt

private final Boolean sentReceipt

Whether a read receipt has been sent for this message.

sentStatus

private SentStatus sentStatus

Message sending status.

sentTime

private Long sentTime

Message sent time (Unix timestamp in milliseconds, server time).

Functions

cancelDownloadingMedia

public final Unit cancelDownloadingMedia(ErrorHandler handler)

Cancels the ongoing media download for this message.

deleteMetadata

public final Unit deleteMetadata(List<String> keys, ErrorHandler handler)

Removes message metadata by keys.

downloadMedia

public final Unit downloadMedia(DownloadMediaMessageHandler handler)

Downloads the media file attached to this message.

getChannelIdentifier

public final ChannelIdentifier getChannelIdentifier()

Channel identifier containing channel type and channel ID.

getClientId

public final Integer getClientId()

Auto-increment ID in the local database message table (client-side local ID).

getContent

public final MessageContent getContent()

Message content body.

getDirectedUserIds

public final List<String> getDirectedUserIds()

Directed user ID list (only effective for group / community channels; null for direct channels).

getDirection

public final MessageDirection getDirection()

Message direction (send / receive).

getDisableNotification

public final Boolean getDisableNotification()

Whether push notification is disabled for this message.

getDisableUpdateLastMessage

public final Boolean getDisableUpdateLastMessage()

Whether to prevent this message from updating the channel's latest message.

getHasChanged

public final Boolean getHasChanged()

Whether the message has been modified (community channel messages only).

getMessageId

public final String getMessageId()

Server-side unique message ID (globally unique within the same app).

getMessageType

public final String getMessageType()

Message type identifier. See ai.nexconn.chat.message.model.MessageType for built-in types.

getMetadata

public final Map<String, String> getMetadata()

Message metadata in key-value format, supports remote sync.

getModifyInfo

public final MessageModifyInfo getModifyInfo()

Message modification info.

getNeedReceipt

public final Boolean getNeedReceipt()

Whether this message requires a read receipt.

getReceivedStatusInfo

public final MessageReceivedStatusInfo getReceivedStatusInfo()

Message received status info.

getSenderUserId

public final String getSenderUserId()

Sender user ID.

getSentReceipt

public final Boolean getSentReceipt()

Whether a read receipt has been sent for this message.

getSentStatus

public final SentStatus getSentStatus()

Message sending status.

getSentTime

public final Long getSentTime()

Message sent time (Unix timestamp in milliseconds, server time).

isCounted

public final Boolean isCounted()

Whether this message is counted for unread count.

isPersisted

public final Boolean isPersisted()

Whether this message is persisted in local storage.

isStatusMessage

public final Boolean isStatusMessage()

Whether this is a status-only message (not stored or counted).

pauseDownloadingMedia

public final Unit pauseDownloadingMedia(ErrorHandler handler)

Pauses the ongoing media download for this message.

requestSpeechToText

public final Unit requestSpeechToText(ErrorHandler handler)

Requests speech-to-text conversion for a voice message.

requestStreamMessage

public final Unit requestStreamMessage(ErrorHandler handler)

Requests stream message content pulling.

setContent

public final Unit setContent(MessageContent content)

Message content body.

setDirectedUserIds

public final Unit setDirectedUserIds(List<String> directedUserIds)

Directed user ID list (only effective for group / community channels; null for direct channels).

setDirection

public final Unit setDirection(MessageDirection direction)

Message direction (send / receive).

setDisableUpdateLastMessage

public final Unit setDisableUpdateLastMessage(Boolean disableUpdateLastMessage)

Whether to prevent this message from updating the channel's latest message.

setMetadata

public final Unit setMetadata(Map<String, String> metadata)

Message metadata in key-value format, supports remote sync.

public final Unit setMetadata(Map<String, String> metadata, ErrorHandler handler)

Updates message metadata.

setModifyInfo

public final Unit setModifyInfo(MessageModifyInfo modifyInfo)

Message modification info.

setNeedReceipt

public final Unit setNeedReceipt(Boolean needReceipt)

Whether this message requires a read receipt.

setReceivedStatusInfo

public final Unit setReceivedStatusInfo(MessageReceivedStatusInfo receivedStatusInfo)

Message received status info.

public final Unit setReceivedStatusInfo(MessageReceivedStatusInfo receivedStatusInfo, OperationHandler<Boolean> handler)

Sets the received status of this message.

setSenderUserId

public final Unit setSenderUserId(String senderUserId)

Sender user ID.

setSentStatus

public final Unit setSentStatus(SentStatus sentStatus)

Message sending status.

setSentTime

public final Unit setSentTime(Long sentTime)

Message sent time (Unix timestamp in milliseconds, server time).

setSpeechToTextVisible

public final Unit setSpeechToTextVisible(Boolean isVisible, ErrorHandler handler)

Sets the visibility of the speech-to-text result.

toString

public String toString()