createCardMessage

Description

info

Create a business card message.

iOS

Function Prototype

  Future<Message> createCardMessage({
       required String userID,
       required String nickname,
       String? faceURL,
       String? ex,
       String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	String	Yes	User ID
nickname	String	Yes	User nickname
faceURL	String	Yes	User avatar URL
ex	String	Yes	Extension information

Return Result

Name	Type	Description
~	Message	Success return

Code Example

  Message msg = await OpenIM.iMManager.messageManager.createCardMessage(
      'userID':'userID',
    );
    //todo

Android

Function Prototype

+ (OIMMessageInfo *)createCardMessage:(NSString *)content;

Input Parameters

Parameter Name	Parameter Type	Required	Description
content	NSString	Yes	Text content

Return Result

Name	Type	Description
message	OIMMessageInfo	Success return

Code Example

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

Flutter

Function Prototype

public Message createCardMessage(CardElem cardElem)

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	String	Yes	User ID
nickname	String	Yes	User nickname
faceURL	String	Yes	User avatar URL
ex	String	Yes	Extension information

Return Result

Name	Type	Description
~	Message	Success return

Code Example

      Message msg= OpenIMClient.getInstance().messageManager.createCardMessage(cardElem);

uni-app

Function Prototype

IMSDK.createCardMessage({
  userID: string;
  nickname: string;
  faceURL: string;
  ex: string;
}, operationID?: string): Promise<WsResponse<MessageItem>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	String	Yes	User ID
nickname	String	Yes	User nickname
faceURL	String	Yes	User avatar URL
ex	String	Yes	Extension information

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.createCardMessage({
  userID: '',
  nickname: '',
  faceURL: '',
  ex: '',
})
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('createCardMessage', operationID: string, {
  userID: string;
  nickname: string;
  faceURL: string;
  ex: 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
userID	String	Yes	User ID
nickname	String	Yes	User nickname
faceURL	String	Yes	User avatar URL
ex	String	Yes	Extension information

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('createCardMessage', IMSDK.uuid(), {
  userID: '',
  nickname: '',
  faceURL: '',
  ex: '',
})
  .then((data) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.login({
  userID:string,
  nickname:string,
  faceURL:string,
  ex:string
}, operationID?: string): Promise<MessageItem>

Input Parameters

Parameter Name	Parameter Type	Required	Description
userID	string	Yes	User ID
nickname	string	Yes	User nickname
faceURL	string	Yes	User avatar URL
ex	string	Yes	Extension information
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.createCardMessage({
  userID: '',
  nickname: '',
  faceURL: '',
  ex: '',
})
  .then((data) => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static Message CreateCardMessage(CardElem cardInfo)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cardInfo	CardElem	Yes	Card content

Return Result

Name	Type	Description
~	Message	Success return

Code Example

var msg = IMSDK.CreateCardMessage(new CardElem(){

});