SDKsReact Native

创建自定义消息

OpenIM React Native SDK 创建自定义消息。

创建自定义业务消息。通信双方需提前约定 data 和 extension 的数据格式。

const message = await OpenIMSDK.createCustomMessage({
  data: JSON.stringify({ type: 'task', taskID: 'task-42' }),
  extension: JSON.stringify({ version: 1 }),
  description: '任务卡片',
});

参数说明

参数	类型	必填	含义
`data`	`string`	是	业务数据字符串，通常使用 JSON 序列化字符串。
`extension`	`string`	是	业务扩展信息字符串。
`description`	`string`	是	消息描述信息，也常作为不支持该类型的低版本客户端降级提示文案。

返回结果

调用完成后返回已创建的 MessageItem 消息对象，其中 customElem 保存自定义内容。

该方法仅在本地构建待发送的消息结构，不会直接向服务端发送，也不会触发收发消息事件。生成消息对象后，需通过发送消息将消息投递到单聊或群聊会话中。接收端解析时应校验业务数据的格式和版本；服务端主动推送的业务消息监听见接收自定义业务消息。

这个页面有帮助吗？