FileShare Namespace

The FileShare to expose file permission API. More...

Header:	#include <FileShare>
qmake:	QT += ohosextras
Since:	Qt 5.12.12

Classes

class	ActionResult	The ActionResult class encapsulates the result of all file requested access permission actions.
class	CheckResult	The CheckResult class encapsulates the result of all requested file access permission checks.
class	PathPolicy	The PathPolicy struct encapsulates information required to request file access permissions for a specified path.
class	PathPolicyCheckResult	The PathPolicyCheckResult struct contains the result of a file permission check request for a specified path, indicating whether access is granted or denied.
class	PathPolicyErrorInfo	The PathPolicyErrorInfo struct contains the result of a file access permission request for a specified path.

Types

enum	OperationMode	{ Read, Write }
flags	OperationModes	(Typedef for QFlags<OperationMode>)
enum	PathPolicyError	{ Unknown, PersistenceForbidden, InvalidMode, InvalidPath, PermissionNotPersisted }

Functions

QSharedPointer<QtOhosExtras::FileShare::ActionResult>	activatePermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)
QSharedPointer<QtOhosExtras::FileShare::CheckResult>	checkPersistent(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)
QSharedPointer<QtOhosExtras::FileShare::ActionResult>	deactivatePermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)
QSharedPointer<QtOhosExtras::FileShare::ActionResult>	persistPermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)
const QMetaObject *	qt_getEnumMetaObject(QtOhosExtras::FileShare::OperationMode)
const char *	qt_getEnumName(QtOhosExtras::FileShare::OperationMode)
QSharedPointer<QtOhosExtras::FileShare::ActionResult>	revokePermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)
QFlags<OperationModes::enum_type>	operator\\|(OperationModes::enum_type f1, OperationModes::enum_type f2)
QFlags<OperationModes::enum_type>	operator\\|(OperationModes::enum_type f1, QFlags<OperationModes::enum_type> f2)
QIncompatibleFlag	operator\\|(OperationModes::enum_type f1, int f2)

Detailed Description

The FileShare to expose file permission API.

This API uses file system paths, which differ from the URIs used internally by HarmonyOS. For example, the path

/data/storage/el1/bundle/entry/resources/resfile/test.txt

will be converted to the URI

file://com.your.example/data/storage/el1/bundle/entry/resources/resfile/test.txt

, where

com.your.example

is app bundle name.

To learn more about file paths and URIs in HarmonyOS, see sandbox documentation.

Warning: This API relies on the underlying OHOS implementation. The following functions: persistPermission(), revokePermission(), activatePermission(), deactivatePermission(), and checkPersistent() may be unavailable on some devices. Additionally, there may be limitations on the maximum number of policies, and certain permissions may need to be explicitly granted to the application.

For more details and limitations, refer to the API documentation.

Type Documentation

enum FileShare::OperationMode

flags FileShare::OperationModes

Defines permissions on path. See FileShare_OperationMode. The flags can be combined using bitwise operations.

Constant	Value	Description
QtOhosExtras::FileShare::Read	1 << 0	Read on path
QtOhosExtras::FileShare::Write	1 << 1	Write on path

This enum was introduced or modified in Qt 5.12.12.

The OperationModes type is a typedef for QFlags<OperationMode>. It stores an OR combination of OperationMode values.

See also: PathPolicy.

enum FileShare::PathPolicyError

Defines permission policy error codes. See FileShare_PolicyErrorCode.

Constant	Value	Description
QtOhosExtras::FileShare::Unknown	0	Error type is unknown or not recognized
QtOhosExtras::FileShare::PersistenceForbidden	1	The permission on the path cannot be persisted
QtOhosExtras::FileShare::InvalidMode	2	Invalid operation mode
QtOhosExtras::FileShare::InvalidPath	3	Invalid path
QtOhosExtras::FileShare::PermissionNotPersisted	4	The permission is not persisted

This enum was introduced or modified in Qt 5.12.12.

See also: PathPolicyErrorInfo.

Function Documentation

QSharedPointer<QtOhosExtras::FileShare::ActionResult> FileShare::activatePermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)

Activates file or folder permissions from policies. The success of the action can be determined from ActionResult.

This function calls OH_FileShare_ActivatePermission. Each time an application is started, its persistent permissions have not been loaded to the memory. Use this function to make a persistent permission active after the application is started. If the activation fails because the permission has not been persisted, use persistPermission() first.

To deactivate an active permission, use deactivatePermission().

QSharedPointer<QtOhosExtras::FileShare::CheckResult> FileShare::checkPersistent(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)

Checks if file or folder permissions from policies have persistent permissions. The result check for each file or folder can be determined from CheckResult. CheckResult::PathPolicyCheckResult::result will be set to

true

for each file or folder only for succesufull check and persistent permission found,

false

otherwise.

This function calls OH_FileShare_CheckPersistentPermission.

To persist permission, use persistPermission().

See also: CheckResult, PathPolicy, and persistPermission().

QSharedPointer<QtOhosExtras::FileShare::ActionResult> FileShare::deactivatePermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)

Deactivates file or folder permissions from policies. The success of the action can be determined from ActionResult.

This function calls OH_FileShare_DeactivatePermission.

To activate permission, use activatePermission().

See also: ActionResult, PathPolicy, and activatePermission().

QSharedPointer<QtOhosExtras::FileShare::ActionResult> FileShare::persistPermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)

Persists file or folder permissions from policies. The success of the action can be determined from ActionResult.

This function calls OH_FileShare_PersistPermission. persistPermission() stores persistence data in the system database. After persistPermission() call, permissions are not yet active. Use activatePermission() to activate permissions. persistPermission() must be called at least once before activatePermission().

To revoke a persistent permission, use revokePermission().

QSharedPointer<QtOhosExtras::FileShare::ActionResult> FileShare::revokePermission(const QList<QtOhosExtras::FileShare::PathPolicy> &policies)

Revokes file or folder permissions from policies. The success of the action can be determined from ActionResult.

This function calls OH_FileShare_RevokePermission.

To persist permission, use persistPermission().

See also: ActionResult, PathPolicy, and persistPermission().

QFlags<OperationModes::enum_type> FileShare::operator|(OperationModes::enum_type f1, OperationModes::enum_type f2)

QFlags<OperationModes::enum_type> FileShare::operator|(OperationModes::enum_type f1, QFlags<OperationModes::enum_type> f2)

QIncompatibleFlag FileShare::operator|(OperationModes::enum_type f1, int f2)