createFileMessageFromFullPath

功能介绍

说明

创建文件消息，由SDK内部根据绝对路径提取文件信息并创建文件消息。

iOS

函数原型

  Future<Message> createFileMessageFromFullPath({
    required String filePath,
    required String fileName,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
filePath	String	是	绝对路径
fileName	String	是	文件名字

返回结果

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

代码示例

  Message msg = await OpenIM.iMManager.messageManager.createFileMessageFromFullPath(filePath: filePath, fileName: fileName);
    //todo

Android

函数原型

+ (OIMMessageInfo *)createFileMessageFromFullPath:(NSString *)filePath
                                         fileName:(NSString *)fileName;

输入参数

参数名称	参数类型	是否必填	描述
filePath	NSString	是	绝对路径
fileName	NSString	是	文件名字

返回结果

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

代码示例

OIMMessageInfo *message = [OIMMessageInfo createFileMessageFromFullPath:@"" fileName:@""];

Flutter

函数原型

   public Message createFileMessageFromFullPath(String filePath, String fileName)

输入参数

参数名称	参数类型	是否必填	描述
filePath	String	是	绝对路径
fileName	String	是	文件名字

返回结果

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

代码示例

       Message Message= OpenIMClient.getInstance().messageManager. createFileMessageFromFullPath( filePath,  fileName)

uni-app

注意

仅在electron中使用ffi调用时支持

Web端建议使用createFileMessageByURL或createFileMessageByFile

函数原型

IMSDK.createFileMessageFromFullPath({
  filePath: string;
  fileName: string;
}, operationID?: string): Promise<WsResponse<MessageItem>>

输入参数

参数名称	参数类型	是否必填	描述
filePath	string	是	文件路径，绝对路径
fileName	string	是	文件名称

返回结果

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

代码示例

import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
const { instance: IMSDK } = getWithRenderProcess();


IMSDK.createFileMessageFromFullPath({
  filePath: 'file://...',
  fileName: 'fileName.mp4',
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/MiniProgram

函数原型

IMSDK.asyncApi('createFileMessageFromFullPath', operationID: string, {
  filePath: string,
  fileName: string
}): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
filePath	number	是	文件绝对路径
fileName	string	是	文件名称

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('createFileMessageFromFullPath', IMSDK.uuid(), {
  filePath: '',
  fileName: '',
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.createFileMessageFromFullPath({
  filePath: string,
  fileName: string
}, operationID: string): Promise<MessageItem>

输入参数

参数名称	参数类型	是否必填	描述
filePath	number	是	文件绝对路径
fileName	string	是	文件名称
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

OpenIMSDKRN.createFileMessageFromFullPath({
  filePath: '',
  fileName: '',
}, 'operationID')
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static MsgStruct CreateFileMessageFromFullPath(string fileFullPath, string fileName)

输入参数

参数名称	参数类型	是否必填	描述
filePath	string	是	绝对路径
fileName	string	是	文件名字

返回结果

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

代码示例

var msg = IMSDK.CreateFileMessageFromFullPath(fileFullPath,fileName);