NexconnChatSDK/com.nexconn.chat.message/Message

Message

public final class Message

Message class.

message's envelope class, Contains message's general Property and Message content body content. Contains message's general Property and Message content body content.

general Field (ID, Sender, When time etc.) storage In Message
specific Message content (Text, Image etc.) storage In content, Type MessageContent Subclass

Usage Example:

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

Parameters

channelIdentifier

Channel identifier, Contains Channel type and channel ID

content

Message content body, Type MessageContent or its Subclass

Constructors

Message

public Message Message(ChannelIdentifier channelIdentifier, MessageContent content)

Properties

channelId

private final String channelId

belonging to channel ID (conversation target ID).

channelIdentifier

private final ChannelIdentifier channelIdentifier

Channel identifier (Computed property).

channelType

private final ChannelType channelType

belonging to Channel type.

clientId

private final Integer clientId

Data database message table increment ID (Client Local ID).

content

private MessageContent content

Message content body

directedUserIds

private List<String> directedUserIds

Targeted user ID List (Only group chat/community (ultra group) take effect, private chat Returns null)

direction

private MessageDirection direction

Message direction (Send/Receive).

disableUpdateLastMessage

private Boolean disableUpdateLastMessage

Whether prohibit Update conversation the last messages.

hasChanged

private final Boolean hasChanged

message Whether Was/were has been modified (Only community (ultra group) message)

messageId

private final String messageId

Server unique message ID (In same AppKey under Global unique).

messageType

private final String messageType

Message type identifier (objectName), built-in Type see com.nexconn.chat.message.model.MessageType

metadata

private Map<String, String> metadata

Message expansion info List (key-value form, Supports Remote Sync).

modifyInfo

private MessageModifyInfo modifyInfo

Message edit info.

needReceipt

private Boolean needReceipt

message Whether need Read receipt.

receivedStatusInfo

private ReceivedStatus receivedStatusInfo

Message receive status Info.

senderUserId

private String senderUserId

message Sender ID

sentReceipt

private final Boolean sentReceipt

message Whether Already Send Read receipt.

sentStatus

private SendingStatus sentStatus

Message send status.

sentTime

private Long sentTime

message Send When time (Unix Timestamp, milli seconds), Server When time

subChannelId

private final String subChannelId

sub-channel ID (community (ultra group) Scenario under channel ID).

Functions

cancelDownloadingMedia

public final Unit cancelDownloadingMedia(ErrorHandler handler)

Cancel multiple Media message Download.

deleteMetadata

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

Remove message's Extended info.

download

public final Unit download(String fileUniqueId, String fileUrl, String fileName, String path, DownloadMediaFileHandler handler)

Download file (Supports resumable Pass).

downloadMedia

public final Unit downloadMedia(DownloadMediaMessageHandler handler)

Download multiple Media message.

getChannelId

public final String getChannelId()

belonging to channel ID (conversation target ID).

getChannelIdentifier

public final ChannelIdentifier getChannelIdentifier()

getChannelType

public final ChannelType getChannelType()

belonging to Channel type.

getClientId

public final Integer getClientId()

Data database message table increment ID (Client Local ID).

getContent

public final MessageContent getContent()

Message content body

getDirectedUserIds

public final List<String> getDirectedUserIds()

Targeted user ID List (Only group chat/community (ultra group) take effect, private chat Returns null)

getDirection

public final MessageDirection getDirection()

Message direction (Send/Receive).

getDisableUpdateLastMessage

public final Boolean getDisableUpdateLastMessage()

Whether prohibit Update conversation the last messages.

getHasChanged

public final Boolean getHasChanged()

message Whether Was/were has been modified (Only community (ultra group) message)

getMessageId

public final String getMessageId()

Server unique message ID (In same AppKey under Global unique).

getMessageType

public final String getMessageType()

Message type identifier (objectName), built-in Type see com.nexconn.chat.message.model.MessageType

getMetadata

public final Map<String, String> getMetadata()

Message expansion info List (key-value form, Supports Remote Sync).

getModifyInfo

public final MessageModifyInfo getModifyInfo()

Message edit info.

getNeedReceipt

public final Boolean getNeedReceipt()

message Whether need Read receipt.

getReceivedStatusInfo

public final ReceivedStatus getReceivedStatusInfo()

Message receive status Info.

getSenderUserId

public final String getSenderUserId()

message Sender ID

getSentReceipt

public final Boolean getSentReceipt()

message Whether Already Send Read receipt.

getSentStatus

public final SendingStatus getSentStatus()

Message send status.

getSentTime

public final Long getSentTime()

message Send When time (Unix Timestamp, milli seconds), Server When time

getSubChannelId

public final String getSubChannelId()

sub-channel ID (community (ultra group) Scenario under channel ID).

pauseDownloadFile

public final Unit pauseDownloadFile(String fileUniqueId, ErrorHandler handler)

pause File Download (resumable Pass Scenario).

pauseDownloadingMedia

public final Unit pauseDownloadingMedia(ErrorHandler handler)

pause multi- Media message Download.

requestSpeechToText

public final Unit requestSpeechToText(ErrorHandler handler)

request Voice message speech-to-text.

setContent

public final Unit setContent(MessageContent content)

Message content body

setDirectedUserIds

public final Unit setDirectedUserIds(List<String> directedUserIds)

Targeted user ID List (Only group chat/community (ultra group) take effect, private chat Returns null)

setDirection

public final Unit setDirection(MessageDirection direction)

Message direction (Send/Receive).

setDisableUpdateLastMessage

public final Unit setDisableUpdateLastMessage(Boolean disableUpdateLastMessage)

Whether prohibit Update conversation the last messages.

setMetadata

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

Message expansion info List (key-value form, Supports Remote Sync).

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

Update message's Extended info.

setModifyInfo

public final Unit setModifyInfo(MessageModifyInfo modifyInfo)

Message edit info.

setNeedReceipt

public final Unit setNeedReceipt(Boolean needReceipt)

message Whether need Read receipt.

setReceivedStatusInfo

public final Unit setReceivedStatusInfo(ReceivedStatus receivedStatusInfo)

Message receive status Info.

setSenderUserId

public final Unit setSenderUserId(String senderUserId)

message Sender ID

setSentStatus

public final Unit setSentStatus(SendingStatus sentStatus)

Message send status.

setSentTime

public final Unit setSentTime(Long sentTime)

message Send When time (Unix Timestamp, milli seconds), Server When time

setSpeechToTextVisible

public final Unit setSpeechToTextVisible(Boolean visible, ErrorHandler handler)

Set Voice speech-to-text Result Visibility.

toString

public String toString()