createForwardMessage

Description

info

Create a forward message.

iOS

Function Prototype

  Future<Message> createForwardMessage({
    required Message message,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
message	Message	Yes	The message to be forwarded

Return Result

Name	Type	Description
~	Message	Success return

Code Example

  Message msg = await OpenIM.iMManager.messageManager.createForwardMessage(message: message);
    //todo

Android

Function Prototype

+ (OIMMessageInfo *)createForwardMessage:(OIMMessageInfo *)msg;

Input Parameters

Parameter Name	Parameter Type	Required	Description
msg	OIMMessageInfo	Yes	The message to be forwarded

Return Result

Name	Type	Description
message	OIMMessageInfo	Success return

Code Example

OIMMessageInfo *message = [OIMMessageInfo createForwardMessage: ];

Flutter

Function Prototype

    public Message createForwardMessage(Message message)

Input Parameters

Parameter Name	Parameter Type	Required	Description
message	Message	Yes	The message to be forwarded

Return Result

Name	Type	Description
~	Message	Success return

Code Example

     Message Message= OpenIMClient.getInstance().messageManager. createForwardMessage( message)
    //todo

uni-app

Function Prototype

IMSDK.createForwardMessage(message:MessageItem, operationID?: string): Promise<WsResponse<MessageItem>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	string	Yes	Text content
message	MessageItem	Yes	The forwarded message

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();

const message = {...} as MessageItem;

IMSDK.createForwardMessage(message)
  .then(({data}) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('createForwardMessage', operationID: string, message: MessageItem): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
message	MessageItem	Yes	The message to be forwarded

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';

const message = {...} as MessageItem;

IMSDK.asyncApi('createForwardMessage', IMSDK.uuid(), message)
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.createForwardMessage( message: MessageItem, operationID?: string): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Required	Description
message	MessageItem	Yes	The message to be forwarded
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";

const message = {...} as MessageItem;

OpenIMSDK.createForwardMessage(message)
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static Message CreateForwardMessage(Message msg)

Input Parameters

Parameter Name	Parameter Type	Required	Description
msg	Message	Yes	The message to be forwarded

Return Result

Name	Type	Description
~	Message	Success return

Code Example

var msg = IMSDK.CreateForwardMessage(msg);