Public 成员函数
abstract void	addAdvancedMsgListener (V2TIMAdvancedMsgListener listener)

abstract void	removeAdvancedMsgListener (V2TIMAdvancedMsgListener listener)

abstract V2TIMMessage	createTextMessage (String text)

abstract V2TIMMessage	createCustomMessage (byte[] data)

abstract V2TIMMessage	createImageMessage (String imagePath)

abstract V2TIMMessage	createSoundMessage (String soundPath, int duration)

abstract V2TIMMessage	createVideoMessage (String videoPath, int duration, String snapshotPath)

abstract V2TIMMessage	createFileMessage (String filePath, String fileName)

abstract V2TIMMessage	createLocationMessage (String desc, double longitude, double latitude)

abstract V2TIMMessage	createFaceMessage (int index, byte[] data)

abstract String	sendC2CMessage (V2TIMMessage msg, String toUserID, V2TIMValueCallback< V2TIMMessage > callback)

abstract String	sendC2CMessage (V2TIMMessage msg, String toUserID, V2TIMOfflinePushInfo v2TIMOfflinePushInfo, V2TIMValueCallback< V2TIMMessage > callback)

abstract String	sendGroupMessage (V2TIMMessage msg, String toGroupID, V2TIMValueCallback< V2TIMMessage > callback)

abstract String	sendGroupMessage (V2TIMMessage msg, String toGroupID, V2TIMOfflinePushInfo v2TIMOfflinePushInfo, V2TIMValueCallback< V2TIMMessage > callback)

abstract String	sendGroupMessage (V2TIMMessage msg, String toGroupID, V2TIMOfflinePushInfo v2TIMOfflinePushInfo, int priority, V2TIMValueCallback< V2TIMMessage > callback)

abstract String	sendGroupOnlineMessage (V2TIMMessage msg, String toGroupID, V2TIMValueCallback< V2TIMMessage > callback)

abstract void	getC2CHistoryMessageList (String userID, int count, V2TIMMessage lastMsg, V2TIMValueCallback< List< V2TIMMessage >> callback)

abstract void	getGroupHistoryMessageList (String groupID, int count, V2TIMMessage lastMsg, V2TIMValueCallback< List< V2TIMMessage >> callback)

abstract void	revokeMessage (V2TIMMessage msg, V2TIMCallback callback)

abstract void	markC2CMessageAsRead (String userID, V2TIMCallback callback)

abstract void	markGroupMessageAsRead (String groupID, V2TIMCallback callback)

abstract void	deleteMessageFromLocalStorage (V2TIMMessage msg, V2TIMCallback callback)

abstract String	insertGroupMessageToLocalStorage (V2TIMMessage msg, String groupID, String sender, V2TIMValueCallback< V2TIMMessage > callback)

成员函数说明

◆ addAdvancedMsgListener()

abstract void addAdvancedMsgListener ( V2TIMAdvancedMsgListener listener )

abstract

设置高级消息的事件监听器

参数

listener 高级消息监听器

◆ removeAdvancedMsgListener()

abstract void removeAdvancedMsgListener ( V2TIMAdvancedMsgListener listener )

abstract

移除高级消息监听器

参数

listener 高级消息监听器

◆ createTextMessage()

abstract V2TIMMessage createTextMessage ( String text )

abstract

创建文本消息

参数

text 消息文本

返回: 消息对象

◆ createCustomMessage()

abstract V2TIMMessage createCustomMessage ( byte[] data )

abstract

创建自定义消息

参数

data 自定义内容

返回: 消息对象

◆ createImageMessage()

abstract V2TIMMessage createImageMessage ( String imagePath )

abstract

创建图片消息

参数

imagePath 图片路径

返回: 消息对象

◆ createSoundMessage()

abstract V2TIMMessage createSoundMessage	(	String	soundPath,
		int	duration
	)

abstract

创建语音消息

参数

soundPath	语音文件路径
duration	语音时长，单位秒

返回: 消息对象

◆ createVideoMessage()

abstract V2TIMMessage createVideoMessage	(	String	videoPath,
		int	duration,
		String	snapshotPath
	)

abstract

创建视频消息

参数

videoPath	视频文件路径
duration	视频时长，单位秒
snapshotPath	视频封面图片路径

返回: 消息对象

◆ createFileMessage()

abstract V2TIMMessage createFileMessage	(	String	filePath,
		String	fileName
	)

abstract

创建文件消息

参数

filePath	文件路径
fileName	文件名称

返回: 消息对象

◆ createLocationMessage()

abstract V2TIMMessage createLocationMessage	(	String	desc,
		double	longitude,
		double	latitude
	)

abstract

创建地理位置消息

参数

desc	描述信息
longitude	经度
latitude	维度

返回: 消息对象

◆ createFaceMessage()

abstract V2TIMMessage createFaceMessage	(	int	index,
		byte[]	data
	)

abstract

SDK 并不提供表情包，如果开发者有表情包，可使用 index 存储表情在表情包中的索引，由用户自定义，或者直接使用 data 存储表情二进制信息以及字符串 key，都由用户自定义，SDK 内部只做透传。

参数

index	表情索引，用户自定义
data	额外数据，用户自定义

返回: 消息对象

注意: index 和 data 只需要传入一个即可，ImSDK 只是透传这两个数据。

◆ sendC2CMessage() [1/2]

abstract String sendC2CMessage	(	V2TIMMessage	msg,
		String	toUserID,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

发送单聊消息

参数

msg	消息
toUserID	目标用户 ID
callback	回调

返回: msgID

◆ sendC2CMessage() [2/2]

abstract String sendC2CMessage	(	V2TIMMessage	msg,
		String	toUserID,
		V2TIMOfflinePushInfo	v2TIMOfflinePushInfo,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

发送单聊消息 + 设置消息推送

参数

msg	消息
toUserID	目标用户 ID
v2TIMOfflinePushInfo	消息的离线推送信息
callback	回调

返回: msgID

◆ sendGroupMessage() [1/3]

abstract String sendGroupMessage	(	V2TIMMessage	msg,
		String	toGroupID,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

发送群组消息

参数

msg	消息
toGroupID	目标群组 ID
callback	回调

返回: msgID

◆ sendGroupMessage() [2/3]

abstract String sendGroupMessage	(	V2TIMMessage	msg,
		String	toGroupID,
		V2TIMOfflinePushInfo	v2TIMOfflinePushInfo,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

发送群组消息 + 设置消息推送

参数

msg	消息
toGroupID	目标群组 ID
v2TIMOfflinePushInfo	消息的离线推送信息
callback	回调

返回: msgID

◆ sendGroupMessage() [3/3]

abstract String sendGroupMessage	(	V2TIMMessage	msg,
		String	toGroupID,
		V2TIMOfflinePushInfo	v2TIMOfflinePushInfo,
		int	priority,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

发送群组消息 + 设置消息推送 + 设置消息优先级

参数

msg	消息对象
toGroupID	目标群组 ID
v2TIMOfflinePushInfo	消息的离线推送信息
priority	消息优先级： V2TIMMessage.V2TIM_MSG_PRIORITY_HIGH, V2TIMMessage.V2TIM_MSG_PRIORITY_NORMAL, V2TIMMessage.V2TIM_MSG_PRIORITY_LOW, V2TIMMessage.V2TIM_MSG_PRIORITY_LOWEST。
callback	回调

返回: msgID

注意: 一个群组消息发送频率如果超过 40条/s，后台会优先丢掉低优先级的消息，请把重要消息设置为高优先级（比如红包和礼物消息），高频不重要的消息设置为低优先级（比如点赞消息）。

◆ sendGroupOnlineMessage()

abstract String sendGroupOnlineMessage	(	V2TIMMessage	msg,
		String	toGroupID,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

发送群组在线消息

群里的用户在线可以收到，离线收不到，消息不存漫游，不存本地，适用于在线广播通知。

参数

msg
toGroupID
callback

返回: msgID

◆ getC2CHistoryMessageList()

abstract void getC2CHistoryMessageList	(	String	userID,
		int	count,
		V2TIMMessage	lastMsg,
		V2TIMValueCallback< List< V2TIMMessage >>	callback
	)

abstract

获取单聊历史消息

参数

userID	用户 ID
count	数量
lastMsg	获取消息的起始消息，如果传 null，起始消息为会话的最新消息
callback	回调

注意: 返回消息列表默认是按照时间从大到小排序

◆ getGroupHistoryMessageList()

abstract void getGroupHistoryMessageList	(	String	groupID,
		int	count,
		V2TIMMessage	lastMsg,
		V2TIMValueCallback< List< V2TIMMessage >>	callback
	)

abstract

获取群组历史消息

参数

groupID	群组 ID
count	数量
lastMsg	获取消息的起始消息，如果传 null，起始消息为会话的最新消息
callback	回调

◆ revokeMessage()

abstract void revokeMessage	(	V2TIMMessage	msg,
		V2TIMCallback	callback
	)

abstract

撤回消息

参数

msg	消息对象
callback	回调

◆ markC2CMessageAsRead()

abstract void markC2CMessageAsRead	(	String	userID,
		V2TIMCallback	callback
	)

abstract

设置C2C消息已读

参数

userID	用户 ID
callback	回调

◆ markGroupMessageAsRead()

abstract void markGroupMessageAsRead	(	String	groupID,
		V2TIMCallback	callback
	)

abstract

设置群组消息已读

参数

groupID	群组 ID
callback	回调

◆ deleteMessageFromLocalStorage()

abstract void deleteMessageFromLocalStorage	(	V2TIMMessage	msg,
		V2TIMCallback	callback
	)

abstract

删除本地消息

消息只能本地删除，消息删除后，SDK 会在本地把这条消息标记为已删除状态，getMessage 不能再拉取到，但是如果程序卸载重装，本地会失去对这条消息的删除标记，getMessage 还能再拉取到该条消息。

参数

msg	消息，若为 null 则会回调失败
callback	回调

◆ insertGroupMessageToLocalStorage()

abstract String insertGroupMessageToLocalStorage	(	V2TIMMessage	msg,
		String	groupID,
		String	sender,
		V2TIMValueCallback< V2TIMMessage >	callback
	)

abstract

向群组消息列表中添加一条消息

该接口主要用于满足向群组聊天会话中插入一些提示性消息的需求，比如“您已经退出该群”，这类消息有展示在聊天消息区的需求，但并没有发送给其他人的必要。所以 insertGroupMessageToLocalStorage() 相当于一个被禁用了网络发送能力的 sendGroupMessage() 接口。

参数

msg	消息
groupID	群组 ID
sender	发送者 userID
callback	回调

返回: msgID

Public 成员函数

成员函数说明

◆ addAdvancedMsgListener()

◆ removeAdvancedMsgListener()

◆ createTextMessage()

◆ createCustomMessage()

◆ createImageMessage()

◆ createSoundMessage()

◆ createVideoMessage()

◆ createFileMessage()

◆ createLocationMessage()

◆ createFaceMessage()

◆ sendC2CMessage() [1/2]

◆ sendC2CMessage() [2/2]

◆ sendGroupMessage() [1/3]

◆ sendGroupMessage() [2/3]

◆ sendGroupMessage() [3/3]

◆ sendGroupOnlineMessage()

◆ getC2CHistoryMessageList()

◆ getGroupHistoryMessageList()

◆ revokeMessage()

◆ markC2CMessageAsRead()

◆ markGroupMessageAsRead()

◆ deleteMessageFromLocalStorage()

◆ insertGroupMessageToLocalStorage()