跳到主要内容

fileUriService（文件路径转换API）

本模块为开发者在HarmonyOS 4及以下到HarmonyOS 5及以上的升级场景和克隆场景，调用该接口可以将源文件路径转换为目标文件路径。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.ScenarioFusionComponent.FileUriService

起始版本： 5.0.2(14)

导入模块​

import { fileUriService } from '@kit.ScenarioFusionKit';

FileUriResult​

该类提供融合场景文件路径转换的对象。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.ScenarioFusionComponent.FileUriService

起始版本： 5.0.2(14)

名称类型只读可选说明
sourceUristring否否源文件路径。
targetUristring否否目标文件路径。
targetTypeTargetType否否文件类型枚举。

TargetType​

该枚举定义了对象URI的类型。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.ScenarioFusionComponent.FileUriService

起始版本： 5.0.2(14)

名称值说明
UNKNOWN0不确定文件类型。
MEDIA1媒体文件。
FILE2文管文件。

convertFileUris​

convertFileUris(sourceFileUris: Array<string>): Promise<Array<FileUriResult>>

调用该方法获取转换文件uri信息，使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.ScenarioFusionComponent.FileUriService

设备行为差异： 该接口在Phone、Tablet中可正常调用，在其他设备类型中返回801错误码。

起始版本： 5.0.2(14)

参数：

参数名类型必填说明
sourceFileUrisArray<string>是待转换文件uri信息列表。列表数量范围：[1,100]，范围越界错误码：401 parameter error。

返回值：

类型说明
Promise<Array<FileUriResult>>Promise对象，返回FileUriResult对象数组。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID错误信息
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { fileUriService } from '@kit.ScenarioFusionKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  // '/storage/emulated/0/Pictures/test.gif'表示test.gif的文件路径。
  let sourceFileUris: Array<string> =
    ['100','content://media/external/files/10', '/storage/emulated/0/Pictures/test.gif',
      '/storage/emulated/0/media/com.test/test.mp4'];
  fileUriService.convertFileUris(sourceFileUris).then(result => {
    hilog.info(0x0000, 'testTag', 'succeeded in converting file uris');
    result.forEach(data => {
      switch (data.targetType) {
        case fileUriService.TargetType.UNKNOWN:
          hilog.info(0x0000, 'testTag', 'input uri or path is not exist');
          break;
        case fileUriService.TargetType.MEDIA:
          hilog.info(0x0000, 'testTag', 'converted media uri: %{public}s', data.targetUri);
          break;
        case fileUriService.TargetType.FILE:
          // 如果输入路径存在，结果中的targetUri将是转换后的URI。
          // 否则，targetUri 将与输入路径相同，targetType 将为 UNKNOWN。
          hilog.info(0x0000, 'testTag', 'converted file path: %{public}s', data.targetUri);
          break;
      }
    })
  }).catch((error: BusinessError) => {
    hilog.error(0x0000, 'testTag', 'Promise error: %{public}d %{public}s', error.code, error.message);
  });
} catch (error) {
  hilog.error(0x0000, 'testTag', 'failReason: %{public}d %{public}s', error.code, error.message);
}