insertGroupMessageToLocalStorage
功能介绍
向群组消息列表中添加一条消息
只能插入文本消息，参数data为本文内容
该接口主要用于满足向群组聊天会话中插入一些提示性消息的需求，比如“您已经退出该群”，这类消息有展示 在聊天消息区的需求，但并没有发送给其他人的必要。
insertGroupMessageToLocalStorage() 相当于一个被禁用了网络发送能力的 sendMessage() 接口。
通过该接口 insert 的消息只存本地，程序卸载后会丢失。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| data | string | 是 | 文本消息内容 |
| groupID | string | 是 | 接受群组id |
| sender | string | 是 | 发送者id |
返回模板
V2TimValueCallback<V2TimMessage>
{
code : number
desc : string
data : {
msgID: string
timestamp: number
progress: number
sender: string
nickName: string
friendRemark: string
faceUrl: string
nameCard: string
groupID: string
userID: string
status: number
elemType: number
textElem: V2TimTextElem
customElem: V2TimCustomElem
imageElem: V2TimImageElem
soundElem: V2TimSoundElem
videoElem: V2TimVideoElem
fileElem: V2TimFileElem
locationElem: V2TimLocationElem
faceElem: V2TimFaceElem
groupTipsElem: V2TimGroupTipsElem
mergerElem: V2TimMergerElem
localCustomData: string
localCustomInt: number
cloudCustomData: string
isSelf: boolean
isRead: boolean
isPeerRead: boolean
priority: number
offlinePushInfo: V2TimOfflinePushInfo
groupAtUserList: string[]
seq: string
random: number
isExcludedFromUnreadCount: boolean
isExcludedFromLastMessage: boolean
id: string
needReadReceipt: boolean
}
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | number | 请求结果错误码 |
| desc | string | 请求结果描述 |
| data | V2TimMessage | 创建后的插入信息 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
// 向群组消息列表中添加一条消息
const insertGroupMessageToLocalStorageRes =
await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.insertGroupMessageToLocalStorage(
'data', // 文本消息内容
'groupID', // 接收群组id
'sender' // 发送者id
);
if (insertGroupMessageToLocalStorageRes.code === 0) {
//添加成功
}