@ohos.privacyManager (隐私管理)(系统接口)

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

说明：

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

导入模块

import { privacyManager } from '@kit.AbilityKit';

privacyManager.addPermissionUsedRecord

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

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

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tokenID: number = 0; // 可以通过getApplicationInfo获取accessTokenId
privacyManager.addPermissionUsedRecord(tokenID, 'ohos.permission.READ_AUDIO', 1, 0).then(() => {
  console.log('addPermissionUsedRecord success');
}).catch((err: BusinessError) => {
  console.error(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
});
// with options param
let options: privacyManager.AddPermissionUsedRecordOptions = {
  usedType: privacyManager.PermissionUsedType.PICKER_TYPE
};
privacyManager.addPermissionUsedRecord(tokenID, 'ohos.permission.READ_AUDIO', 1, 0, options).then(() => {
  console.log('addPermissionUsedRecord success');
}).catch((err: BusinessError) => {
  console.error(`addPermissionUsedRecord fail, 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 '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

privacyManager.getPermissionUsedRecord

getPermissionUsedRecord(request: PermissionUsedRequest): Promise<PermissionUsedResponse>

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

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let request: privacyManager.PermissionUsedRequest = {
    'tokenId': 1,
    'isRemote': false,
    'deviceId': 'device',
    'bundleName': 'bundle',
    'permissionNames': [],
    'beginTime': 0,
    'endTime': 1,
    'flag':privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL,
};

privacyManager.getPermissionUsedRecord(request).then((data) => {
  console.log(`getPermissionUsedRecord success, data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getPermissionUsedRecord fail, 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 '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let request: privacyManager.PermissionUsedRequest = {
    'tokenId': 1,
    'isRemote': false,
    'deviceId': 'device',
    'bundleName': 'bundle',
    'permissionNames': [],
    'beginTime': 0,
    'endTime': 1,
    'flag':privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL,
};

privacyManager.getPermissionUsedRecord(request, (err: BusinessError, data: privacyManager.PermissionUsedResponse) => {
  if (err) {
    console.error(`getPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
  } else {
    console.log(`getPermissionUsedRecord success, data->${JSON.stringify(data)}`);
  }
});

privacyManager.setPermissionUsedRecordToggleStatus¹⁸⁺

setPermissionUsedRecordToggleStatus(status: boolean): Promise<void>

设置是否记录当前用户的权限使用情况。系统应用调用此接口，可以设置当前用户的权限使用记录开关状态，使用Promise异步回调。

status为true时，addPermissionUsedRecord接口可以正常添加使用记录；status为false时，addPermissionUsedRecord接口不记录权限使用记录，并且删除当前用户的历史记录。

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

privacyManager.setPermissionUsedRecordToggleStatus(true).then(() => {
  console.log('setPermissionUsedRecordToggleStatus success');
}).catch((err: BusinessError) => {
  console.error(`setPermissionUsedRecordToggleStatus fail, err->${JSON.stringify(err)}`);
});

privacyManager.getPermissionUsedRecordToggleStatus¹⁸⁺

getPermissionUsedRecordToggleStatus(): Promise<boolean>

系统应用调用此接口，可以获取当前用户的权限使用记录开关状态，使用Promise异步回调。

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

系统能力： SystemCapability.Security.AccessToken

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

privacyManager.getPermissionUsedRecordToggleStatus().then((res) => {
  console.log('getPermissionUsedRecordToggleStatus success');
  if (res == true) {
    console.log('get status is TRUE');
  } else {
    console.log('get status is FALSE');
  }
}).catch((err: BusinessError) => {
  console.error(`getPermissionUsedRecordToggleStatus fail, 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 '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

privacyManager.startUsingPermission¹⁸⁺

startUsingPermission(tokenID: number, permissionName: Permissions, pid?: number, usedType?: PermissionUsedType): Promise<void>

系统应用调用此接口，能够传递应用在前后台的权限使用情况，并依据应用的生命周期做出相应的响应。使用Promise异步回调。

当应用按照某种权限授予方式使用权限时，隐私服务将通知隐私指示器该应用正在使用该权限；当应用退出时，隐私服务将通知隐私指示器该应用已停止使用该权限，并清除相应的缓存。

在传递多进程应用的权限使用情况时，可以指定应用进程的pid。若未指定pid，默认按应用响应，在应用退出时，隐私服务通知隐私指示器并清除缓存。

若指定了pid，当该进程退出时，隐私服务通知隐私指示器并清除缓存，此时pid必须为tokenID对应应用的进程pid，不能为其他应用的pid。

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { rpc } from '@kit.IPCKit'

let tokenID: number = rpc.IPCSkeleton.getCallingTokenId(); // 也可以通过bundleManager.getBundleInfoForSelfSync获取accessTokenId
let pid: number = rpc.IPCSkeleton.getCallingPid();
let usedType: privacyManager.PermissionUsedType = privacyManager.PermissionUsedType.PICKER_TYPE;

// without pid and usedType
privacyManager.startUsingPermission(tokenID, 'ohos.permission.READ_AUDIO').then(() => {
  console.log('startUsingPermission success');
}).catch((err: BusinessError) => {
  console.error(`startUsingPermission fail, err->${JSON.stringify(err)}`);
});
// with pid
privacyManager.startUsingPermission(tokenID, 'ohos.permission.READ_AUDIO', pid).then(() => {
  console.log('startUsingPermission success');
}).catch((err: BusinessError) => {
  console.error(`startUsingPermission fail, err->${JSON.stringify(err)}`);
});
// with usedType
privacyManager.startUsingPermission(tokenID, 'ohos.permission.READ_AUDIO', -1, usedType).then(() => {
  console.log('startUsingPermission success');
}).catch((err: BusinessError) => {
  console.error(`startUsingPermission fail, err->${JSON.stringify(err)}`);
});
// with pid and usedType
privacyManager.startUsingPermission(tokenID, 'ohos.permission.READ_AUDIO', pid, usedType).then(() => {
  console.log('startUsingPermission success');
}).catch((err: BusinessError) => {
  console.error(`startUsingPermission fail, 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 '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

privacyManager.stopUsingPermission

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

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

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

privacyManager.stopUsingPermission¹⁸⁺

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

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

pid需要与startUsingPermission传入的pid相同。

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { rpc } from '@kit.IPCKit'

let tokenID: number = rpc.IPCSkeleton.getCallingTokenId(); // 也可以通过bundleManager.getBundleInfoForSelfSync获取accessTokenId
let pid: number = rpc.IPCSkeleton.getCallingPid();

// without pid
privacyManager.stopUsingPermission(tokenID, 'ohos.permission.READ_AUDIO').then(() => {
  console.log('stopUsingPermission success');
}).catch((err: BusinessError) => {
  console.error(`stopUsingPermission fail, err->${JSON.stringify(err)}`);
});

// with pid
privacyManager.stopUsingPermission(tokenID, 'ohos.permission.READ_AUDIO', pid).then(() => {
  console.log('stopUsingPermission success');
}).catch((err: BusinessError) => {
  console.error(`stopUsingPermission fail, 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 '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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

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 '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

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.error(`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 '@kit.AbilityKit';

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

privacyManager.getPermissionUsedTypeInfos¹²⁺

getPermissionUsedTypeInfos(tokenId?: number, permissionName?: Permissions): Promise<Array<PermissionUsedTypeInfo>>

查询设备上指定应用访问敏感权限时的信息（包括敏感权限名称、敏感权限访问方式）。

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

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

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

示例：

import { privacyManager, Permissions } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let tokenId: number = 0; // 可以通过bundleManager.getApplicationInfo获取accessTokenId
let permissionName: Permissions = 'ohos.permission.CAMERA';
// without any param
privacyManager.getPermissionUsedTypeInfos().then(() => {
  console.log('getPermissionUsedTypeInfos success');
}).catch((err: BusinessError) => {
  console.error(`getPermissionUsedTypeInfos fail, err->${JSON.stringify(err)}`);
});
// only tokenId
privacyManager.getPermissionUsedTypeInfos(tokenId).then(() => {
  console.log('getPermissionUsedTypeInfos success');
}).catch((err: BusinessError) => {
  console.error(`getPermissionUsedTypeInfos fail, err->${JSON.stringify(err)}`);
});
// only permissionName
privacyManager.getPermissionUsedTypeInfos(null, permissionName).then(() => {
  console.log('getPermissionUsedTypeInfos success');
}).catch((err: BusinessError) => {
  console.error(`getPermissionUsedTypeInfos fail, err->${JSON.stringify(err)}`);
});
// tokenId and permissionName
privacyManager.getPermissionUsedTypeInfos(tokenId, permissionName).then(() => {
  console.log('getPermissionUsedTypeInfos success');
}).catch((err: BusinessError) => {
  console.error(`getPermissionUsedTypeInfos fail, 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

PermissionUsedType¹²⁺

表示通过何种方式使用敏感权限的枚举。

系统能力： SystemCapability.Security.AccessToken

|名称 |值|说明 | |———————–|–|—————-| |NORMAL_TYPE |0|表示通过弹窗授权或设置授权的方式来使用敏感权限。 | |PICKER_TYPE |1|表示通过某个PICKER服务来使用敏感权限，此方式未授予权限。| |SECURITY_COMPONENT_TYPE|2|表示通过安全控件授权的方式来使用敏感权限。|

PermissionUsedTypeInfo¹²⁺

表示某次权限使用类型的详情。

系统能力: SystemCapability.Security.AccessToken

AddPermissionUsedRecordOptions¹²⁺

添加权限使用记录可选参数集。

系统能力: SystemCapability.Security.AccessToken

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Ability Kit（程序框架服务）

harmony 鸿蒙AbilityBase

harmony 鸿蒙AbilityBase_Element

harmony 鸿蒙AbilityRuntime

harmony 鸿蒙bundle

harmony 鸿蒙OH_NativeBundle_ApplicationInfo

harmony 鸿蒙OH_NativeBundle_ElementName

harmony 鸿蒙ability_base_common.h

harmony 鸿蒙ability_runtime_common.h

harmony 鸿蒙application_context.h