@ohos.privacyManager (隐私管理)


@ohos.privacyManager (隐私管理)

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

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

导入模块

import privacyManager from '@ohos.privacyManager';
1

privacyManager.addPermissionUsedRecord

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
tokenID number 调用方的应用身份标识。可通过应用的ApplicationInfo获得。
permissionName Permissions 应用权限名称。
successCount number 访问成功的次数。
failCount number 访问失败的次数。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0).then(() => {
        console.log('addPermissionUsedRecord success');
    }).catch((err) => {
        console.log(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12

privacyManager.addPermissionUsedRecord

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
tokenID number 调用方的应用身份标识。可通过应用的ApplicationInfo获得。
permissionName Permissions 应用权限名称。
successCount number 访问成功的次数。
failCount number 访问失败的次数。
callback AsyncCallback<void> 回调函数。当添加使用记录成功时,err为undefine;否则为错误对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0, (err, data) => {
        if (err) {
            console.log(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
        } else {
            console.log('addPermissionUsedRecord success');
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

privacyManager.getPermissionUsedRecords

getPermissionUsedRecords(request: PermissionUsedRequest): Promise<PermissionUsedResponse>

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
request PermissionUsedRequest 查询权限使用记录的请求。

返回值:

类型 说明
Promise<PermissionUsedResponse> Promise对象。返回查询的权限使用记录。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. the value of flag in request is invalid.
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let request = {
    "tokenId": 1,
    "isRemote": false,
    "deviceId": "device",
    "bundleName": "bundle",
    "permissionNames": [],
    "beginTime": 0,
    "endTime": 1,
    "flag":privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL,
};
try {
    privacyManager.getPermissionUsedRecords(request).then((data) => {
        console.log(`getPermissionUsedRecords success, data->${JSON.stringify(data)}`);
    }).catch((err) => {
        console.log(`getPermissionUsedRecords fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

privacyManager.getPermissionUsedRecords

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
request PermissionUsedRequest 查询权限使用记录的请求。
callback AsyncCallback<PermissionUsedResponse> 回调函数。当查询记录成功时,err为undefine,data为查询到的权限使用记录;否则为错误对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. the value of flag in request is invalid.
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let request = {
    "tokenId": 1,
    "isRemote": false,
    "deviceId": "device",
    "bundleName": "bundle",
    "permissionNames": [],
    "beginTime": 0,
    "endTime": 1,
    "flag":privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL,
};
try {
    privacyManager.getPermissionUsedRecords(request, (err, data) => {
        if (err) {
            console.log(`getPermissionUsedRecords fail, err->${JSON.stringify(err)}`);
        } else {
            console.log(`getPermissionUsedRecords success, data->${JSON.stringify(data)}`);
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

privacyManager.startUsingPermission

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
tokenID number 调用方的应用身份标识。可通过应用的ApplicationInfo获得。
permissionName Permissions 需要使用的权限名。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100004 The interface is called repeatedly with the same input. It means the application specified by the tokenID has been using the specified permission.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.startUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS").then(() => {
        console.log('startUsingPermission success');
    }).catch((err) => {
        console.log(`startUsingPermission fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12

privacyManager.startUsingPermission

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
tokenID number 调用方的应用身份标识。可通过应用的ApplicationInfo获得。
permissionName Permissions 需要使用的权限名。
callback AsyncCallback<void> 回调函数。当开始使用权限成功时,err为undefine;否则为错误对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100004 The interface is called repeatedly with the same input. It means the application specified by the tokenID has been using the specified permission.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.startUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS", (err, data) => {
        if (err) {
            console.log(`startUsingPermission fail, err->${JSON.stringify(err)}`);
        } else {
            console.log('startUsingPermission success');
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

privacyManager.stopUsingPermission

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
tokenID number 调用方的应用身份标识。可通过应用的ApplicationInfo获得。
permissionName Permissions 需要使用的权限名。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100004 The interface is not used with
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.stopUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS").then(() => {
        console.log('stopUsingPermission success');
    }).catch((err) => {
        console.log(`stopUsingPermission fail, err->${JSON.stringify(err)}`);
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12

privacyManager.stopUsingPermission

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
tokenID number 调用方的应用身份标识。可通过应用的ApplicationInfo获得。
permissionName Permissions 需要使用的权限名。
callback AsyncCallback<void> 回调函数。当停止使用权限成功时,err为undefine;否则为错误对象。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100002 The specified tokenID does not exist or it does not refer to an application process.
12100003 The specified permission does not exist or it is not an user_grant permission.
12100004 The interface is not used with
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
try {
    privacyManager.stopUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS", (err, data) => {
        if (err) {
            console.log(`stopUsingPermission fail, err->${JSON.stringify(err)}`);
        } else {
            console.log('stopUsingPermission success');
        }
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

privacyManager.on

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
type string 订阅事件类型,固定为'activeStateChange',权限使用状态变更事件。
permissionNameList Array<Permissions> 订阅的权限名列表,为空时表示订阅所有的权限使用状态变化。
callback Callback<ActiveChangeResponse> 订阅指定权限使用状态变更事件的回调。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The tokenID is 0
12100004 The interface is called repeatedly with the same input.
12100005 The registration time has exceeded the limitation.
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let permissionNameList = [];
try {
    privacyManager.on('activeStateChange', permissionNameList, (data) => {
        console.debug("receive permission state change, data:" + JSON.stringify(data));
    });
} catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8
9
10

privacyManager.off

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

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

需要权限: ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。

系统能力: SystemCapability.Security.AccessToken

参数:

参数名 类型 必填 说明
type string 订阅事件类型,固定为'activeStateChange',权限使用状态变更事件。
permissionNameList Array<Permissions> 订阅的权限名列表,为空时表示订阅所有的权限状态变化,必须与on的输入一致。
callback Callback<ActiveChangeResponse> 取消订阅指定tokenId与指定权限名状态变更事件的回调。

错误码:

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

错误码ID 错误信息
12100001 The parameter is invalid. The permissionName in list is all invalid or the list size is larger than 1024.
12100004 The interface is not used with
12100007 Service is abnormal.
12100008 Out of memory.

示例:

import privacyManager from '@ohos.privacyManager';

let permissionNameList = [];
try {
    privacyManager.off('activeStateChange', permissionNameList);
}catch(err) {
    console.log(`catch err->${JSON.stringify(err)}`);
}
1
2
3
4
5
6
7
8

PermissionUsageFlag

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

系统能力: SystemCapability.Security.AccessToken

名称 说明
FLAG_PERMISSION_USAGE_SUMMARY 0 表示查询总览数据。
FLAG_PERMISSION_USAGE_DETAIL 1 表示查询详细数据。

PermissionUsedRequest

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

系统能力: SystemCapability.Security.AccessToken

名称 类型 必填 说明
tokenId number 目标应用的身份标识。
isRemote boolean 默认值false。
deviceId string 目标应用所在设备的ID。
bundleName string 目标应用的包名。
permissionNames Array<Permissions> 需要查询的权限集合。
beginTime number 查询的起始时间,单位:ms,默认值0,不设定起始时间。
endTime number 查询的终止时间,单位:ms,默认值0,不设定终止时间。
flag PermissionUsageFlag 查询方式,默认值FLAG_PERMISSION_USAGE_SUMMARY。

PermissionUsedResponse

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

系统能力: SystemCapability.Security.AccessToken

名称 类型 必填 说明
beginTime number 查询记录的起始时间,单位:ms。
endTime number 查询记录的终止时间,单位:ms。
bundleRecords Array<BundleUsedRecord> 应用的权限使用记录集合。

BundleUsedRecord

某个应用的访问记录。

系统能力: SystemCapability.Security.AccessToken

名称 类型 必填 说明
tokenId number 目标应用的身份标识。
isRemote boolean 默认值false。
deviceId string 目标应用所在设备的ID。
bundleName string 目标应用的包名。
permissionRecords Array<PermissionUsedRecord> 每个应用的权限使用记录集合。

PermissionUsedRecord

某个权限的访问记录。

系统能力: SystemCapability.Security.AccessToken

名称 类型 必填 说明
permissionName Permissions 权限名。
accessCount number 该权限访问总次数。
rejectCount number 该权限拒绝总次数。
lastAccessTime number 最后一次访问时间,单位:ms。
lastRejectTime number 最后一次拒绝时间,单位:ms。
lastAccessDuration number 最后一次访问时长,单位:ms。
accessRecords Array<UsedRecordDetail> 访问记录集合,当flag为FLAG_PERMISSION_USAGE_SUMMARY时生效,默认查询10条。
rejectRecords Array<UsedRecordDetail> 拒绝记录集合,当flag为FLAG_PERMISSION_USAGE_SUMMARY时生效,默认查询10条。

UsedRecordDetail

单次访问记录详情。

系统能力: SystemCapability.Security.AccessToken

名称 类型 必填 说明
status number 访问状态。
timestamp number 访问时的时间戳,单位:ms。
accessDuration number 访问时长,单位:ms。

PermissionActiveStatus

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

系统能力: SystemCapability.Security.AccessToken

名称 说明
PERM_INACTIVE 0 表示未使用权限。
PERM_ACTIVE_IN_FOREGROUND 1 表示前台使用权限。
PERM_ACTIVE_IN_BACKGROUND 2 表示后台使用权限。

ActiveChangeResponse

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

系统能力: SystemCapability.Security.AccessToken

名称 类型 可读 可写 说明
tokenId number 被订阅的应用身份标识
permissionName Permissions 权限使用状态发生变化的权限名
deviceId string 设备号
activeStatus PermissionActiveStatus 权限使用状态变化类型