openharmony 鸿蒙 js-apis-fileShare-sys

2025-06-12 浏览 (1)

@ohos.fileshare (文件分享)(系统接口)

该模块提供文件分享能力，提供系统应用将公共目录文件统一资源标志符（Uniform Resource Identifier，URI）以读写权限授权给其他应用的接口，授权后应用可通过@ohos.file.fs的相关接口进行相关open、read、write等操作，实现文件分享。

说明：

  • 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
  • 当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.fileshare (文件分享)。

导入模块

import  { fileShare } from '@kit.CoreFileKit';

fileShare.grantUriPermission

grantUriPermission(uri: string, bundleName: string, flag: wantConstant.Flags, callback: AsyncCallback<void>): void

对公共目录文件URI进行授权操作，使用callback异步回调。

需要权限：ohos.permission.WRITE_MEDIA

系统接口：此接口为系统接口。

系统能力：SystemCapability.FileManagement.AppFileService

参数：

参数名类型必填说明
uristring是公共目录文件uri。
bundleNamestring是分享目标的包名。
flagwantConstant.Flags是授权的权限。
callbackAsyncCallback<void>是异步授权之后的回调。

错误码：

以下错误码的详细介绍请参见文件管理错误码

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
143000001IPC error.

示例：

import { wantConstant } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let uri: string = 'file://docs/storage/Users/currentUser/Document/1.txt';  // 推荐使用系统接口生成URI。fileUri.getUriFromPath("沙箱路径");
let bundleName: string = 'com.demo.test';
try {
  fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION|
    wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION, (err: BusinessError) => {
    if (err) {
      console.error("grantUriPermission failed with error: " + JSON.stringify(err));
      return;
    }
    console.info("grantUriPermission success!");
  });
} catch (err) {
  let error: BusinessError = err as BusinessError;
  console.error("grantUriPermission failed with error:" + JSON.stringify(error));
}

fileShare.grantUriPermission

grantUriPermission(uri: string, bundleName: string, flag: wantConstant.Flags): Promise<void>

将公共目录文件URI进行授权操作，使用Promise异步回调。

需要权限：ohos.permission.WRITE_MEDIA

系统接口：此接口为系统接口。

系统能力：SystemCapability.FileManagement.AppFileService

参数：

参数名类型必填说明
uristring是公共目录文件uri。
bundleNamestring是分享目标的包名。
flagwantConstant.Flags是授权的权限。

返回值：

类型说明
Promise<void>Promise对象，无返回值。

错误码：

以下错误码的详细介绍请参见文件管理错误码。

错误码ID错误信息
201Permission verification failed.
202The caller is not a system application.
401The input parameter is invalid. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
143000001IPC error.

示例：

import { wantConstant } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let uri: string = 'file://docs/storage/Users/currentUser/Document/1.txt'; // 推荐使用系统接口生成URI。fileUri.getUriFromPath("沙箱路径");
let bundleName: string = 'com.demo.test';
try {
  fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION|
    wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION).then(() => {
    console.info("grantUriPermission success!");
  }).catch((error: BusinessError) => {
    console.error("grantUriPermission failed with error:" + JSON.stringify(error));
  });
} catch (err) {
  let error: BusinessError = err as BusinessError;
  console.error("grantUriPermission failed with error:" + JSON.stringify(error));
}

fileShare.checkPathPermission15+

checkPathPermission(tokenID: number, policies: Array<PathPolicyInfo>, policyType: PolicyType): Promise<Array<boolean>>

异步方法校验所选择的多个文件或目录是否有临时或持久化授权，以promise形式返回结果。

需要权限：ohos.permission.CHECK_SANDBOX_POLICY

系统接口：此接口为系统接口。

系统能力： SystemCapability.FileManagement.AppFileService.FolderAuthorization

参数：

参数名类型必填说明
tokenIDnumber是目标应用的身份标识。可通过应用的ApplicationInfo的accessTokenId字段获得。
policiesArray<PathPolicyInfo>是需要授权路径的策略信息，policies数组大小上限为500。
policyTypePolicyType是要查询的授权类型，具体是临时授权或持久化授权。

返回值：

类型说明
Promise<Array<boolean>>Promise对象，返回true表示授权类型匹配policyType的查询类型，否则返回false。

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

错误码ID错误信息
201Permission verification failed, usually the result returned by VerifyAccessToken.
202The caller is not a system application.
401Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801Capability not supported.

示例：

import { BusinessError } from '@ohos.base';
import fileshare from '@ohos.fileshare';

async function checkPersistentPermissionExample() {
  try {
    let pathPolicyInfo1: fileshare.PathPolicyInfo = {
      path: "/storage/Users/currentUser/Documents/1.txt",
      operationMode: fileshare.OperationMode.READ_MODE,
    }
    let pathPolicyInfo2: fileshare.PathPolicyInfo = {
      path: "/storage/Users/currentUser/Desktop/2.txt",
      operationMode: fileshare.OperationMode.READ_MODE,
    }

    let policies: Array<fileshare.PathPolicyInfo> = [pathPolicyInfo1, pathPolicyInfo2];
    let policyType: fileshare.PolicyType = fileshare.PolicyType.PERSISTENT_TYPE;
    let tokenid = 537688848; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
    
    fileshare.checkPathPermission(tokenid, policies, policyType).then((result:Array<boolean>) => {
      for (let x of result) {
        console.info('check permission result is', x);
      }
    })
    console.info("checkPathPermission finish");
  }
  catch (error) {
    console.info(error.code + 'checkPathPermission error' + error.message);
  }
}

fileShare.grantUriPermission20+

grantUriPermission(policies: Array<PolicyInfo>, targetBundleName: string, appCloneIndex: number): Promise<void>

给应用授予目标文件临时权限，使用Promise异步回调。

需要权限：ohos.permission.FILE_ACCESS_MANAGER

系统接口：此接口为系统接口。

系统能力：SystemCapability.FileManagement.AppFileService.FolderAuthorization

参数：

参数名类型必填说明
policiesArray<PolicyInfo>是需要授权路径的策略信息，policies数组大小上限为500。
targetBundleNamestring是被授权应用的应用包名。
appCloneIndexnumber是被授权应用的分身索引，取值为0时表示主应用。

返回值：

类型说明
Promise<void>Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和文件管理子系统错误码。

错误码ID错误信息
201Permission verification failed, usually the result returned by VerifyAccessToken.
202The caller is not a system application.
801Capability not supported.
13900001Operation not permitted.
13900011Out of memory.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { fileShare } from '@kit.CoreFileKit';

async function grantUriPermissionExample() {
  try {
    let uri = "file://docs/storage/Users/currentUser/Documents/1.txt";
    let policyInfo: fileShare.PolicyInfo = {
      uri: uri,
      operationMode: fileShare.OperationMode.CREATE_MODE|fileShare.OperationMode.READ_MODE,
    };
    let policies: Array<fileShare.PolicyInfo> = [policyInfo];

    fileShare.grantUriPermission(policies, "com.example.myapplicationtest", 0).then(() => {
    }).catch((err: BusinessError<Array<fileShare.PolicyErrorResult>>) => {
      console.error("grantUriPermission failed. Code: " +
      err.code + ", message: " + err.message);
    });
  }
  catch (error) {
    console.info('grantUriPermission error, Code: ' + error.code + ', message: ' + error.message);
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Core File Kit（文件基础服务）

harmony 鸿蒙Environment

harmony 鸿蒙FileIO

harmony 鸿蒙FileShare_PolicyErrorResult

harmony 鸿蒙FileShare_PolicyInfo

harmony 鸿蒙error_code.h

harmony 鸿蒙文件管理错误码

harmony 鸿蒙FileShare

harmony 鸿蒙FileUri

harmony 鸿蒙@ohos.application.BackupExtensionAbility (备份恢复扩展能力)(系统接口)

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/9hAImA