createMergeMessage

Description

info

Create a merge message, combining multiple messages into one. Parameters include title, summary list, and multiple messages.

Note

It is recommended that the total number of merged messages be less than 100.

iOS

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
messageList	List<Message>	Yes	Message list
title	String	Yes	Title
summaryList	List<String>	Yes	Message summary list

Return Result

Name	Type	Description
~	Message	Success return

Code Example

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

Android

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
messages	NSArray < OIMMessageInfo * >	Yes	Message list
title	NSString	Yes	Title
summarys	NSArray <NSString *>	Yes	Message summary list

Return Result

Name	Type	Description
message	OIMMessageInfo	Success return

Code Example

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

Flutter

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
messageList	List<Message>	Yes	Message list
title	String	Yes	Title
summaryList	List<String>	Yes	Message summary list

Return Result

Name	Type	Description
~	Message	Success return

Code Example

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

uni-app

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
messageList	MessageItem[]	Yes	Message list
title	string	Yes	Title
summaryList	string[]	Yes	Message summary list

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<MessageItem>>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.createMergerMessage({
  messageList: [
    {
      // message
      ...
    }
  ],
  title: "Chat history with xx",
  summaryList: ["xx: Hello", "xx: Hello"];
})
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
messageList	MessageItem[]	Yes	Message list
title	string	Yes	Title
summaryList	string[]	Yes	Message summary list

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<MessageItem>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createMergerMessage', IMSDK.uuid(), {
  messageList: [
    {
      // message
      ...
    }
  ],
  title: "Chat history with xx",
  summaryList: ["xx: Hello", "xx: Hello"];
})
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
messageList	MessageItem[]	Yes	Message list
title	string	Yes	Title
summaryList	string[]	Yes	Message summary list
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<MessageItem>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.createMergerMessage({
  messageList: [
    {
      // message
      ...
    }
  ],
  title: "Chat history with xx",
  summaryList: ["xx: Hello", "xx: Hello"];
})
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
messageList	Message[]	Yes	Message list
title	string	Yes	Title
summaryList	string[]	Yes	Message summary list

Return Result

Name	Type	Description
~	Message	Success return

Code Example

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