createTextAtMessage
功能介绍
创建文本消息,并且可以附带 @ 提醒功能(直播群不支持)
请注意
默认情况下,最多支持 @ 30个用户,超过限制后,消息会发送失败。
atUserList 的总数不能超过默认最大数,包括 @ALL。
直播群(AVChatRoom)不支持发送 @ 消息。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
text | string | 是 | 消息文本 |
atUserList | string[] | 是 | At用户ID列表,如果需要 @ALL,请传入 kImSDK_MesssageAtALL 字符串。 |
返回模板
V2TimValueCallback<V2TimMsgCreateInfoResult>
{
code: number,
desc: string,
data: {
id: string,
messageInfo: V2TimMessage,
}
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述 |
data | V2TimMsgCreateInfoResult | 创建后的@Text信息 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
// 创建文本消息
const createTextAtMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.createTextAtMessage(
'test', // 文本信息
['__kImSDK_MesssageAtALL__', 'uesr1'] // @用户ID列表 @所有人并@uesr1
);
if (createTextAtMessageRes.code === 0) {
// 文本信息创建成功
const id = createTextAtMessageRes.data?.id;
// 发送@文本消息
// 在sendMessage时,必须填写groupID,receiver必须为空,否则无法发送消息
const sendMessageRes = await TencentImSDKPlugin.v2TIMManager
.getMessageManager()
.sendMessage({ id: id!, receiver: '', groupID: 'groupID' });
if (sendMessageRes.code === 0) {
// 发送成功
}
}