createMergeMessage

功能介绍

说明

创建合并消息，多条消息合并成一条，参数包含标题、摘要以及多条消息。

注意

建议合并消息总数在一百条以内。

iOS

函数原型

 Future<Message> createMergerMessage({
    required List<Message> messageList,
    required String title,
    required List<String> summaryList,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
messageList	List<Message>	是	消息列表
title	String	是	标题
summaryList	List<String>	是	消息摘要列表

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

    Message msg = await OpenIM.iMManager.messageManager.createMergerMessage(messageList: messageList, title: title, summaryList: summaryList);
    //todo

Android

函数原型

+ (OIMMessageInfo *)createMergeMessage:(NSArray <OIMMessageInfo *> *)messages
                                 title:(NSString *)title
                           summaryList:(NSArray <NSString *> *)summarys;

输入参数

参数名称	参数类型	是否必填	描述
messages	NSArray < OIMMessageInfo * >	是	消息列表
title	NSString	是	标题
summarys	NSArray <NSString *>	是	消息摘要列表

返回结果

名称	类型	描述
message	OIMMessageInfo	成功返回

代码示例

OIMMessageInfo *message = [OIMMessageInfo createMergeMessage:@[]
                                                       title:@""
                                                 summaryList:@[]];

Flutter

函数原型

    public Message createMergerMessage(List<Message> messageList, String title, List<String> summaryList)

输入参数

参数名称	参数类型	是否必填	描述
messageList	List<Message>	是	消息列表
title	String	是	标题
summaryList	List<String>	是	消息摘要列表

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

     Message Message= OpenIMClient.getInstance().messageManager.createMergerMessage( messageList,  title,  summaryList);

uni-app

函数原型

IMSDK.createMergerMessage({
  messageList: MessageItem[];
  title: string;
  summaryList: string[];
}, operationID?: string): Promise<WsResponse<MessageItem>>

输入参数

参数名称	参数类型	是否必填	描述
messageList	MessageItem[]	是	消息列表
title	string	是	标题
summaryList	string[]	是	消息摘要列表

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<MessageItem>>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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.createMergerMessage({
  messageList: [
    {
      // message
      ...
    }
  ],
  title: "和xx的聊天记录",
  summaryList: ["xx: 你好", "xx: 你好"];
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('createMergerMessage', operationID: string, {
  messageList: MessageItem[];
  title: string;
  summaryList: string[];
}): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
messageList	MessageItem[]	是	消息列表
title	string	是	标题
summaryList	string[]	是	消息摘要列表

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<MessageItem>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createMergerMessage', IMSDK.uuid(), {
  messageList: [
    {
      // message
      ...
    }
  ],
  title: "和xx的聊天记录",
  summaryList: ["xx: 你好", "xx: 你好"];
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.createMergerMessage({
  title: string,
  messageList: Array,
  summaryList: Array,
}, operationID: string): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
messageList	MessageItem[]	是	消息列表
title	string	是	标题
summaryList	string[]	是	消息摘要列表
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<MessageItem>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.createMergerMessage({
  messageList: [
    {
      // message
      ...
    }
  ],
  title: "和xx的聊天记录",
  summaryList: ["xx: 你好", "xx: 你好"];
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static MsgStruct CreateMergerMessage(MsgStruct[] messageList, string title, string[] summaryList)

输入参数

参数名称	参数类型	是否必填	描述
messageList	MsgStruct[]	是	消息列表
title	string	是	标题
summaryList	string[]	是	消息摘要列表

返回结果

名称	类型	描述
~	MsgStruct	成功返回

代码示例

var msg = IMSDK.CreateMergerMessage(messageList,title,summaryList);