createTextAtMessage

Description

info

Create an @ message. Currently, a maximum of 10 people can be @'ed in a single message. If you want to @ everyone, just add an at element with the userID AtAllTag.
Also, if you want to quote a message while @'ing someone, you need to pass the quoted message as a parameter; there is no need to call createQuoteMessage anymore.

iOS

Function Prototype

  Future<Message> createTextAtMessage({
    required String text,
    required List<String> atUserIDList,
    List<AtUserInfo> atUserInfoList = const [],
    Message? quoteMessage,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	String	Yes	Content
atUserIDList	List<String>	Yes	List of userID to be @'ed
atUserInfoList	List<AtUserInfo>	Yes	User info list of @'ed users
quoteMessage	Message	Yes	Quoted message

Return Result

Name	Type	Description
~	Message	Success return

Code Example

    Message msg = await OpenIM.iMManager.messageManager.createTextAtMessage(text: text, atUserIDList: atUserIDList);
    //todo

Android

Function Prototype

+ (OIMMessageInfo *)createTextAtMessage:(NSString *)text
                              atUidList:(NSArray<NSString *> *)atUidList
                            atUsersInfo:(NSArray<OIMAtInfo *> *)atUsersInfo
                                message:(OIMMessageInfo * _Nullable)msg;

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	NSString	Yes	Content
atUidList	NSArray<NSString *>	Yes	List of userID to be @'ed
atUsersInfo	NSArray< OIMAtInfo * >	Yes	User info list of @'ed users
msg	OIMMessageInfo	Yes	Quoted message

Return Result

Name	Type	Description
message	OIMMessageInfo	Success return

Code Example

OIMAtInfo *user1 = [OIMAtInfo new];
user1.atUserID = @"";
user1.groupNickname = @"";

OIMMessageInfo *message = [OIMMessageInfo createTextAtMessage:@"" atUidList:@[] atUsersInfo:@[user1] message:nil];

Function Prototype

+ (OIMMessageInfo *)createTextAtAllMessage:(NSString *)text
                               displayText:(NSString * _Nullable)displayText
                                   message:(OIMMessageInfo * _Nullable)message;

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	NSString	Yes	Content
displayText	NSString	No	Display text
msg	OIMMessageInfo	No	Quoted message

Return Result

Name	Type	Description
message	OIMMessageInfo	Success return

Code Example

OIMMessageInfo *message = [OIMMessageInfo createTextAtAllMessage:@""
                                                     displayText:nil
                                                         message:nil];

Flutter

Function Prototype

    public Message createTextAtMessage(String text, List<String> atUserIDList, List<AtUserInfo> atUserInfoList, Message quoteMessage)

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	String	Yes	Content
atUserIDList	List<String>	Yes	List of userID to be @'ed
atUserInfoList	List<AtUserInfo>	Yes	User info list of @'ed users
quoteMessage	Message	Yes	Quoted message

Return Result

Name	Type	Description
~	Message	Success return

Code Example

       Message Message= OpenIMClient.getInstance().messageManager.createTextAtMessage( text, atUserIDList, atUserInfoList,  quoteMessage)

uni-app

Function Prototype

IMSDK.createTextAtMessage({
    text: string;
    atUserIDList: string[];
    atUsersInfo: AtUsersInfoItem[];
    message?: MessageItem;
}, operationID?: string): Promise<WsResponse<MessageItem>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	string	Yes	Content
atUserIDList	string[]	Yes	List of userID to be @'ed
atUsersInfo	AtUsersInfoItem[]	Yes	User info list of @'ed users
message	MessageItem	Yes	Quoted 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();

IMSDK.createTextAtMessage({
  text: "",
  atUserIDList: ['userID'],
  atUsersInfo: [
    {
      atUserID: "userID",
      groupNickname: ""
    },
  ],
  message: {
    // MessageItem
    ...
  }
})
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('createTextAtMessage', operationID: string, {
  text: string;
  atUserIDList: string[];
  atUsersInfo: AtUsersInfoItem[];
  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
text	string	Yes	Content
atUserIDList	string[]	Yes	List of userID to be @'ed
atUsersInfo	AtUsersInfoItem[]	Yes	User info list of @'ed users
message	MessageItem	Yes	Quoted message

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('createTextAtMessage', IMSDK.uuid(), {
  text: "",
  atUserIDList: ['userID'],
  atUsersInfo: [
    {
      atUserID: "userID",
      groupNickname: ""
    },
  ],
  message: {
    // MessageItem
    ...
  }
})
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.createTextAtMessage({
  text: string,
  atUserIDList: string[],
  atUsersInfo: AtUsersInfoItem[];
  message?: MessageItem;
}, operationID?: string): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	string	Yes	Content
atUserIDList	string[]	Yes	List of userID to be @'ed
atUsersInfo	AtUsersInfoItem[]	Yes	User info list of @'ed users
message	MessageItem	Yes	Quoted message
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.createTextAtMessage({
  text: "",
  atUserIDList: ['userID'],
  atUsersInfo: [
    {
      atUserID: "userID",
      groupNickname: ""
    },
  ],
  message: {
    // MessageItem
    ...
  }
})
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static Message CreateTextAtMessage(string text, string[] atUserList, AtInfo[] atUsersInfo, Message message)

Input Parameters

Parameter Name	Parameter Type	Required	Description
text	string	Yes	Content
atUserList	string[]	Yes	List of userID to be @'ed
atUsersInfo	AtInfo []	Yes	User info list of @'ed users
message	Message	Yes	Quoted message

Return Result

Name	Type	Description
~	Message	Success return

Code Example

var msg = IMSDK.CreateTextAtMessage(text, atUserList , atUsersInfo , message);