createCardMessage

功能介绍

说明

创建名片消息。

iOS

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	String	是	用户 ID
nickname	String	是	用户昵称
faceURL	String	是	用户头像URL
ex	String	是	扩展信息

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

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

Android

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
content	NSString	是	文本内容

返回结果

名称	类型	描述
message	OIMMessageInfo	成功返回

代码示例

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

Flutter

函数原型

public Message createCardMessage(CardElem cardElem)

输入参数

参数名称	参数类型	是否必填	描述
userID	String	是	用户 ID
nickname	String	是	用户昵称
faceURL	String	是	用户头像URL
ex	String	是	扩展信息

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

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

uni-app

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	String	是	用户 ID
nickname	String	是	用户昵称
faceURL	String	是	用户头像URL
ex	String	是	扩展信息

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<MessageItem>>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

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 }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
userID	String	是	用户 ID
nickname	String	是	用户昵称
faceURL	String	是	用户头像URL
ex	String	是	扩展信息

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<MessageItem>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createCardMessage', IMSDK.uuid(), {
  userID: '',
  nickname: '',
  faceURL: '',
  ex: '',
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
userID	string	是	用户 ID
nickname	string	是	用户昵称
faceURL	string	是	用户头像URL
ex	string	是	扩展信息
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<MessageItem>	调用成功回调
Promise.catch()	Promise<OpenIMApiError>	调用失败回调

代码示例

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

OpenIMSDK.createCardMessage({
  userID: '',
  nickname: '',
  faceURL: '',
  ex: '',
})
  .then((data) => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

public static Message CreateCardMessage(CardElem cardInfo)

输入参数

参数名称	参数类型	是否必填	描述
cardInfo	CardElem	是	卡片内容

返回结果

名称	类型	描述
~	Message	成功返回

代码示例

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

});