createTargetedGroupMessage
功能介绍
创建一条定向群消息
定向消息是指,向群内部分指定的成员发送消息,而未被指定的群成员无法收到该消息。可以按照下面的方式实现:
调用 createXXXMessage (其中 XXX 表示具体的消息类型) 接口创建一条原始消息对象 V2TIMMessage。
调用 createTargetedGroupMessage 接口根据原始消息对象创建定向消息对象 V2TimMessage,并指定消息接收成员列表。
调用 sendMessage 接口发送定向消息。
该功能需要购买旗舰版套餐包。
创建定向群消息的原始消息对象不支持群 @ 消息。
社群(Community)和直播群(AVChatRoom)不支持发送定向群消息。
定向群消息默认不计入群会话的未读计数。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
id | string | 是 | 创建的消息的id |
receiverList | string[] | 是 | 群内部分成员id列表 |
返回模板
V2TimValueCallback<V2TimMsgCreateInfoResult>
{
code: number,
desc: string,
data: {
id: string,
messageInfo: V2TimMessage,
}
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述 |
data | V2TimMsgCreateInfoResult | 创建的定向群消息 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
// 先创建消息
const target = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.createTextMessage('');
// 获取消息的发送id
const id = target.data?.id;
// 创建定向群消息消息
const groupTarget = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.createTargetedGroupMessage(
id!, // 创建的消息id
['user1', 'user2'] //定向成员id列表
);
// 发送定向群消息
if (groupTarget.code === 0) {
const groupTargetdId = groupTarget.data?.id;
// 发送定向群消息
// 若只填写groupID则发群组消息
// 若填写了receiver与groupID则发群内的个人用户,消息在群聊中显示,只有指定receiver能看见
const sendMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.sendMessage({
id: groupTargetdId!,
receiver: 'userID',
groupID: 'groupID',
});
if (sendMessageRes.code === 0) {
// 发送成功
}
}