Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 1d58a813 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!8545 docs仓账号子系统接口说明整改 

Merge pull request !8545 from lichenchen/master
上级 47eeeee3 39ab4ba6
隐藏空白更改
内联 并排
Showing with 166 addition and 51 deletion
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ 1d58a813
...@@ -797,6 +797,35 @@ getAssociatedData(name: string, key: string): Promise<string> ...@@ -797,6 +797,35 @@ getAssociatedData(name: string, key: string): Promise<string>
}); });
``` ```
### getAssociatedDataSync
getAssociatedDataSync(name: string, key: string): string;
获取与此应用程序帐号关联的数据，使用同步方式返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| string | 用于获取同步接口的返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
var backData = appAccountManager.getAssociatedDataSync("ZhangSan", "k001");
console.info("getAssociatedDataSync backData:" + JSON.stringify(backData));
```
### getAllAccessibleAccounts ### getAllAccessibleAccounts
getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void
......
zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
浏览文件 @ 1d58a813
...@@ -19,6 +19,8 @@ getDistributedAccountAbility(): DistributedAccountAbility ...@@ -19,6 +19,8 @@ getDistributedAccountAbility(): DistributedAccountAbility
获取分布式帐号单实例对象。 获取分布式帐号单实例对象。
**系统能力：** SystemCapability.Account.OsAccount
- 返回值： - 返回值：
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
......
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @ 1d58a813
...@@ -1920,12 +1920,16 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string): Promis ...@@ -1920,12 +1920,16 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string): Promis
用户认证类。 用户认证类。
此接口为系统接口，三方应用不支持调用。
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor() constructor()
创建用户认证的实例。 创建用户认证的实例。
此接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Account.OsAccount **系统能力**：SystemCapability.Account.OsAccount
**示例：** **示例：**
...@@ -1975,14 +1979,14 @@ getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number; ...@@ -1975,14 +1979,14 @@ getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | -----------------------------------------------| ---- | ------------------------- | | --------------- | -----------------------------------------------| ---- | ------------------------- |
| authType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 指示用于认证的凭据类型。 | | authType | [AuthType](#authtype8) | 是 | 指示用于认证的凭据类型。 |
| authTrustLevel | [AuthTrustLevel](#AuthTrustLevel<sup>8+</sup>) | 是 | 表示身份验证结果的信任级别。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 表示身份验证结果的信任级别。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :----- | :---------------------------------------- | | :----- | :---------------------------------------- |
| number | 返回验证[结果](#ResultCode<sup>8+</sup>)。 | | number | 返回验证[结果](#resultcode8)。 |
**示例：** **示例：**
```js ```js
...@@ -2010,8 +2014,8 @@ getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProp ...@@ -2010,8 +2014,8 @@ getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProp
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- | | -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- |
| request | [GetPropertyRequest](#GetPropertyRequest<sup>8+</sup>) | 是 | 请求信息，包括认证类型和属性类型列表。 | | request | [GetPropertyRequest](#getpropertyrequest8) | 是 | 请求信息，包括认证类型和属性类型列表。 |
| callback | AsyncCallback&lt;[ExecutorProperty](#ExecutorProperty<sup>8+</sup>)&gt; | 是 | 回调结果，返回的是调用者属性。 | | callback | AsyncCallback&lt;[ExecutorProperty](#executorproperty8)&gt; | 是 | 回调结果，返回的是调用者属性。 |
**示例：** **示例：**
```js ```js
...@@ -2029,7 +2033,7 @@ getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProp ...@@ -2029,7 +2033,7 @@ getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProp
### getProperty<sup>8+</sup> ### getProperty<sup>8+</sup>
getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>; getProperty(request: GetPropertyRequest): Promise&lt;ExecutorProperty&gt;;
基于指定的请求信息获取属性，使用Promise方式异步返回结果。 基于指定的请求信息获取属性，使用Promise方式异步返回结果。
...@@ -2043,13 +2047,13 @@ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>; ...@@ -2043,13 +2047,13 @@ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------- | | -------- | ------------------------------------------------------ | ---- | ---------------------------------- |
| request | [GetPropertyRequest](#GetPropertyRequest<sup>8+</sup>) | 是 | 请求信息，包括认证类型和属性类型列表。 | | request | [GetPropertyRequest](#getpropertyrequest8) | 是 | 请求信息，包括认证类型和属性类型列表。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :---------------------------------------------------------------- | :-------------------------------------------------- | | :---------------------------------------------------------------- | :-------------------------------------------------- |
| Promise&lt;[ExecutorProperty](#ExecutorProperty<sup>8+</sup>)&gt; | Promise实例，用于获取异步返回结果，返回的是调用者属性。 | | Promise&lt;[ExecutorProperty](#executorproperty8)&gt; | Promise实例，用于获取异步返回结果，返回的是调用者属性。 |
**示例：** **示例：**
```js ```js
...@@ -2067,7 +2071,7 @@ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>; ...@@ -2067,7 +2071,7 @@ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>;
### setProperty<sup>8+</sup> ### setProperty<sup>8+</sup>
setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void; setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;number&gt;): void;
设置可用于初始化算法的属性，使用callback回调异步返回结果。 设置可用于初始化算法的属性，使用callback回调异步返回结果。
...@@ -2081,8 +2085,8 @@ setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void; ...@@ -2081,8 +2085,8 @@ setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- | | -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- |
| request | [SetPropertyRequest](#SetPropertyRequest<sup>8+</sup>)| 是 | 请求信息，包括认证类型和要设置的密钥值。 | | request | [SetPropertyRequest](#setpropertyrequest8)| 是 | 请求信息，包括认证类型和要设置的密钥值。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回一个[数值](#ResultCode<sup>8+</sup>)，指示属性设置是否成功。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回一个[数值](#resultcode8)，指示属性设置是否成功。 |
**示例：** **示例：**
```js ```js
...@@ -2098,7 +2102,7 @@ setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void; ...@@ -2098,7 +2102,7 @@ setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void;
### setProperty<sup>8+</sup> ### setProperty<sup>8+</sup>
setProperty(request: SetPropertyRequest): Promise<number>; setProperty(request: SetPropertyRequest): Promise&lt;number&gt;;
设置可用于初始化算法的属性，使用Promise方式异步返回结果。 设置可用于初始化算法的属性，使用Promise方式异步返回结果。
...@@ -2112,13 +2116,13 @@ setProperty(request: SetPropertyRequest): Promise<number>; ...@@ -2112,13 +2116,13 @@ setProperty(request: SetPropertyRequest): Promise<number>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------------- | | -------- | ------------------------------------------------------ | ---- | ---------------------------------------- |
| request | [SetPropertyRequest](#SetPropertyRequest<sup>8+</sup>) | 是 | 请求信息，包括身份验证类型和要设置的密钥值。 | | request | [SetPropertyRequest](#setpropertyrequest8) | 是 | 请求信息，包括身份验证类型和要设置的密钥值。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :-------------------------------------------------------------------------------------------- | | :-------------------- | :-------------------------------------------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回一个[数值](#ResultCode<sup>8+</sup>)，指示属性设置是否成功。 | | Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回一个[数值](#resultcode8)，指示属性设置是否成功。 |
**示例：** **示例：**
```js ```js
...@@ -2149,9 +2153,9 @@ auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, ...@@ -2149,9 +2153,9 @@ auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel,
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ | | --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| challenge | Uint8Array | 是 | 指示挑战值，挑战值为一个随机数，用于提升安全性。| | challenge | Uint8Array | 是 | 指示挑战值，挑战值为一个随机数，用于提升安全性。|
| authType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 指示认证类型。 | | authType | [AuthType](#authtype8) | 是 | 指示认证类型。 |
| authTrustLevel | [AuthTrustLevel](#AuthTrustLevel<sup>8+</sup>) | 是 | 指示认证结果的信任级别。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 指示认证结果的信任级别。 |
| callback | [IUserAuthCallback](#IUserAuthCallback<sup>8+</sup>) | 是 | 回调结果，返回的是结果和所获取的信息。 | | callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调结果，返回的是结果和所获取的信息。 |
**返回值：** **返回值：**
...@@ -2199,9 +2203,9 @@ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLev ...@@ -2199,9 +2203,9 @@ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLev
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ | | --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| userId | number | 是 | 指示用户身份。 | | userId | number | 是 | 指示用户身份。 |
| challenge | Uint8Array | 是 | 指示挑战值，挑战值为一个随机数，用于提升安全性。 | | challenge | Uint8Array | 是 | 指示挑战值，挑战值为一个随机数，用于提升安全性。 |
| authType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 指示认证类型。 | | authType | [AuthType](#authtype8) | 是 | 指示认证类型。 |
| authTrustLevel | [AuthTrustLevel](#AuthTrustLevel<sup>8+</sup>) | 是 | 指示认证结果的信任级别。 | | authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 指示认证结果的信任级别。 |
| callback | [IUserAuthCallback](#IUserAuthCallback<sup>8+</sup>) | 是 | 回调结果，返回的是结果和所获取的信息。 | | callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调结果，返回的是结果和所获取的信息。 |
**返回值：** **返回值：**
...@@ -2254,7 +2258,7 @@ cancelAuth(contextID: Uint8Array): number; ...@@ -2254,7 +2258,7 @@ cancelAuth(contextID: Uint8Array): number;
| 类型 | 说明 | | 类型 | 说明 |
| :----- | :-------------------------------------------------------- | | :----- | :-------------------------------------------------------- |
| number | 返回一个[数字](#ResultCode<sup>8+</sup>)，指示取消是否成功。 | | number | 返回一个[数字](#resultcode8)，指示取消是否成功。 |
**示例：** **示例：**
```js ```js
...@@ -2269,6 +2273,8 @@ cancelAuth(contextID: Uint8Array): number; ...@@ -2269,6 +2273,8 @@ cancelAuth(contextID: Uint8Array): number;
Pin码认证功能基类。 Pin码认证功能基类。
此接口为系统接口，三方应用不支持调用。
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor() constructor()
...@@ -2299,7 +2305,7 @@ registerInputer(inputer: IInputer): boolean; ...@@ -2299,7 +2305,7 @@ registerInputer(inputer: IInputer): boolean;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------| ----------------------------------- | --- | ------------------ | | ----------| ----------------------------------- | --- | ------------------ |
| inputer | [IInputer](#IInputer<sup>8+</sup>) | 是 | 指示密码输入框回调。 | | inputer | [IInputer](#iinputer8) | 是 | 指示密码输入框回调。 |
**返回值：** **返回值：**
...@@ -2347,12 +2353,16 @@ unregisterInputer(): void; ...@@ -2347,12 +2353,16 @@ unregisterInputer(): void;
获取用户身份管理类。 获取用户身份管理类。
此接口为系统接口，三方应用不支持调用。
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor() constructor()
创建用户认证的实例。 创建用户认证的实例。
此接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Account.OsAccount **系统能力**：SystemCapability.Account.OsAccount
**示例：** **示例：**
...@@ -2452,8 +2462,8 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; ...@@ -2452,8 +2462,8 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------ | --- | -------------------------------- | | --------------- | ------------------------------------------------ | --- | -------------------------------- |
| credentialInfo | [CredentialInfo](#CredentialInfo<sup>8+</sup>) | 是 | 指示凭据信息。 | | credentialInfo | [CredentialInfo](#credentialinfo8) | 是 | 指示凭据信息。 |
| callback | [IIdmCallback](#IIdmCallback<sup>8+</sup>) | 是 | 回调结果，返回的是结果和获取信息。 | | callback | [IIdmCallback](#iidmcallback8) | 是 | 回调结果，返回的是结果和获取信息。 |
**示例：** **示例：**
```js ```js
...@@ -2495,8 +2505,8 @@ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; ...@@ -2495,8 +2505,8 @@ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------- | --- | -------------------------------- | | --------------- | ------------------------------------------------- | --- | -------------------------------- |
| credentialInfo | [CredentialInfo](#CredentialInfo<sup>8+</sup>) | 是 | 指示凭据信息。 | | credentialInfo | [CredentialInfo](#credentialinfo8) | 是 | 指示凭据信息。 |
| callback | [IIdmCallback](#IIdmCallback<sup>8+</sup>) | 是 | 回调结果，返回的是结果和获取信息。 | | callback | [IIdmCallback](#iidmcallback8) | 是 | 回调结果，返回的是结果和获取信息。 |
**示例：** **示例：**
```js ```js
...@@ -2561,7 +2571,7 @@ cancel(challenge: Uint8Array): number; ...@@ -2561,7 +2571,7 @@ cancel(challenge: Uint8Array): number;
| 类型 | 说明 | | 类型 | 说明 |
| :----- | :-------------------------------------------------------- | | :----- | :-------------------------------------------------------- |
| number | 返回一个[数字](#ResultCode<sup>8+</sup>)，指示取消是否成功。 | | number | 返回一个[数字](#resultcode8)，指示取消是否成功。 |
**示例：** **示例：**
```js ```js
...@@ -2587,7 +2597,7 @@ delUser(token: Uint8Array, callback: IIdmCallback): void; ...@@ -2587,7 +2597,7 @@ delUser(token: Uint8Array, callback: IIdmCallback): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------ | --- | ------------------------- | | -------- | ------------------------------------------ | --- | ------------------------- |
| token | Uint8Array | 是 | 身份验证令牌。 | | token | Uint8Array | 是 | 身份验证令牌。 |
| callback | [IIdmCallback](#IIdmCallback<sup>8+</sup>) | 是 | 回调结果，返回的是删除结果。| | callback | [IIdmCallback](#iidmcallback8) | 是 | 回调结果，返回的是删除结果。|
**示例：** **示例：**
```js ```js
...@@ -2629,7 +2639,7 @@ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): vo ...@@ -2629,7 +2639,7 @@ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): vo
| --------------- | ----------------------------------------------- | --- | ---------------------------| | --------------- | ----------------------------------------------- | --- | ---------------------------|
| credentialId | Uint8Array | 是 | 凭证索引。 | | credentialId | Uint8Array | 是 | 凭证索引。 |
| token | Uint8Array | 是 | 身份验证令牌。 | | token | Uint8Array | 是 | 身份验证令牌。 |
| callback | [IIdmCallback](#IIdmCallback<sup>8+</sup>) | 是 | 回调结果，返回的是删除结果。 | | callback | [IIdmCallback](#iidmcallback8) | 是 | 回调结果，返回的是删除结果。 |
**示例：** **示例：**
```js ```js
...@@ -2657,7 +2667,7 @@ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): vo ...@@ -2657,7 +2667,7 @@ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): vo
### getAuthInfo<sup>8+</sup> ### getAuthInfo<sup>8+</sup>
getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;, authType?: AuthType): void; getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;
获取认证信息，使用callback回调异步返回结果。 获取认证信息，使用callback回调异步返回结果。
...@@ -2665,14 +2675,42 @@ getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;, authTy ...@@ -2665,14 +2675,42 @@ getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;, authTy
**系统能力：** SystemCapability.Account.OsAccount **系统能力：** SystemCapability.Account.OsAccount
**需要权限：** ohos.permission.MANAGE_USER_IDM **需要权限：** ohos.permission.ACCESS_USER_IDM
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- | | -------- | -------------------------------------------------- | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#EnrolledCredInfo<sup>8+</sup>)&gt;&gt; | 是 | 回调结果，返回的是当前用户指定类型的所有已注册凭据信息。| | callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是 | 回调结果，返回的是当前用户指定类型的所有已注册凭据信息。|
| authType | [AuthType](#AuthType<sup>8+</sup>) | 否 | 认证类型。 |
**示例：**
```js
var userIDM = new osAccount.UserIdentityManager();
var authType = osAccount.AuthType.PIN;
userIDM.getAuthInfo(function (authInfo) {
console.log("====>test for examples getAuthInfo AsyncCallback = " + JSON.stringify(authInfo))
})
```
### getAuthInfo<sup>8+</sup>
getAuthInfo(authType: AuthType, callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;
获取指定类型的认证信息，使用callback回调异步返回结果。
此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
**需要权限：** ohos.permission.ACCESS_USER_IDM
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- |
| authType | [AuthType](#authtype8) | 是 | 认证类型。 |
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是 | 回调结果，返回的是当前用户指定类型的所有已注册凭据信息。|
**示例：** **示例：**
```js ```js
...@@ -2693,19 +2731,19 @@ getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;; ...@@ -2693,19 +2731,19 @@ getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;;
**系统能力：** SystemCapability.Account.OsAccount **系统能力：** SystemCapability.Account.OsAccount
**需要权限：** ohos.permission.MANAGE_USER_IDM **需要权限：** ohos.permission.ACCESS_USER_IDM
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | -------- | | -------- | ----------------------------------- | ---- | -------- |
| authType | [AuthType](#AuthType<sup>8+</sup>) | 否 | 认证类型。| | authType | [AuthType](#authtype8) | 否 | 认证类型。|
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------------------------------- | :------------------------------------------------------------------------ | | :------------------------------------------- | :------------------------------------------------------------------------ |
| Promise&lt;Array&lt;[EnrolledCredInfo](#EnrolledCredInfo<sup>8+</sup>)&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是当前用户指定类型的所有已注册凭据信息。| | Promise&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是当前用户指定类型的所有已注册凭据信息。|
**示例：** **示例：**
```js ```js
...@@ -2720,10 +2758,14 @@ getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;; ...@@ -2720,10 +2758,14 @@ getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;;
密码数据回调。 密码数据回调。
此接口为系统接口，三方应用不支持调用。
### onSetData<sup>8+</sup> ### onSetData<sup>8+</sup>
onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void; onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
此接口为系统接口，三方应用不支持调用。
通知设置数据。 通知设置数据。
**系统能力：** SystemCapability.Account.OsAccount **系统能力：** SystemCapability.Account.OsAccount
...@@ -2732,7 +2774,7 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void; ...@@ -2732,7 +2774,7 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ----------------------------------------------- | | ---------- | ---------------------------------------- | ---- | ----------------------------------------------- |
| pinSubType | [AuthSubType](#AuthSubType<sup>8+</sup>) | 是 | 用于认证的凭据子类型。 | | pinSubType | [AuthSubType](#authsubtype8) | 是 | 用于认证的凭据子类型。 |
| data | Uint8Array | 是 | 要设置的数据是凭据，用来在认证、添加、修改凭据操作。 | | data | Uint8Array | 是 | 要设置的数据是凭据，用来在认证、添加、修改凭据操作。 |
**示例：** **示例：**
...@@ -2763,19 +2805,23 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void; ...@@ -2763,19 +2805,23 @@ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;
密码输入框回调。 密码输入框回调。
此接口为系统接口，三方应用不支持调用。
### onGetData<sup>8+</sup> ### onGetData<sup>8+</sup>
onGetData: (callback: IInputData) => void; onGetData: (pinSubType: AuthSubType, callback: IInputData) => void;
通知获取数据。 通知获取数据。
此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount **系统能力：** SystemCapability.Account.OsAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | --------------- | | ---------- | --------------------------------------- | ---- | --------------- |
| callback | [IInputData](#IInputData<sup>8+</sup>) | 是 | 指示密码数据回调。| | callback | [IInputData](#iinputdata8) | 是 | 指示密码数据回调。|
**示例：** **示例：**
```js ```js
...@@ -2805,12 +2851,16 @@ onGetData: (callback: IInputData) => void; ...@@ -2805,12 +2851,16 @@ onGetData: (callback: IInputData) => void;
用户认证回调。 用户认证回调。
此接口为系统接口，三方应用不支持调用。
### onResult<sup>8+</sup> ### onResult<sup>8+</sup>
onResult: (result: number, extraInfo: AuthResult) => void; onResult: (result: number, extraInfo: AuthResult) => void;
身份认证结果代码通过回调返回。 身份认证结果代码通过回调返回。
此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount **系统能力：** SystemCapability.Account.OsAccount
**参数：** **参数：**
...@@ -2818,7 +2868,7 @@ onResult: (result: number, extraInfo: AuthResult) => void; ...@@ -2818,7 +2868,7 @@ onResult: (result: number, extraInfo: AuthResult) => void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | ------------------- | | --------- | --------------------------------------- | ---- | ------------------- |
| result | number | 是 | 表示身份认证结果代码。| | result | number | 是 | 表示身份认证结果代码。|
| extraInfo | [AuthResult](#AuthResult<sup>8+</sup>) | 是 | 表示不同情况下的具体信息，如果认证通过，则在extrainfo中返回认证令牌，如果身份验证失败，则在extrainfo中返回剩余的身份验证时间，如果身份验证执行器被锁定，冻结时间将在extrainfo中返回。| | extraInfo | [AuthResult](#authresult8) | 是 | 表示不同情况下的具体信息，如果认证通过，则在extrainfo中返回认证令牌，如果身份验证失败，则在extrainfo中返回剩余的身份验证时间，如果身份验证执行器被锁定，冻结时间将在extrainfo中返回。|
**示例：** **示例：**
```js ```js
...@@ -2897,9 +2947,11 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -2897,9 +2947,11 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
身份管理回调。 身份管理回调。
此接口为系统接口，三方应用不支持调用。
### onResult<sup>8+</sup> ### onResult<sup>8+</sup>
onResult: (result: number, extraInfo: AuthResult) => void; onResult: (result: number, extraInfo: RequestResult) => void;
身份认证结果代码通过回调返回。 身份认证结果代码通过回调返回。
...@@ -2912,7 +2964,7 @@ onResult: (result: number, extraInfo: AuthResult) => void; ...@@ -2912,7 +2964,7 @@ onResult: (result: number, extraInfo: AuthResult) => void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | ----------------------- | | --------- | --------------------------------------- | ---- | ----------------------- |
| result | number | 是 | 表示身份认证结果代码。 | | result | number | 是 | 表示身份认证结果代码。 |
| extraInfo | [AuthResult](#AuthResult<sup>8+</sup>) | 是 | 针对不同情况传递具体信息。| | extraInfo | [AuthResult](#authresult8) | 是 | 针对不同情况传递具体信息。|
**示例：** **示例：**
```js ```js
...@@ -2995,35 +3047,41 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -2995,35 +3047,41 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
提供获取属性请求的信息。 提供获取属性请求的信息。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------- | ----- | ----------------------- | | -------- | ------------------------------------------------------------- | ----- | ----------------------- |
| authType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 身份验证凭据类型。 | | authType | [AuthType](#authtype8) | 是 | 身份验证凭据类型。 |
| keys | Array&lt;[GetPropertyType](#GetPropertyType<sup>8+</sup>)&gt; | 是 | 指示要获取的属性类型数组。 | | keys | Array&lt;[GetPropertyType](#getpropertytype8)&gt; | 是 | 指示要获取的属性类型数组。 |
## SetPropertyRequest<sup>8+</sup> ## SetPropertyRequest<sup>8+</sup>
提供设置属性请求的信息。 提供设置属性请求的信息。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ----- | -------------------- | | -------- | ------------------------------------------------ | ----- | -------------------- |
| authType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 身份验证凭据类型。 | | authType | [AuthType](#authtype8) | 是 | 身份验证凭据类型。 |
| keys | [SetPropertyType](#SetPropertyType<sup>8+</sup>) | 是 | 指示要设置的属性类型。 | | key | [SetPropertyType](#setpropertytype8) | 是 | 指示要设置的属性类型。 |
| setInfo | Uint8Array | 是 | 指示要设置的信息。 | | setInfo | Uint8Array | 是 | 指示要设置的信息。 |
## ExecutorProperty<sup>8+</sup> ## ExecutorProperty<sup>8+</sup>
提供执行器的属性。 提供执行器的属性。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------------------------------- | ----- | ----------------- | | ------------ | ---------------------------------------- | ----- | ----------------- |
| result | number | 是 | 指示结果。 | | result | number | 是 | 指示结果。 |
| authSubType | [AuthSubType](#AuthSubType<sup>8+</sup>) | 是 | 指示认证凭据子类型。| | authSubType | [AuthSubType](#authsubtype8) | 是 | 指示认证凭据子类型。|
| remainTimes | number | 否 | 指示剩余时间。 | | remainTimes | number | 否 | 指示剩余时间。 |
| freezingTime | number | 否 | 指示冻结时间。 | | freezingTime | number | 否 | 指示冻结时间。 |
...@@ -3031,6 +3089,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3031,6 +3089,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
指示认证结果的信息。 指示认证结果的信息。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -3043,18 +3103,22 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3043,18 +3103,22 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
指示凭证信息。 指示凭证信息。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------------------------------- | ----- | ----------------- | | ------------ | ---------------------------------------- | ----- | ----------------- |
| credType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 指示凭据类型。 | | credType | [AuthType](#authtype8) | 是 | 指示凭据类型。 |
| credSubType | [AuthSubType](#AuthSubType<sup>8+</sup>) | 是 | 指示凭据子类型。 | | credSubType | [AuthSubType](#authsubtype8) | 是 | 指示凭据子类型。 |
| token | Uint8Array | 是 | 指示认证令牌。 | | token | Uint8Array | 是 | 指示认证令牌。 |
## RequestResult<sup>8+</sup> ## RequestResult<sup>8+</sup>
指示请求结果的信息。 指示请求结果的信息。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -3065,19 +3129,23 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3065,19 +3129,23 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
指示已注册凭据的信息。 指示已注册凭据的信息。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ---------------------------------------- | ----- | ------------------- | | ------------ | ---------------------------------------- | ----- | ------------------- |
| credentialId | Uint8Array | 是 | 指示凭据索引。 | | credentialId | Uint8Array | 是 | 指示凭据索引。 |
| authType | [AuthType](#AuthType<sup>8+</sup>) | 是 | 指示认证凭据类型。 | | authType | [AuthType](#authtype8) | 是 | 指示认证凭据类型。 |
| authSubType | [AuthSubType](#AuthSubType<sup>8+</sup>) | 是 | 指示认证凭据子类型。 | | authSubType | [AuthSubType](#authsubtype8) | 是 | 指示认证凭据子类型。 |
| templateId | Uint8Array | 是 | 指示凭据模板ID。 | | templateId | Uint8Array | 是 | 指示凭据模板ID。 |
## GetPropertyType<sup>8+</sup> ## GetPropertyType<sup>8+</sup>
枚举，指示要获取的属性类型。 枚举，指示要获取的属性类型。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3090,6 +3158,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3090,6 +3158,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示要设置的属性类型。 枚举，指示要设置的属性类型。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3100,6 +3170,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3100,6 +3170,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示身份验证的凭据类型。 枚举，指示身份验证的凭据类型。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3111,6 +3183,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3111,6 +3183,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示用于认证的凭据子类型。 枚举，指示用于认证的凭据子类型。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3125,6 +3199,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3125,6 +3199,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示认证结果的受信任级别。 枚举，指示认证结果的受信任级别。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3138,6 +3214,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3138,6 +3214,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，表示获取信息的模块。 枚举，表示获取信息的模块。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3148,6 +3226,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3148,6 +3226,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示身份验证结果代码。 枚举，指示身份验证结果代码。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3168,6 +3248,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3168,6 +3248,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示人脸验证过程中提示代码。 枚举，指示人脸验证过程中提示代码。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
...@@ -3188,6 +3270,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void; ...@@ -3188,6 +3270,8 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
枚举，指示指纹身份验证过程中提示代码。 枚举，指示指纹身份验证过程中提示代码。
此接口为系统接口，三方应用不支持调用。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount
| 参数 | 默认值 | 说明 | | 参数 | 默认值 | 说明 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或