• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.security.certManagerDialog (证书管理对话框模块)
2
3证书管理对话框主要提供拉起证书管理界面的能力，用户在拉起的证书管理对话框可对证书进行管理（安装，存储，使用，销毁）。
4
5> **说明：**
6>
7> 本模块首批接口从API version 13开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import certificateManagerDialog from '@ohos.security.certManagerDialog';
13```
14
15## CertificateDialogPageType
16
17表示证书管理对话框的页面类型。
18
19**系统能力：** SystemCapability.Security.CertificateManagerDialog
20
21**模型约束：** 此接口仅可在Stage模型下使用。
22
23| 名称       | 值 |  说明      |
24| ---------- | ------ | --------- |
25| PAGE_MAIN | 1      | 证书管理应用主页面 |
26| PAGE_CA_CERTIFICATE | 2      | CA证书列表页面 |
27| PAGE_CREDENTIAL | 3      | 凭据列表页面 |
28| PAGE_INSTALL_CERTIFICATE | 4      | 安装证书页面 |
29
30## CertificateDialogErrorCode
31
32表示调用证书管理对话框相关API的错误码。
33
34**系统能力：** SystemCapability.Security.CertificateManagerDialog
35
36**模型约束：** 此接口仅可在Stage模型下使用。
37
38| 名称       | 值 |  说明      |
39| ---------- | ------ | --------- |
40| ERROR_GENERIC  | 29700001      | 表示调用接口时发生内部错误。 |
41
42## certificateManagerDialog.openCertificateManagerDialog
43
44openCertificateManagerDialog(context: common.Context, pageType: CertificateDialogPageType): Promise\<void>
45
46表示拉起证书管理对话框，显示相应的页面，使用Promise方式异步返回结果。
47
48**需要权限：** ohos.permission.ACCESS_CERT_MANAGER
49
50**系统能力：** SystemCapability.Security.CertificateManagerDialog
51
52**模型约束：** 此接口仅可在Stage模型下使用。
53
54**参数**：
55
56| 参数名   | 类型                                              | 必填 | 说明                       |
57| -------- | ------------------------------------------------- | ---- | -------------------------- |
58| context | [common.Context](../apis-ability-kit/js-apis-app-ability-common.md)                   | 是   | 表示应用的上下文信息。 |
59| pageType | [CertificateDialogPageType](#certificatedialogpagetype)                   | 是   | 表示页面类型。 |
60
61**返回值**：
62
63| 类型                                        | 说明                 |
64| ------------------------------------------- | -------------------- |
65| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
66
67**错误码：**
68
69以下错误码的详细介绍请参见[证书管理对话框错误码](errorcode-certManagerDialog.md)。
70
71| 错误码ID | 错误信息                                                     |
72| -------- | ------------------------------------------------------------ |
73| 201      | Permission verification failed. The application does not have the permission required to call the API.     |
74| 401      | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
75| 29700001 | Internal error.     |
76
77**示例**：
78```ts
79import certificateManagerDialog from '@ohos.security.certManagerDialog';
80import { BusinessError } from '@kit.BasicServicesKit';
81import { common } from '@kit.AbilityKit';
82
83/* context为应用的上下文信息，调用方自行获取，此处仅为示例 */
84let context: common.Context = getContext(this);
85/* pageType为页面类型，此处赋值PAGE_MAIN，即拉起证书管理主界面 */
86let pageType: certificateManagerDialog.CertificateDialogPageType = certificateManagerDialog.CertificateDialogPageType.PAGE_MAIN;
87try {
88  certificateManagerDialog.openCertificateManagerDialog(context, pageType).then(() => {
89    console.info('Succeeded in opening certificate manager dialog.');
90  }).catch((err: BusinessError) => {
91    console.error(`Failed to open certificate manager dialog. Code: ${err.code}, message: ${err.message}`);
92  })
93} catch (error) {
94  console.error(`Failed to open certificate manager dialog. Code: ${error.code}, message: ${error.message}`);
95}
96```
97