1# @ohos.fileshare (文件分享)(系统接口) 2 3该模块提供文件分享能力，提供系统应用将公共目录文件统一资源标志符（Uniform Resource Identifier，URI）以读写权限授权给其他应用的接口，授权后应用可通过[@ohos.file.fs](js-apis-file-fs.md)的相关接口进行相关open、read、write等操作，实现文件分享。 4 5> **说明：** 6> 7> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> - 当前页面仅包含本模块的系统接口，其他公开接口参见[@ohos.fileshare (文件分享)](js-apis-fileShare-sys.md)。 9 10## 导入模块 11 12```ts 13import { fileShare } from '@kit.CoreFileKit'; 14``` 15 16## fileShare.grantUriPermission 17 18grantUriPermission(uri: string, bundleName: string, flag: wantConstant.Flags, callback: AsyncCallback<void>): void 19 20对公共目录文件URI进行授权操作，使用callback异步回调。 21 22**需要权限**：ohos.permission.WRITE_MEDIA 23 24**系统接口**：此接口为系统接口。 25 26**系统能力**：SystemCapability.FileManagement.AppFileService 27 28**参数：** 29 30| 参数名 | 类型| 必填 | 说明| 31| ------ |---------| ---- |-----------| 32| uri | string| 是 | 公共目录文件uri。 | 33| bundleName | string| 是 | 分享目标的包名。 | 34| flag | [wantConstant.Flags](../apis-ability-kit/js-apis-app-ability-wantConstant.md#flags) | 是 | 授权的权限。 | 35 | callback | AsyncCallback<void>| 是 | 异步授权之后的回调。 | 36 37**错误码：** 38 39以下错误码的详细介绍请参见[文件管理错误码](errorcode-filemanagement.md) 40 41| 错误码ID| 错误信息| 42| ------ | ------- | 43| 201 | Permission verification failed. | 44| 202 | The caller is not a system application. | 45| 401 | The input parameter is invalid. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. | 46| 143000001 | IPC error. | 47 48**示例：** 49 50 ```ts 51 import { wantConstant } from '@kit.AbilityKit'; 52 import { BusinessError } from '@kit.BasicServicesKit'; 53 let uri: string = 'file://docs/storage/Users/currentUser/Document/1.txt'; // 推荐使用系统接口生成URI。fileUri.getUriFromPath("沙箱路径"); 54 let bundleName: string = 'com.demo.test'; 55 try { 56 fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION | 57 wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION, (err: BusinessError) => { 58 if (err) { 59 console.error("grantUriPermission failed with error: " + JSON.stringify(err)); 60 return; 61 } 62 console.info("grantUriPermission success!"); 63 }); 64 } catch (err) { 65 let error: BusinessError = err as BusinessError; 66 console.error("grantUriPermission failed with error:" + JSON.stringify(error)); 67 } 68 ``` 69 70## fileShare.grantUriPermission 71 72grantUriPermission(uri: string, bundleName: string, flag: wantConstant.Flags): Promise<void> 73 74将公共目录文件URI进行授权操作，使用Promise异步回调。 75 76**需要权限**：ohos.permission.WRITE_MEDIA 77 78**系统接口**：此接口为系统接口。 79 80**系统能力**：SystemCapability.FileManagement.AppFileService 81 82**参数：** 83 84| 参数名 | 类型| 必填 | 说明 | 85| ------ |-------| ---- |-----------| 86| uri | string| 是 | 公共目录文件uri。 | 87| bundleName | string| 是 | 分享目标的包名。 | 88| flag | [wantConstant.Flags](../apis-ability-kit/js-apis-app-ability-wantConstant.md#flags) | 是 | 授权的权限。 | 89 90**返回值：** 91 92 | 类型 | 说明 | 93 | ---------- | ---------- | 94 | Promise<void> | Promise对象，无返回值。 | 95 96**错误码：** 97 98以下错误码的详细介绍请参见[文件管理错误码](errorcode-filemanagement.md)。 99 100| 错误码ID| 错误信息| 101| ------- | ---------- | 102| 201 | Permission verification failed. | 103| 202 | The caller is not a system application. | 104| 401 | The input parameter is invalid. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. | 105| 143000001 | IPC error. | 106 107**示例：** 108 109 ```ts 110 import { wantConstant } from '@kit.AbilityKit'; 111 import { BusinessError } from '@kit.BasicServicesKit'; 112 let uri: string = 'file://docs/storage/Users/currentUser/Document/1.txt'; // 推荐使用系统接口生成URI。fileUri.getUriFromPath("沙箱路径"); 113 let bundleName: string = 'com.demo.test'; 114 try { 115 fileShare.grantUriPermission(uri, bundleName, wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION | 116 wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION).then(() => { 117 console.info("grantUriPermission success!"); 118 }).catch((error: BusinessError) => { 119 console.error("grantUriPermission failed with error:" + JSON.stringify(error)); 120 }); 121 } catch (err) { 122 let error: BusinessError = err as BusinessError; 123 console.error("grantUriPermission failed with error:" + JSON.stringify(error)); 124 } 125 ``` 126 127## fileShare.checkPathPermission<sup>15+</sup> 128 129checkPathPermission(tokenID: number, policies: Array<PathPolicyInfo>, policyType: PolicyType): Promise<Array<boolean>> 130 131异步方法校验所选择的多个文件或目录是否有临时或持久化授权，以promise形式返回结果。 132 133**需要权限**：ohos.permission.CHECK_SANDBOX_POLICY 134 135**系统接口**：此接口为系统接口。 136 137**系统能力：** SystemCapability.FileManagement.AppFileService.FolderAuthorization 138 139**参数：** 140 141| 参数名 | 类型| 必填 | 说明| 142| -------- |-------| -------- |----------| 143| tokenID| number | 是 | 目标应用的身份标识。可通过应用的[ApplicationInfo](../apis-ability-kit/js-apis-bundleManager-applicationInfo.md)的accessTokenId字段获得。| 144| policies| Array<[PathPolicyInfo](js-apis-fileShare.md#pathpolicyinfo15)> | 是 | 需要授权路径的策略信息，policies数组大小上限为500。| 145| policyType| [PolicyType](js-apis-fileShare.md#policytype15) | 是 | 要查询的授权类型，具体是临时授权或持久化授权。 | 146 147**返回值：** 148 149|类型|说明| 150| ------ | ------ | 151| Promise<Array<boolean>> | Promise对象，返回true表示授权类型匹配policyType的查询类型，否则返回false。 | 152 153**错误码：** 154 155以下错误码的详细介绍请参见[文件管理子系统错误码](errorcode-filemanagement.md)。 156 157| 错误码ID | 错误信息 | 158|----------| --------- | 159| 201 | Permission verification failed, usually the result returned by VerifyAccessToken.| 160| 202 | The caller is not a system application.| 161| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. | 162| 801 | Capability not supported. | 163 164**示例：** 165 166 ```ts 167 import { BusinessError } from '@ohos.base'; 168 import fileshare from '@ohos.fileshare'; 169 170 async function checkPersistentPermissionExample() { 171 try { 172 let pathPolicyInfo1: fileshare.PathPolicyInfo = { 173 path: "/storage/Users/currentUser/Documents/1.txt", 174 operationMode: fileshare.OperationMode.READ_MODE, 175 } 176 let pathPolicyInfo2: fileshare.PathPolicyInfo = { 177 path: "/storage/Users/currentUser/Desktop/2.txt", 178 operationMode: fileshare.OperationMode.READ_MODE, 179 } 180 181 let policies: Array<fileshare.PathPolicyInfo> = [pathPolicyInfo1, pathPolicyInfo2]; 182 let policyType: fileshare.PolicyType = fileshare.PolicyType.PERSISTENT_TYPE; 183 let tokenid = 537688848; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取 184 185 fileshare.checkPathPermission(tokenid, policies, policyType).then((result:Array<boolean>) => { 186 for (let x of result) { 187 console.info('check permission result is', x); 188 } 189 }) 190 console.info("checkPathPermission finish"); 191 } 192 catch (error) { 193 console.info(error.code + 'checkPathPermission error' + error.message); 194 } 195 } 196 ```