浏览 SDKs · React Native
SDKsReact Native

创建自定义消息

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

复制

使用 createCustomMessage() 创建自定义业务消息。业务双方需要约定 dataextension 的数据格式。

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

参数说明

参数类型是否必填说明
datastring业务数据字符串,可传 JSON 字符串。
extensionstring业务扩展信息字符串。
descriptionstring消息说明,也可作为不支持该消息类型时的降级展示文本。

调用后返回待发送的 MessageItem。接收端应校验业务数据的格式和版本;服务端业务通知的监听方式见接收自定义业务消息