通过Picker选择文件或文件夹进行临时授权,该方式获取到的URI只具有临时读写权限。应用后续可按需通过文件分享接口(ohos.fileshare)进行持久化授权。
应用仅临时需要访问公共目录的数据,例如:通讯类应用需要发送用户的文件或者图片。应用调用Picker的(select)接口选择需要发送的文件或者图片,此时应用获取到的是该文件的临时访问权限,应用重启或者设备重启后,再次访问该文件则仍需使用Picker进行文件选择。
应用如果需要长期访问某个文件或目录时,可以通过Picker选择文件或文件夹进行临时授权,然后利用persistPermission接口(ohos.fileshare.persistPermission)对授权进行持久化(在授权方同意被持久化的情况下,例如使用Picker选择文件场景,Picker会将权限授予当前应用,即可进行授权持久化),例如:文档编辑类应用本次编辑完一个用户文件,期望在历史记录中可以直接选中打开,无需再拉起Picker进行选择授权。
可使用canIUse(),确认设备是否具有以下系统能力:SystemCapability.FileManagement.AppFileService.FolderAuthorization。
if (!canIUse('SystemCapability.FileManagement.AppFileService.FolderAuthorization')) {
console.error('this api is not supported on this device');
return;
} 需要权限
ohos.permission.FILE_ACCESS_PERSIST,具体参考访问控制-申请应用权限。
示例:
import { BusinessError } from '@kit.BasicServicesKit';
import { picker, fileShare } from '@kit.CoreFileKit';
import { common } from '@kit.AbilityKit';
import { preferences } from '@kit.ArkData';
export async function persistPermissionExample(context: common.UIAbilityContext): Promise<void> {
try {
// ...
let store = await preferences.getPreferences(context, { name: 'persist_permission' });
let documentSelectOptions = new picker.DocumentSelectOptions();
let documentPicker = new picker.DocumentViewPicker();
let uris = await documentPicker.select(documentSelectOptions);
if (uris.length === 0) {
console.info('No URI selected');
return;
}
// 可以组合授予多个权限,例如读写权限可使用fileShare.OperationMode.READ_MODE | fileShare.OperationMode.WRITE_MODE。
// 注意:只能对已获取到的临时权限进行持久化授权操作,否则会报错。
let policyInfo: fileShare.PolicyInfo = {
uri: uris[0],
operationMode: fileShare.OperationMode.READ_MODE,
};
let policies: fileShare.PolicyInfo[] = [policyInfo];
await fileShare.persistPermission(policies);
// 此示例保存最近一次成功持久化授权的URI,供激活和撤销操作使用。
await store.put('uri', uris[0]);
await store.flush();
console.info('persistPermission successfully');
} catch (error) {
let err = error as BusinessError<Array<fileShare.PolicyErrorResult>>;
console.error(`persistPermission failed with err, Error code: ${err.code}, message: ${err.message}`);
if (err.code === 13900001 && err.data) {
for (let i = 0; i < err.data.length; i++) {
console.error('error code : ' + JSON.stringify(err.data[i].code));
console.error('error uri : ' + JSON.stringify(err.data[i].uri));
console.error('error reason : ' + JSON.stringify(err.data[i].message));
}
}
}
}
备注:C/C++持久化授权接口说明及开发指南具体参考:OH_FileShare_PersistPermission持久化授权接口。
可以通过revokePermission接口(ohos.fileshare.revokePermission)对已持久化的文件取消授权,同时更新应用存储的数据以删除最近访问数据。
需要权限
ohos.permission.FILE_ACCESS_PERSIST,具体参考访问控制-申请应用权限。
示例:
import { BusinessError } from '@kit.BasicServicesKit';
import { picker, fileShare } from '@kit.CoreFileKit';
import { common } from '@kit.AbilityKit';
import { preferences } from '@kit.ArkData';
// ...
export async function revokePermissionExample(context: common.UIAbilityContext): Promise<void> {
try {
let store = await preferences.getPreferences(context, { name: 'persist_permission' });
// 使用Picker获取且成功持久化授权的URI,不手动构造URI。
let uri = await store.get('uri', '') as string;
if (uri.length === 0) {
console.info('Persist a URI before using this operation');
return;
}
// 可以组合取消多个权限,例如读写权限可使用fileShare.OperationMode.READ_MODE | fileShare.OperationMode.WRITE_MODE。
// 注意:只能对已获取到的持久化权限进行取消持久化授权操作,否则会报错。
let policyInfo: fileShare.PolicyInfo = {
uri: uri,
operationMode: fileShare.OperationMode.READ_MODE,
};
let policies: fileShare.PolicyInfo[] = [policyInfo];
await fileShare.revokePermission(policies);
await store.delete('uri');
await store.flush();
console.info('revokePermission successfully');
} catch (error) {
let err = error as BusinessError<Array<fileShare.PolicyErrorResult>>;
console.error(`revokePermission failed with err, Error code: ${err.code}, message: ${err.message}`);
if (err.code === 13900001 && err.data) {
for (let i = 0; i < err.data.length; i++) {
console.error('error code : ' + JSON.stringify(err.data[i].code));
console.error('error uri : ' + JSON.stringify(err.data[i].uri));
console.error('error reason : ' + JSON.stringify(err.data[i].message));
}
}
}
}
备注:C/C++去持久化授权接口说明及开发指南具体参考:OH_FileShare_RevokePermission去持久化授权接口。
对于应用已经持久化的授权,应用每次启动时实际未加载到内存中,需要应用按需进行手动激活已持久化授权的权限,通过activatePermission接口(ohos.fileshare.activatePermission)对已经持久化授权的权限进行使能操作,否则已经持久化授权的权限仍存在不能使用的情况。
需要权限
ohos.permission.FILE_ACCESS_PERSIST,具体参考访问控制-申请应用权限。
示例:
import { BusinessError } from '@kit.BasicServicesKit';
import { picker, fileShare } from '@kit.CoreFileKit';
import { common } from '@kit.AbilityKit';
import { preferences } from '@kit.ArkData';
// ...
export async function activatePermissionExample(context: common.UIAbilityContext): Promise<void> {
try {
let store = await preferences.getPreferences(context, { name: 'persist_permission' });
// 使用Picker获取且成功持久化授权的URI,不手动构造URI。
let uri = await store.get('uri', '') as string;
if (uri.length === 0) {
console.info('Persist a URI before using this operation');
return;
}
// 可以组合激活多个权限,例如读写权限可使用fileShare.OperationMode.READ_MODE | fileShare.OperationMode.WRITE_MODE。
// 注意:只能对已获取到的持久化权限进行激活持久化授权操作,否则会报错。
let policyInfo: fileShare.PolicyInfo = {
uri: uri,
operationMode: fileShare.OperationMode.READ_MODE,
};
let policies: fileShare.PolicyInfo[] = [policyInfo];
await fileShare.activatePermission(policies);
console.info('activatePermission successfully');
} catch (error) {
let err = error as BusinessError<Array<fileShare.PolicyErrorResult>>;
console.error(`activatePermission failed with err, Error code: ${err.code}, message: ${err.message}`);
if (err.code === 13900001 && err.data) {
for (let i = 0; i < err.data.length; i++) {
console.error('error code : ' + JSON.stringify(err.data[i].code));
console.error('error uri : ' + JSON.stringify(err.data[i].uri));
console.error('error reason : ' + JSON.stringify(err.data[i].message));
}
}
}
}
备注:C/C++持久化授权激活接口说明及开发指南具体参考:OH_FileShare_ActivatePermission持久化授权激活接口。
从API version 24开始,系统新增支持持久化权限保留能力。应用卸载时根据ohos.fileshare.supportPreservePersistentPermission标签保留持久化权限。再次安装时恢复上次已保留的持久化权限。
开发者可在应用模块级配置文件src/main/module.json5的module标签中metadata里配置ohos.fileshare.supportPreservePersistentPermission标签,以启用持久化权限保留能力。
metadata标签配置示例
{
"module": {
// ...
"metadata": [
{
"name": "ohos.fileshare.supportPreservePersistentPermission"
}
],
// ...
}
} ohos.fileshare.supportPreservePersistentPermission标签说明
| 属性名称 | 含义 | 数据类型 | 是否可缺省 |
|---|---|---|---|
| name | 标识元信息名称,固定值为ohos.fileshare.supportPreservePersistentPermission。 | 字符串 | 该标签不可缺省。 |