createFaceMessageWithIndex

功能介绍

说明

创建表情消息。

注意

自定义表情、动图等。若各端同步一套表情包，可使用 index 参数，若各端不同步表情包，可使用 data 参数，此时建议设置index为-1。

iOS

函数原型

 Future<Message> createFaceMessage({
    int index = -1,
    String? data,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
index	int	否	位置表情，根据 index 匹配
data	String	否	url 表情，直接使用 url 显示

返回结果

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

代码示例

 Message msg = await OpenIM.iMManager.messageManager.createFaceMessage(
      data: 'https://xxx/xxx/xx.png'
    );
    //todo

Android

函数原型

+ (OIMMessageInfo *)createFaceMessageWithIndex:(NSInteger)index
                                          data:(NSString *)dataStr;

输入参数

参数名称	参数类型	是否必填	描述
index	NSInteger	是	索引
dataStr	NSString	是	内容

返回结果

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

代码示例

OIMMessageInfo *message = [OIMMessageInfo createFaceMessageWithIndex:0 data:@""];

Flutter

函数原型

 public Message createFaceMessage(long index, String data)

输入参数

参数名称	参数类型	是否必填	描述
index	int	否	位置表情，根据 index 匹配
data	String	否	url 表情，直接使用 url 显示

返回结果

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

代码示例

       Message Message= OpenIMClient.getInstance().messageManager.createFaceMessage( index,  data)
    //todo

uni-app

函数原型

IMSDK.createFaceMessage({
  index: number;
  dataStr: string;
}, operationID?: string): Promise<WsResponse<MessageItem>>

输入参数

参数名称	参数类型	是否必填	描述
index	number	是	索引
dataStr	string	是	内容

返回结果

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

代码示例

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.createFaceMessage({
  index: 0,
  dataStr: 'https://xxx/xxx/xx.png',
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('createFaceMessage', operationID: string, {
  index: number;
  dataStr: string;
}): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
index	number	是	索引
dataStr	string	是	内容

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createFaceMessage', IMSDK.uuid(), {
  index: 0,
  dataStr: 'https://xxx/xxx/xx.png',
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.createFaceMessage({
  index: number;
  dataStr: string;
}, operationID: string): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
index	number	是	索引
dataStr	string	是	内容
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

OpenIMSDKRN.createFaceMessage({
  index: 0,
  dataStr: 'https://xxx/xxx/xx.png',
}, 'operationID')
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static MsgStruct CreateFaceMessage(int index, string data)

输入参数

参数名称	参数类型	是否必填	描述
index	int	是	索引
data	string	是	内容

返回结果

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

代码示例

var msg = IMSDK.CreateFaceMessage(index,data);