Persisting Temporary Permissions (ArkTS)
When to Use
If an application accesses a file by using Picker, the permission for accessing the file will be automatically invalidated after the application exits or the device restarts. To retain the permission for accessing the file, you need to persist the temporarily granted permission.
Persisting a Temporary Permission Granted by Picker
Persisting a Temporary Permission
You can use Picker to select a file or folder, and persist the temporary permission granted by Picker by using the API provided by ohos.fileshare.
When an application needs to temporarily access data in a user directory, for example, a communication application needs to send a user file or image, it calls select() of Picker to select the file or image to be sent. In this case, the application obtains the temporary permission for accessing the file or image. To access the file or image after the application or device is restarted, the application still needs to call a Picker API.
Sometimes, an application needs to access a file or folder multiple times. For example, after editing a user file, a file editor application needs to select and open the file directly from the history records. To address this need, you can use Picker to select the file, and use ohos.fileshare.persistPermission to persist the temporary permission granted by Picker.
Before persisting a temporary permission, ensure that:
- The device must have the SystemCapability.FileManagement.File.Environment.FolderObtain system capability. You can use canIUse() to check whether the device has the required system capability.
if (!canIUse('SystemCapability.FileManagement.File.Environment.FolderObtain')) {
console.error('this api is not supported on this device');
return;
}
- The application must have the ohos.permission.FILE_ACCESS_PERSIST permission. For details about how to request the permission, see Workflow for Requesting Permissions.
Example
import { BusinessError } from '@kit.BasicServicesKit';
import { picker } from '@kit.CoreFileKit';
import { fileShare } from '@kit.CoreFileKit';
async function persistPermissionExample() {
try {
let DocumentSelectOptions = new picker.DocumentSelectOptions();
let documentPicker = new picker.DocumentViewPicker();
let uris = await documentPicker.select(DocumentSelectOptions);
let policyInfo: fileShare.PolicyInfo = {
uri: uris[0],
operationMode: fileShare.OperationMode.READ_MODE,
};
let policies: Array<fileShare.PolicyInfo> = [policyInfo];
fileShare.persistPermission(policies).then(() => {
console.info("persistPermission successfully");
}).catch((err: BusinessError<Array<fileShare.PolicyErrorResult>>) => {
console.error("persistPermission failed with error message: " + err.message + ", error code: " + err.code);
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));
}
}
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error('persistPermission failed with err: ' + JSON.stringify(err));
}
}
NOTE
- You are advised to save the URI of the file with persistent permission for the related application locally to facilitate the subsequent activation.
- The permission persistence data is also stored in the system database. After the application or device is restarted, the persistent permission can be used only after being activated. For details, see Activating a Persistent Permission.
- The APIs used for persisting permissions are available only for 2-in-1 devices. You can use canIUse() to check whether the device has the required system capability. The caller must also have the required permissions.
- When an application is uninstalled, all the permission authorization data will be deleted. After the application is reinstalled, re-authorization is required.
For details about how to persist a temporary permission using C/C++ APIs, see OH_FileShare_PersistPermission.
Revoking a Temporary Permission
You can use ohos.fileshare.revokePermission to revoke the persistent permission from a file, and update the data stored in the application to delete the file URI from the recently accessed data.
Required Permissions
ohos.permission.FILE_ACCESS_PERSIST. For details about how to request the permission, see Workflow for Requesting Permissions.
Example
import { BusinessError } from '@kit.BasicServicesKit';
import { picker } from '@kit.CoreFileKit';
import { fileShare } from '@kit.CoreFileKit';
async function revokePermissionExample() {
try {
let uri = "file://docs/storage/Users/username/tmp.txt";
let policyInfo: fileShare.PolicyInfo = {
uri: uri,
operationMode: fileShare.OperationMode.READ_MODE,
};
let policies: Array<fileShare.PolicyInfo> = [policyInfo];
fileShare.revokePermission(policies).then(() => {
console.info("revokePermission successfully");
}).catch((err: BusinessError<Array<fileShare.PolicyErrorResult>>) => {
console.error("revokePermission failed with error message: " + err.message + ", error code: " + err.code);
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));
}
}
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error('revokePermission failed with err: ' + JSON.stringify(err));
}
}
NOTE
- The URI in the example comes from the permission persistence data stored for the application.
- You are advised to activate the persistent permissions based on service requirements. Do not activate all persistent permissions.
- The APIs used for persisting permissions are available only for 2-in-1 devices. You can use canIUse() to check whether the device has the required system capability. The caller must also have the required permissions.
For details about how to revoke temporary permission using C/C++ APIs, see OH_FileShare_RevokePermission.
Activating a Persistent Permission for Accessing a File or Folder
Each time an application is started, its persistent permissions have not been loaded to the memory. To make a persistent permission still valid after the application is restarted, use ohos.fileshare.activatePermission to activate the permission.
Required Permissions
ohos.permission.FILE_ACCESS_PERSIST. For details about how to request the permission, see Workflow for Requesting Permissions.
Example
import { BusinessError } from '@kit.BasicServicesKit';
import { picker } from '@kit.CoreFileKit';
import { fileShare } from '@kit.CoreFileKit';
async function activatePermissionExample() {
try {
let uri = "file://docs/storage/Users/username/tmp.txt";
let policyInfo: fileShare.PolicyInfo = {
uri: uri,
operationMode: fileShare.OperationMode.READ_MODE,
};
let policies: Array<fileShare.PolicyInfo> = [policyInfo];
fileShare.activatePermission(policies).then(() => {
console.info("activatePermission successfully");
}).catch((err: BusinessError<Array<fileShare.PolicyErrorResult>>) => {
console.error("activatePermission failed with error message: " + err.message + ", error code: " + err.code);
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));
if (err.data[i].code == fileShare.PolicyErrorCode.PERMISSION_NOT_PERSISTED) {
// Persist the permission for a file or folder and then activate it.
}
}
}
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error('activatePermission failed with err: ' + JSON.stringify(err));
}
}
NOTE
- The URI in the example comes from the permission persistence data stored for the application.
- You are advised to activate the persistent permissions based on service requirements. Do not activate all persistent permissions.
- If the activation fails because the permission has not been persisted, persist the permission first.
- The APIs used for persisting permissions are available only for 2-in-1 devices. You can use canIUse() to check whether the device has the required system capability. The caller must also have the required permissions.
For details about how to activate a persistent permission using C/C++ APIs, see OH_FileShare_ActivatePermission.