浏览 SDKs · React Native
平台
SDKsReact Native

创建 @ 消息

OpenIM React Native SDK 创建 @ 消息。

复制

创建群聊中的 @ 提醒消息。text 正文中的 @ 文本应与 atUserIDList 中的用户 ID 保持一致。

const message = await OpenIMSDK.createTextAtMessage({
  text: '@user-001 请确认发布内容。',
  atUserIDList: ['user-001'],
  atUsersInfo: [
    {
      atUserID: 'user-001',
      groupNickname: '小李',
    },
  ],
});

参数说明

参数类型必填含义
textstring是消息正文文本。
atUserIDListstring[]是被提及的用户 ID 列表。
atUsersInfoAtUsersInfoItem[]否被提及用户在群内的展示信息,包含 atUserID 和 groupNickname。
messageMessageItem否引用或附带的原消息对象。

返回结果

调用完成后返回已创建的 MessageItem 消息对象,其中 atTextElem 保存被 @ 成员与展示名数据。

该方法仅在本地构建待发送的消息结构,不会直接向服务端发送,也不会触发收发消息事件。生成消息对象后,需通过发送消息将消息投递到群聊会话中。