@ohos.privacyManager (隐私管理)

本模块主要提供权限使用记录等隐私管理接口。

说明： 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 本模块接口为系统接口。

导入模块

import privacyManager from '@ohos.privacyManager';

privacyManager.addPermissionUsedRecord

addPermissionUsedRecord(tokenID: number, permissionName: Permissions, successCount: number, failCount: number): Promise<void>

受应用权限保护的应用在被其他服务、应用调用时，可以使用该接口增加一条权限使用记录。使用Promise异步回调。 权限使用记录包括：调用方的应用身份标识、使用的应用权限名称，和其访问本应用成功、失败的次数。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.addPermissionUsedRecord(tokenID, 'ohos.permission.READ_AUDIO', 1, 0).then(() => {
        console.log('addPermissionUsedRecord success');
    }).catch((err: BusinessError) => {
        console.log(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.addPermissionUsedRecord

addPermissionUsedRecord(tokenID: number, permissionName: Permissions, successCount: number, failCount: number, callback: AsyncCallback<void>): void

受应用权限保护的应用在被其他服务、应用调用时，可以使用该接口增加一条权限使用记录。使用callback异步回调。 权限使用记录包括：调用方的应用身份标识、使用的应用权限名称，和其访问本应用成功、失败的次数。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.addPermissionUsedRecord(tokenID, 'ohos.permission.READ_AUDIO', 1, 0, (err: BusinessError, data: void) => {
        if (err) {
            console.log(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
        } else {
            console.log('addPermissionUsedRecord success');
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.getPermissionUsedRecord

getPermissionUsedRecord(request: PermissionUsedRequest): Promise<PermissionUsedResponse>

获取历史权限使用记录。使用Promise异步回调。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let request: privacyManager.PermissionUsedRequest = {
    'tokenId': 1,
    'isRemote': false,
    'deviceId': 'device',
    'bundleName': 'bundle',
    'permissionNames': [],
    'beginTime': 0,
    'endTime': 1,
    'flag':privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL,
};
try {
    privacyManager.getPermissionUsedRecord(request).then((data) => {
        console.log(`getPermissionUsedRecord success, data->${JSON.stringify(data)}`);
    }).catch((err: BusinessError) => {
        console.log(`getPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.getPermissionUsedRecord

getPermissionUsedRecord(request: PermissionUsedRequest, callback: AsyncCallback<PermissionUsedResponse>): void

获取历史权限使用记录。使用callback异步回调。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let request: privacyManager.PermissionUsedRequest = {
    'tokenId': 1,
    'isRemote': false,
    'deviceId': 'device',
    'bundleName': 'bundle',
    'permissionNames': [],
    'beginTime': 0,
    'endTime': 1,
    'flag':privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL,
};
try {
    privacyManager.getPermissionUsedRecord(request, (err: BusinessError, data: privacyManager.PermissionUsedResponse) => {
        if (err) {
            console.log(`getPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
        } else {
            console.log(`getPermissionUsedRecord success, data->${JSON.stringify(data)}`);
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.startUsingPermission

startUsingPermission(tokenID: number, permissionName: Permissions): Promise<void>

应用开始使用某项权限，可监听应用在前后台使用权限，并将使用权限的记录落盘，由系统服务调用。使用Promise异步回调。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.startUsingPermission(tokenID, 'ohos.permission.READ_AUDIO').then(() => {
        console.log('startUsingPermission success');
    }).catch((err: BusinessError) => {
        console.log(`startUsingPermission fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.startUsingPermission

startUsingPermission(tokenID: number, permissionName: Permissions, callback: AsyncCallback<void>): void

应用开始使用某项权限，可监听应用在前后台使用权限，并将使用权限的记录落盘，由系统服务调用。使用callback异步回调。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.startUsingPermission(tokenID, 'ohos.permission.READ_AUDIO', (err: BusinessError, data: void) => {
        if (err) {
            console.log(`startUsingPermission fail, err->${JSON.stringify(err)}`);
        } else {
            console.log('startUsingPermission success');
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.stopUsingPermission

stopUsingPermission(tokenID: number, permissionName: Permissions): Promise<void>

应用停止使用某项权限，与Start对应，由系统服务调用。使用Promise异步回调。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.stopUsingPermission(tokenID, 'ohos.permission.READ_AUDIO').then(() => {
        console.log('stopUsingPermission success');
    }).catch((err: BusinessError) => {
        console.log(`stopUsingPermission fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.stopUsingPermission

stopUsingPermission(tokenID: number, permissionName: Permissions, callback: AsyncCallback<void>): void

应用停止使用某项权限，与Start对应，由系统服务调用。使用callback异步回调。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

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

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.stopUsingPermission(tokenID, 'ohos.permission.READ_AUDIO', (err: BusinessError, data: void) => {
        if (err) {
            console.log(`stopUsingPermission fail, err->${JSON.stringify(err)}`);
        } else {
            console.log('stopUsingPermission success');
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.on

on(type: 'activeStateChange', permissionList: Array<Permissions>, callback: Callback<ActiveChangeResponse>): void

订阅指定权限列表的权限使用状态变更事件。

允许相同permissionList订阅多个callback。

不允许存在交集的permissionList订阅相同callback。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import privacyManager, { Permissions } from '@ohos.privacyManager';
import { BusinessError } from '@ohos.base';

let permissionList: Array<Permissions> = [];
try {
    privacyManager.on('activeStateChange', permissionList, (data: privacyManager.ActiveChangeResponse) => {
        console.debug('receive permission state change, data:' + JSON.stringify(data));
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

privacyManager.off

off(type: 'activeStateChange', permissionList: Array<Permissions>, callback?: Callback<ActiveChangeResponse>): void

取消订阅指定权限列表的权限使用状态变更事件。

取消订阅不传callback时，批量删除permissionList下面的所有callback。

需要权限： ohos.permission.PERMISSION_USED_STATS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import privacyManager, { Permissions } from '@ohos.privacyManager';

let permissionList: Array<Permissions> = [];
try {
    privacyManager.off('activeStateChange', permissionList);
}catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}

PermissionUsageFlag

使用记录的查询方式的枚举。

系统能力： SystemCapability.Security.AccessToken

PermissionUsedRequest

表示使用记录的查询请求。

系统能力： SystemCapability.Security.AccessToken

PermissionUsedResponse

表示所有应用的访问记录。

系统能力： SystemCapability.Security.AccessToken

BundleUsedRecord

某个应用的访问记录。

系统能力： SystemCapability.Security.AccessToken

PermissionUsedRecord

某个权限的访问记录。

系统能力： SystemCapability.Security.AccessToken

UsedRecordDetail

单次访问记录详情。

系统能力： SystemCapability.Security.AccessToken

PermissionActiveStatus

表示权限使用状态变化类型的枚举。

系统能力： SystemCapability.Security.AccessToken

ActiveChangeResponse

表示某次权限使用状态变化的详情。

系统能力: SystemCapability.Security.AccessToken