createTextMessage

Feature Introduction

Note

Create a text message.

iOS

Function Prototype

 Future<Message> createTextMessage({
    required String text,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
text	String	Yes	Message content

Return Result

Name	Type	Description
~	Message	Successful return

Code Example

    Message msg = await OpenIM.iMManager.messageManager.createTextMessage(text: text);
    //todo

Android

Function Prototype

+ (OIMMessageInfo *)createTextMessage:(NSString *)text;

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
text	NSString	Yes	Message content

Return Result

Name	Type	Description
message	OIMMessageInfo	Successful return

Code Example

OIMMessageInfo *message = [OIMMessageInfo createTextMessage:@""];

Flutter

Function Prototype

    public Message createTextMessage(String text)

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
text	String	Yes	Message content

Return Result

Name	Type	Description
~	Message	Successful return

Code Example

   Message Message= OpenIMClient.getInstance().messageManager.createTextMessage(String text)
    //todo

uni-app

Function Prototype

IMSDK.createTextMessage(text: string, operationID?: string): Promise<WsResponse<MessageItem>>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
text	string	Yes	Text content

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<MessageItem>>	Successful callback
Promise.catch()	Promise<WsResponse>	Failed callback

Code Example

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.createTextMessage('text')
  .then(({ data }) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('createTextMessage', operationID: string, text: string): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID, for problem locating, should be unique. Recommend using current time and random number.
text	string	Yes	Text content

Return Result

Through the openim-uniapp-polyfill package, the function is made into a Promise. You need to use then and catch to judge and handle successful and failed callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<MessageItem>	Successful callback
Promise.catch()	Promise<CatchResponse>	Failed callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createTextMessage', IMSDK.uuid(), 'text')
  .then((data) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

OpenIMSDKRN.createTextMessage(textMsg: string,operationID: string): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
text	string	Yes	Text content
operationID	string	Yes	Operation ID, used for problem location, keep unique, suggest using current time and random number

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<MessageItem>	Callback on successful call
Promise.catch()	Promise<CatchResponse>	Callback on failed call

Code Example

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

OpenIMSDKRN.createTextMessage('text', 'operationID')
  .then((data) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

Function Prototype

public static MsgStruct CreateTextMessage(string text)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
text	string	Yes	Text content

Return Result

Parameter Name	Type	Description
~	MsgStruct	Message Struct

Code Example

   var msg = IMSDK.CreateTextMessage("hello");