createCustomMessage
功能介绍
说明
创建自定义消息,其中的字段都由开发者自己定义,SDK 只负责透传。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<Message> createCustomMessage({
required String data,
required String extension,
required String description,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
data | String | 是 | 文本内容 |
extension | String | 否 | 拓展内容 |
description | String | 否 | 描述内容 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | Message | 成功返回 |
代码示例
Message msg = await OpenIM.iMManager.messageManager.createCustomMessage(
data: jsonEncode({'key1':'value1'}),
extension: '',
description: ''
);
//todo
函数原型
+ (OIMMessageInfo *)createCustomMessage:(NSString *)data
extension:(NSString * _Nullable)extension
description:(NSString * _Nullable)description;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
data | NSString | 是 | 文本内容 |
extension | NSString | 否 | 拓展内容 |
description | NSString | 否 | 描述内容 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
message | OIMMessageInfo | 成功返回 |
代码示例
OIMMessageInfo *message = [OIMMessageInfo createCustomMessage:@""
extension:@""
description:@""];
函数原型
public Message createCustomMessage(String data, String extension, String description)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
data | String | 是 | 文本内容 |
extension | String | 否 | 拓展内容 |
description | String | 否 | 描述内容 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | Message | 成功返回 |
代码示例
Message Message= OpenIMClient.getInstance().messageManager.createCustomMessage(data, extension, description);
函数原型
IMSDK.createCustomMessage({
data: string;
extension: string;
description: string;
}, operationID?: string): Promise<WsResponse<MessageItem>>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
data | String | 是 | 文本内容 |
extension | String | 否 | 拓展内容 |
description | String | 否 | 描述内容 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse<MessageItem>> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.createCustomMessage({
data: '',
extension: '',
description: '',
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('createCustomMessage', operationID: string, {
data: string;
extension: string;
description: string;
}): Promise<MessageItem>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
data | String | 是 | 文本内容 |
extension | String | 否 | 拓展内容 |
description | String | 否 | 描述内容 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<MessageItem> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('createCustomMessage', IMSDK.uuid(), {
data: '',
extension: '',
description: '',
})
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
### 函数原型
OpenIMSDKRN.createCustomMessage({
data: string,
extension: string,
description: string
}, operationID: string): Promise<MessageItem>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
data | String | 是 | 文本内容 |
extension | String | 是 | 拓展内容 |
description | String | 是 | 描述内容 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<MessageItem> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.createCustomMessage({
data: '',
extension: '',
description: '',
}, 'operationID')
.then((data) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});