继承自 io.agora.chat.EMBase< T >, Parcelable , 以及 Cloneable .

类
enum	ChatType

enum	Direct

enum	Status

enum	Type

Public 成员函数
Status	status ()

void	setStatus (Status status)

Type	getType ()

synchronized MessageBody	getBody ()

long	getMsgTime ()

void	setMsgTime (long msgTime)

long	localTime ()

void	setLocalTime (long serverTime)

boolean	isNeedGroupAck ()

void	setIsNeedGroupAck (boolean need)

int	groupAckCount ()

void	setGroupAckCount (int count)

void	setIsChatThreadMessage (boolean isChatThreadMessage)

boolean	isChatThreadMessage ()

ChatThread	getChatThread ()

void	setBody (MessageBody body)

void	addBody (MessageBody body)

String	getFrom ()

void	setFrom (String from)

String	getRecaller ()

void	setTo (String to)

String	getTo ()

String	getMsgId ()

void	setMsgId (String msgId)

synchronized void	setMessageStatusCallback (CallBack callback)

void	setAttribute (String attribute, boolean value)

void	setAttribute (String attribute, int value)

void	setAttribute (String attribute, long value)

void	setAttribute (String attribute, float value)

void	setAttribute (String attribute, double value)

void	setAttribute (String attribute, JSONObject value)

void	setAttribute (String attribute, JSONArray value)

void	setAttribute (String attribute, String value)

boolean	getBooleanAttribute (String attribute) throws ChatException

boolean	getBooleanAttribute (String attribute, boolean defaultValue)

int	getIntAttribute (String attribute, int defaultValue)

long	getLongAttribute (String attribute, long defaultValue)

float	getFloatAttribute (String attribute, float defaultValue)

double	getDoubleAttribute (String attribute, double defaultValue)

int	getIntAttribute (String attribute) throws ChatException

long	getLongAttribute (String attribute) throws ChatException

float	getFloatAttribute (String attribute) throws ChatException

double	getDoubleAttribute (String attribute) throws ChatException

String	getStringAttribute (String attribute) throws ChatException

String	getStringAttribute (String attribute, String defaultValue)

JSONObject	getJSONObjectAttribute (String attribute) throws ChatException

JSONArray	getJSONArrayAttribute (String attribute) throws ChatException

ChatType	getChatType ()

void	setChatType (ChatType chatType)

boolean	isAcked ()

void	setAcked (boolean isAcked)

boolean	isDelivered ()

void	setDelivered (boolean isDelivered)

boolean	isUnread ()

void	setUnread (boolean unread)

boolean	isListened ()

void	setListened (boolean isListened)

String	getUserName ()

void	setDeliverAcked (boolean isDeliverAcked)

int	progress ()

void	setProgress (int progress)

Direct	direct ()

void	setDirection (Direct dir)

String	conversationId ()

Map< String, Object >	ext ()

Map< String, Object >	getAttributes ()

List< MessageReaction >	getMessageReaction ()

boolean	isOnlineState ()

void	setPriority (ChatRoomMessagePriority priority)

boolean	isDeliverOnlineOnly ()

void	deliverOnlineOnly (boolean onlineOnly)

void	setReceiverList (List< String > receiverList)

List< String >	receiverList ()

boolean	isBroadcast ()

boolean	isContentReplaced ()

MessagePinInfo	pinnedInfo ()

静态 Public 成员函数
static ChatMessage	createSendMessage (Type type)

static ChatMessage	createReceiveMessage (Type type)

static ChatMessage	createTxtSendMessage (String content, String username)

static ChatMessage	createTextSendMessage (String content, String username)

static ChatMessage	createVoiceSendMessage (String filePath, int timeLength, String username)

static ChatMessage	createVoiceSendMessage (Uri filePath, int timeLength, String username)

static ChatMessage	createImageSendMessage (String filePath, boolean sendOriginalImage, String username)

static ChatMessage	createImageSendMessage (Uri imgUri, boolean sendOriginalImage, String username)

static ChatMessage	createVideoSendMessage (String videofilePath, String imageThumbPath, int timeLength, String username)

static ChatMessage	createVideoSendMessage (Uri videofilePath, String imageThumbPath, int timeLength, String username)

static ChatMessage	createVideoSendMessage (Uri videofilePath, Uri imageThumbPath, int timeLength, String username)

static ChatMessage	createLocationSendMessage (double latitude, double longitude, String locationAddress, String buildingName, String username)

static ChatMessage	createLocationSendMessage (double latitude, double longitude, String locationAddress, String username)

static ChatMessage	createFileSendMessage (String filePath, String username)

static ChatMessage	createFileSendMessage (Uri filePath, String username)

static ChatMessage	createCombinedSendMessage (String title, String summary, String compatibleText, List< String > messageIdList, String userId)

详细描述

消息对象，表示一条发送或接收到的消息。

例如：构造一条文本发送消息：

ChatMessage msg = ChatMessage.createSendMessage(ChatMessage.Type.TXT);
msg.setTo("user1");
TextMessageBody body = new TextMessageBody("hello from hyphenate sdk");
msg.addBody(body);

构造一条图片消息：

ChatMessage msg = ChatMessage.createSendMessage(ChatMessage.Type.IMAGE);
msg.setTo("user1");
ImageMessageBody body = new ImageMessageBody(imageFileUrl);
msg.addBody(body);

成员函数说明

◆ addBody()

void io.agora.chat.ChatMessage.addBody ( MessageBody body )

添加消息体。

本方法与设置消息体 ChatMessage#setBody(MessageBody) 的方法效果相同。推荐使用后者。

只支持一条消息添加一个消息体。

参数

body 消息体。

◆ conversationId()

String io.agora.chat.ChatMessage.conversationId ( )

获取会话 ID。

返回: 会话 ID。

◆ createCombinedSendMessage()

static ChatMessage io.agora.chat.ChatMessage.createCombinedSendMessage	(	String	title,
		String	summary,
		String	compatibleText,
		List< String >	messageIdList,
		String	userId
	)

static

创建一个合并转发消息的发送消息。

对于不支持合并转发消息的 SDK 版本，该类消息会被解析为文本 Type#TXT 消息，消息内容为 compatibleText 携带的内容，其他字段会被忽略。

参数

title	合并消息的标题。该字段可以设置为 `null` 或者空字符串。
summary	合并消息的概要。该字段可以设置为 `null` 或者空字符串。
compatibleText	合并消息的兼容信息。该字段可以设置为 `null` 或者空字符串。该字段用于需要兼容不支持合并转发消息的版本。
messageIdList	合并消息的消息 ID 列表。列表不可为`null`或者空，最多可包含 300 个消息 ID。调用 ChatManager#sendMessage(ChatMessage) 方法发送消息会检查该字段的设置。
userId	消息接收方。该字段的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 合并转发消息对象。

◆ createFileSendMessage() [1/2]

static ChatMessage io.agora.chat.ChatMessage.createFileSendMessage	(	String	filePath,
		String	username
	)

static

创建一个普通文件发送消息。

参数

filePath	文件路径。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createFileSendMessage() [2/2]

static ChatMessage io.agora.chat.ChatMessage.createFileSendMessage	(	Uri	filePath,
		String	username
	)

static

创建一个普通文件发送消息。

参数

filePath	文件路径。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createImageSendMessage() [1/2]

static ChatMessage io.agora.chat.ChatMessage.createImageSendMessage	(	String	filePath,
		boolean	sendOriginalImage,
		String	username
	)

static

创建一个图片发送消息。

参数

filePath	图片路径。
sendOriginalImage	是否发送原图： `true`：发送原图。 `false`：若图片小于 100 KB，发送原图；若图片大于等于 100 KB, 发送压缩后的图片。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createImageSendMessage() [2/2]

static ChatMessage io.agora.chat.ChatMessage.createImageSendMessage	(	Uri	imgUri,
		boolean	sendOriginalImage,
		String	username
	)

static

创建一个图片发送消息。

参数

imgUri	图片 URI。
sendOriginalImage	是否发送原图： `true`：发送原图。 `false`：若图片小于 100 KB，发送原图；若图片大于等于 100 KB, 发送压缩后的图片。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createLocationSendMessage() [1/2]

static ChatMessage io.agora.chat.ChatMessage.createLocationSendMessage	(	double	latitude,
		double	longitude,
		String	locationAddress,
		String	buildingName,
		String	username
	)

static

创建一个位置发送消息。

参数

latitude	纬度。
longitude	经度。
locationAddress	位置详情。
buildingName	建筑物名称。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createLocationSendMessage() [2/2]

static ChatMessage io.agora.chat.ChatMessage.createLocationSendMessage	(	double	latitude,
		double	longitude,
		String	locationAddress,
		String	username
	)

static

创建一个位置发送消息。

参数

latitude	纬度。
longitude	经度。
locationAddress	位置详情。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createReceiveMessage()

static ChatMessage io.agora.chat.ChatMessage.createReceiveMessage ( Type type )

static

创建一个接收消息。

参数

type 消息类型。

返回: 消息对象。

◆ createSendMessage()

static ChatMessage io.agora.chat.ChatMessage.createSendMessage ( Type type )

static

创建一个发送消息。

参数

type 消息类型。

返回: 消息对象。

◆ createTextSendMessage()

static ChatMessage io.agora.chat.ChatMessage.createTextSendMessage	(	String	content,
		String	username
	)

static

创建一个文本发送消息。

参数

content	文本内容。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createTxtSendMessage()

static ChatMessage io.agora.chat.ChatMessage.createTxtSendMessage	(	String	content,
		String	username
	)

static

创建一个文本发送消息。

参数

content	文本内容。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

弃用:: 已废弃。请用 createTextSendMessage(String, String) 代替。

◆ createVideoSendMessage() [1/3]

static ChatMessage io.agora.chat.ChatMessage.createVideoSendMessage	(	String	videofilePath,
		String	imageThumbPath,
		int	timeLength,
		String	username
	)

static

创建一个视频发送消息。

参数

videofilePath	视频文件路径。
imageThumbPath	视频第一帧图缩略图。
timeLength	视频时间长度，单位为秒。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createVideoSendMessage() [2/3]

static ChatMessage io.agora.chat.ChatMessage.createVideoSendMessage	(	Uri	videofilePath,
		String	imageThumbPath,
		int	timeLength,
		String	username
	)

static

创建一个视频发送消息。

参数

videofilePath	视频文件路径。
imageThumbPath	视频第一帧图缩略图。
timeLength	视频时间长度，单位为秒。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createVideoSendMessage() [3/3]

static ChatMessage io.agora.chat.ChatMessage.createVideoSendMessage	(	Uri	videofilePath,
		Uri	imageThumbPath,
		int	timeLength,
		String	username
	)

static

创建一个视频发送消息。

参数

videofilePath	视频文件路径。
imageThumbPath	视频第一帧图缩略图。
timeLength	视频时间长度，单位为秒。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createVoiceSendMessage() [1/2]

static ChatMessage io.agora.chat.ChatMessage.createVoiceSendMessage	(	String	filePath,
		int	timeLength,
		String	username
	)

static

创建一个语音发送消息。

参数

filePath	语音文件路径。
timeLength	语音时间长度，单位为秒。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ createVoiceSendMessage() [2/2]

static ChatMessage io.agora.chat.ChatMessage.createVoiceSendMessage	(	Uri	filePath,
		int	timeLength,
		String	username
	)

static

创建一个语音发送消息。

参数

filePath	语音文件 URI。
timeLength	语音时间长度，单位为秒。
username	消息接收方的设置取决于会话类型：单聊：对方用户 ID。群聊：群组 ID。子区会话：子区 ID。聊天室聊天：聊天室 ID。

返回: 消息对象。

◆ deliverOnlineOnly()

void io.agora.chat.ChatMessage.deliverOnlineOnly ( boolean onlineOnly )

设置消息是否只投递给在线用户。

参数

onlineOnly

消息是否只投递给在线用户：

true：只有消息接收方在线时才能投递成功。若接收方离线，则消息会被丢弃。
false（默认）：如果用户在线，则直接投递；如果用户离线，消息会在用户上线时投递。

◆ direct()

Direct io.agora.chat.ChatMessage.direct ( )

消息方向。

SEND：该消息是当前用户发送出去的。
RECEIVE：该消息是当前用户接收到的。

返回: 发送或接收，详见 Direct。

◆ ext()

Map< String, Object > io.agora.chat.ChatMessage.ext ( )

获取消息包含的全部扩展字段。

返回: 消息的全部扩展字段，以 Map<String, Object> 形式返回。返回 Entry.value 的具体类型有 Boolean, Integer, Long, Float, Double, String。输入 JsonObject 的属性，map 结构返回时属性是 String。

◆ getAttributes()

Map< String, Object > io.agora.chat.ChatMessage.getAttributes ( )

获取消息包含的全部扩展字段。

返回: 消息的全部扩展字段，以 Map<String, Object> 形式返回，其中 Entry.value 可为 Boolean、Integer、Long、Float、Double、String、JsonObject、或 JsonArray 类型。

◆ getBody()

synchronized MessageBody io.agora.chat.ChatMessage.getBody ( )

获取消息体。

返回: 消息体。

◆ getBooleanAttribute() [1/2]

boolean io.agora.chat.ChatMessage.getBooleanAttribute ( String attribute ) throws ChatException

获取 Boolean 类型的消息扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getBooleanAttribute() [2/2]

boolean io.agora.chat.ChatMessage.getBooleanAttribute	(	String	attribute,
		boolean	defaultValue
	)

获取 Boolean 类型的消息扩展属性。

参数

attribute	属性名。
defaultValue	属性的默认值。

返回: 属性值。

◆ getChatThread()

ChatThread io.agora.chat.ChatMessage.getChatThread ( )

获取子区概览信息。

子区概览信息仅在创建子区后携带。

返回: 子区概览信息。

◆ getChatType()

ChatType io.agora.chat.ChatMessage.getChatType ( )

获取聊天类型。

返回: 聊天类型。

◆ getDoubleAttribute() [1/2]

double io.agora.chat.ChatMessage.getDoubleAttribute ( String attribute ) throws ChatException

获取消息的 Double 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getDoubleAttribute() [2/2]

double io.agora.chat.ChatMessage.getDoubleAttribute	(	String	attribute,
		double	defaultValue
	)

获取消息的 Double 类型扩展属性。

参数

attribute	属性名。
defaultValue	属性的默认值。

返回: 属性值。

◆ getFloatAttribute() [1/2]

float io.agora.chat.ChatMessage.getFloatAttribute ( String attribute ) throws ChatException

获取消息的 Float 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getFloatAttribute() [2/2]

float io.agora.chat.ChatMessage.getFloatAttribute	(	String	attribute,
		float	defaultValue
	)

获取消息的 Float 类型扩展属性。

参数

attribute	属性名。
defaultValue	属性的默认值。

返回: 属性值。

◆ getFrom()

String io.agora.chat.ChatMessage.getFrom ( )

获取消息发送方的用户 ID。

返回: 用户 ID。

◆ getIntAttribute() [1/2]

int io.agora.chat.ChatMessage.getIntAttribute ( String attribute ) throws ChatException

获取消息的 Int 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getIntAttribute() [2/2]

int io.agora.chat.ChatMessage.getIntAttribute	(	String	attribute,
		int	defaultValue
	)

获取消息的 Int 类型扩展属性。

参数

attribute	属性名。
defaultValue	默认值。

返回: 属性值。

◆ getJSONArrayAttribute()

JSONArray io.agora.chat.ChatMessage.getJSONArrayAttribute ( String attribute ) throws ChatException

获取消息的 JSONArray 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getJSONObjectAttribute()

JSONObject io.agora.chat.ChatMessage.getJSONObjectAttribute ( String attribute ) throws ChatException

获取消息的 JSONObject 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getLongAttribute() [1/2]

long io.agora.chat.ChatMessage.getLongAttribute ( String attribute ) throws ChatException

获取消息的 Long 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getLongAttribute() [2/2]

long io.agora.chat.ChatMessage.getLongAttribute	(	String	attribute,
		long	defaultValue
	)

获取消息的 Long 类型扩展属性。

参数

attribute	属性名。
defaultValue	属性的默认值。

返回: 属性值。

◆ getMessageReaction()

List< MessageReaction > io.agora.chat.ChatMessage.getMessageReaction ( )

获取 Reaction 列表。

返回: Reaction 列表。

◆ getMsgId()

String io.agora.chat.ChatMessage.getMsgId ( )

获取消息的 ID。

返回: 消息 ID。

◆ getMsgTime()

long io.agora.chat.ChatMessage.getMsgTime ( )

获取消息的服务器时间戳。

该时间戳为服务器接收消息的时间。

返回: 服务器接收消息的时间戳。

◆ getRecaller()

String io.agora.chat.ChatMessage.getRecaller ( )

获取消息撤回者的用户 ID。

返回: 撤回者用户 ID。

◆ getStringAttribute() [1/2]

String io.agora.chat.ChatMessage.getStringAttribute ( String attribute ) throws ChatException

获取消息的 String 类型扩展属性。

参数

attribute 属性名。

返回: 属性值。

异常

ChatException 如果有异常会在这里抛出，包含错误码和异常原因。详见 Error。

◆ getStringAttribute() [2/2]

String io.agora.chat.ChatMessage.getStringAttribute	(	String	attribute,
		String	defaultValue
	)

获取消息的 String 类型扩展属性。

参数

attribute	属性名。
defaultValue	默认值。

返回: 属性值。

◆ getTo()

String io.agora.chat.ChatMessage.getTo ( )

获取消息接收方。

单聊：消息接收方的用户 ID。
群聊：群组 ID。
聊天室：聊天室 ID。

返回: 消息接收方。

◆ getType()

Type io.agora.chat.ChatMessage.getType ( )

获取消息类型。

返回: 消息类型。

◆ getUserName()

String io.agora.chat.ChatMessage.getUserName ( )

获取消息的对端用户：

对于发送的消息，单聊为接收方的用户 ID，群聊为群组 ID，聊天室为聊天室 ID。
对于接收的消息，对于接收的消息来说，单聊、群聊和聊天室聊天均为发送方的用户 ID。

返回: 消息接收方。

◆ groupAckCount()

int io.agora.chat.ChatMessage.groupAckCount ( )

群消息已读人数。

返回: 消息已读人数。

◆ isAcked()

boolean io.agora.chat.ChatMessage.isAcked ( )

获取对方是否已读。

返回: 消息是否已读： -true：已读。 -false：未读。

◆ isBroadcast()

boolean io.agora.chat.ChatMessage.isBroadcast ( )

是否是聊天室全局广播消息。

true：是；
false：否。

返回: 是否是聊天室全局广播消息。

◆ isChatThreadMessage()

boolean io.agora.chat.ChatMessage.isChatThreadMessage ( )

获取消息是否是子区消息。

返回

返回是否是子区消息的结果。

true表示是子区消息；
false表示不是子区消息。

◆ isContentReplaced()

boolean io.agora.chat.ChatMessage.isContentReplaced ( )

消息内容是否被替换过。

true：是；
false：否。

返回: 消息内容是否被替换过。

◆ isDelivered()

boolean io.agora.chat.ChatMessage.isDelivered ( )

获取消息是否成功送达。

返回

消息是否成功送达。

true：已送达。
false：未送达。

◆ isDeliverOnlineOnly()

boolean io.agora.chat.ChatMessage.isDeliverOnlineOnly ( )

判断消息是否只投递在线用户。

返回

- true：只投递在线用户。

false：投递所有用户。

◆ isListened()

boolean io.agora.chat.ChatMessage.isListened ( )

获取语音消息是否已听。

返回

语音是否已听：

true：已听；
false：未听。

◆ isNeedGroupAck()

boolean io.agora.chat.ChatMessage.isNeedGroupAck ( )

消息是否需要群组已读回执。

返回

消息是否需要群组已读回执

true：需要已读回执；
false：不需要已读回执。

◆ isOnlineState()

boolean io.agora.chat.ChatMessage.isOnlineState ( )

是否为在线消息。

注解: 该字段标记服务器下发消息时判断用户是在线还是离线的状态。

该字段为服务器下发字段，不在本地数据库中存储。对于从数据库读取的消息或拉取的漫游消息，该字段的值默认为 true。

返回

是否为在线消息。

（默认）true：是。
false：否。

◆ isUnread()

boolean io.agora.chat.ChatMessage.isUnread ( )

检查消息是否未读。

返回

消息是否未读。

true: 未读；
false: 已读。

◆ localTime()

long io.agora.chat.ChatMessage.localTime ( )

获取消息的本地时间戳。

该时间戳为消息的本地创建时间戳。

返回: 消息的本地时间戳。

◆ pinnedInfo()

MessagePinInfo io.agora.chat.ChatMessage.pinnedInfo ( )

获取消息的置顶详情。

返回: 消息的置顶详情。

◆ progress()

int io.agora.chat.ChatMessage.progress ( )

消息中的附件的上传或者下载进度。

消息附件的缩略图不涉及进度信息。

返回: 消息中的附件的上传或者下载进度，取值范围为 [0,100]。

◆ receiverList()

List< String > io.agora.chat.ChatMessage.receiverList ( )

定向消息的接收方。

返回: 定向消息的接收方。

◆ setAcked()

void io.agora.chat.ChatMessage.setAcked ( boolean isAcked )

设置对方是否已读。

该方法由 SDK 调用，而非开发者。

参数

isAcked 消息是否已读： -true：已读。 -false：未读。

◆ setAttribute() [1/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		boolean	value
	)

设置消息的 Boolean 类型的扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [2/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		double	value
	)

设置消息的 Double 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [3/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		float	value
	)

设置消息的 Float 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [4/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		int	value
	)

设置消息的 Int 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [5/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		JSONArray	value
	)

设置消息的 JSONArray 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [6/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		JSONObject	value
	)

设置消息的 JSONObject 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [7/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		long	value
	)

设置消息的 Long 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setAttribute() [8/8]

void io.agora.chat.ChatMessage.setAttribute	(	String	attribute,
		String	value
	)

设置消息的 String 类型扩展属性。

参数

attribute	属性名。
value	属性值。

◆ setBody()

void io.agora.chat.ChatMessage.setBody ( MessageBody body )

（建议方法）设置消息体。

参数

body 消息体。

◆ setChatType()

void io.agora.chat.ChatMessage.setChatType ( ChatType chatType )

设置聊天类型。

参数

chatType 聊天类型，默认为单聊。详见 ChatType。

◆ setDeliverAcked()

void io.agora.chat.ChatMessage.setDeliverAcked ( boolean isDeliverAcked )

设置消息已送达标记。

开发者不要调用，由 SDK 内部调用。

参数

isDeliverAcked

消息是否已送达对端用户：

true：消息已送达。
false：消息未送达。

◆ setDelivered()

void io.agora.chat.ChatMessage.setDelivered ( boolean isDelivered )

设置消息是否成功送达。

该方法由 SDK 调用，而非开发者。

参数

isDelivered

消息是否成功送达。

true：已送达。
false：未送达。

◆ setDirection()

void io.agora.chat.ChatMessage.setDirection ( Direct dir )

设置消息方向。

参数

dir	消息的方向，详见 Direct。

◆ setFrom()

void io.agora.chat.ChatMessage.setFrom ( String from )

设置消息发送方的用户 ID。

参数

from	发送方的用户 ID。

◆ setGroupAckCount()

void io.agora.chat.ChatMessage.setGroupAckCount ( int count )

设置群消息已读人数。

参数

count 群消息已读人数。

◆ setIsChatThreadMessage()

void io.agora.chat.ChatMessage.setIsChatThreadMessage ( boolean isChatThreadMessage )

设置消息是否是子区消息。

参数

isChatThreadMessage

消息是否是子区消息：

true：是；
false：否。

◆ setIsNeedGroupAck()

void io.agora.chat.ChatMessage.setIsNeedGroupAck ( boolean need )

设置群组消息是否需要已读回执。

参数

need	群组消息是否需要已读回执: `true`：需要； `false`：不需要。

◆ setListened()

void io.agora.chat.ChatMessage.setListened ( boolean isListened )

设置语音消息是否已听。

该方法由 SDK 调用，而非开发者。

参数

isListened

语音消息是否已听：

true：已听。
false：未听。

◆ setLocalTime()

void io.agora.chat.ChatMessage.setLocalTime ( long serverTime )

设置消息的本地时间戳。

该时间戳为消息的本地创建时间戳。

参数

serverTime 消息的本地时间戳。

◆ setMessageStatusCallback()

synchronized void io.agora.chat.ChatMessage.setMessageStatusCallback ( CallBack callback )

设置消息状态变化的回调。

设置消息状态回调，以便刷新界面。

参数

callback 消息状态改变的回调。

◆ setMsgId()

void io.agora.chat.ChatMessage.setMsgId ( String msgId )

设置本地消息 ID。

参数

msgId 消息 ID。

◆ setMsgTime()

void io.agora.chat.ChatMessage.setMsgTime ( long msgTime )

设置消息的服务器时间戳。

该时间戳为服务器接收消息的时间。

参数

msgTime 服务器接收消息的时间戳。

◆ setPriority()

void io.agora.chat.ChatMessage.setPriority ( ChatRoomMessagePriority priority )

设置聊天室消息优先级。

参数

priority 聊天室消息优先级。

◆ setProgress()

void io.agora.chat.ChatMessage.setProgress ( int progress )

设置消息中的附件的上传或者下载进度。

对于 app 开发者来说，通常不需要主动设置进度。详见 ChatMessage#progress()。

参数

progress 消息中的附件的上传或者下载进度，取值范围为 [0,100]。

◆ setReceiverList()

void io.agora.chat.ChatMessage.setReceiverList ( List< String > receiverList )

设置定向消息接收方。

该方法适用于群组和聊天室。若创建消息后不调用该方法，则消息发送给群组或聊天室的所有成员。

参数

receiverList 定向消息接收方。若传入 null，则消息发送给群组或聊天室的所有成员。

◆ setStatus()

void io.agora.chat.ChatMessage.setStatus ( Status status )

设置消息发送或接收的状态。

参数

status 消息的状态。

◆ setTo()

void io.agora.chat.ChatMessage.setTo ( String to )

设置消息的接收方的用户 ID。

参数

to	消息接收方的用户 ID。

◆ setUnread()

void io.agora.chat.ChatMessage.setUnread ( boolean unread )

设置消息是否未读。

建议在会话中，使用 Conversation#markAllMessagesAsRead()。

参数

unread

消息是否未读：

true:设置消息为未读；
false:设置消息为已读。

◆ status()

Status io.agora.chat.ChatMessage.status ( )

获取消息的发送/接收状态。

返回: 消息的发送/接收状态。

该类的文档由以下文件生成:

io/agora/chat/ChatMessage.java

类

Public 成员函数

静态 Public 成员函数

详细描述

成员函数说明

◆ addBody()

◆ conversationId()

◆ createCombinedSendMessage()

◆ createFileSendMessage() [1/2]

◆ createFileSendMessage() [2/2]

◆ createImageSendMessage() [1/2]

◆ createImageSendMessage() [2/2]

◆ createLocationSendMessage() [1/2]

◆ createLocationSendMessage() [2/2]

◆ createReceiveMessage()

◆ createSendMessage()

◆ createTextSendMessage()

◆ createTxtSendMessage()

◆ createVideoSendMessage() [1/3]

◆ createVideoSendMessage() [2/3]

◆ createVideoSendMessage() [3/3]

◆ createVoiceSendMessage() [1/2]

◆ createVoiceSendMessage() [2/2]

◆ deliverOnlineOnly()

◆ direct()

◆ ext()

◆ getAttributes()

◆ getBody()

◆ getBooleanAttribute() [1/2]

◆ getBooleanAttribute() [2/2]

◆ getChatThread()

◆ getChatType()

◆ getDoubleAttribute() [1/2]

◆ getDoubleAttribute() [2/2]

◆ getFloatAttribute() [1/2]

◆ getFloatAttribute() [2/2]

◆ getFrom()

◆ getIntAttribute() [1/2]

◆ getIntAttribute() [2/2]

◆ getJSONArrayAttribute()

◆ getJSONObjectAttribute()

◆ getLongAttribute() [1/2]

◆ getLongAttribute() [2/2]

◆ getMessageReaction()

◆ getMsgId()

◆ getMsgTime()

◆ getRecaller()

◆ getStringAttribute() [1/2]

◆ getStringAttribute() [2/2]

◆ getTo()

◆ getType()

◆ getUserName()

◆ groupAckCount()

◆ isAcked()

◆ isBroadcast()

◆ isChatThreadMessage()

◆ isContentReplaced()

◆ isDelivered()

◆ isDeliverOnlineOnly()

◆ isListened()

◆ isNeedGroupAck()

◆ isOnlineState()

◆ isUnread()

◆ localTime()

◆ pinnedInfo()

◆ progress()

◆ receiverList()

◆ setAcked()

◆ setAttribute() [1/8]

◆ setAttribute() [2/8]

◆ setAttribute() [3/8]

◆ setAttribute() [4/8]

◆ setAttribute() [5/8]

◆ setAttribute() [6/8]

◆ setAttribute() [7/8]

◆ setAttribute() [8/8]

◆ setBody()

◆ setChatType()

◆ setDeliverAcked()

◆ setDelivered()