查询需要用户认证的关键资产(ArkTS)
HarmonyOS 5.0.3(15) 版本的配套文档,该版本API能力级别为API 15 Release
文章目录
-
- 接口介绍
- 代码示例
接口介绍
可通过API文档查看此功能的相关接口:
异步接口 | 同步接口 | 说明 |
---|---|---|
preQuery(query: AssetMap) | preQuerySync(query: AssetMap) | 查询预处理。 |
query(query: AssetMap) | querySync(query: AssetMap) | 查询关键资产。 |
postQuery(handle: AssetMap) | postQuerySync(handle: AssetMap) | 查询后置处理。 |
在查询需要用户认证的关键资产时,关键资产属性的内容(AssetMap)参数如下表所示:
注意
下表中名称包含“DATA_LABEL”的关键资产属性,用于存储业务自定义信息,其内容不会被加密,请勿存放个人数据。
- preQuery参数列表
属性名称(Tag) | 属性内容(Value) | 是否必选 | 说明 |
---|---|---|---|
ALIAS | 类型为Uint8Array,长度为1-256字节。 | 可选 | 关键资产别名,每条关键资产的唯一索引。 |
ACCESSIBILITY | 类型为number,取值范围详见Accessibility。 | 可选 | 基于锁屏状态的访问控制。 |
REQUIRE_PASSWORD_SET | 类型为bool。 | 可选 | 是否仅在设置了锁屏密码的情况下,可访问关键资产。 |
AUTH_TYPE | 类型为number,取值范围详见AuthType。 | 可选 | 访问关键资产所需的用户认证类型。 |
AUTH_VALIDITY_PERIOD | 类型为number,取值范围:1-600,单位为秒。 | 可选 | 用户认证的有效期。 |
SYNC_TYPE | 类型为number,取值范围详见SyncType。 | 可选 | 关键资产支持的同步类型。 |
IS_PERSISTENT | 类型为bool。 | 可选 | 在应用卸载时是否需要保留关键资产。 |
DATA_LABEL_CRITICAL_1 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_CRITICAL_2 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_CRITICAL_3 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_CRITICAL_4 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_1 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_2 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_3 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_4 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_LOCAL_112+ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
DATA_LABEL_NORMAL_LOCAL_212+ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
DATA_LABEL_NORMAL_LOCAL_312+ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
DATA_LABEL_NORMAL_LOCAL_412+ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
REQUIRE_ATTR_ENCRYPTED14+ | 类型为bool。 | 可选 | 是否查询业务自定义附属信息被加密的数据,默认查询业务附属信息不加密的数据。 |
- query参数列表
属性名称(Tag) | 属性内容(Value) | 是否必选 | 说明 |
---|---|---|---|
ALIAS | 类型为Uint8Array,长度为1-256字节。 | 必选 | 关键资产别名,每条关键资产的唯一索引。 |
AUTH_CHALLENGE | 类型为Uint8Array,长度为32字节。 | 必选 | 用户认证的挑战值。 |
AUTH_TOKEN | 类型为Uint8Array,长度为148字节。 | 必选 | 用户认证通过的授权令牌。 |
RETURN_TYPE | 类型为number,asset.ReturnType.ALL。 | 必选 | 关键资产查询返回的结果类型。 |
ACCESSIBILITY | 类型为number,取值范围详见Accessibility。 | 可选 | 基于锁屏状态的访问控制。 |
REQUIRE_PASSWORD_SET | 类型为bool。 | 可选 | 是否仅在设置了锁屏密码的情况下,可访问关键资产。 |
AUTH_TYPE | 类型为number,取值范围详见AuthType。 | 可选 | 访问关键资产所需的用户认证类型。 |
SYNC_TYPE | 类型为number,取值范围详见SyncType。 | 可选 | 关键资产支持的同步类型。 |
IS_PERSISTENT | 类型为bool。 | 可选 | 在应用卸载时是否需要保留关键资产。 |
DATA_LABEL_CRITICAL_1 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_CRITICAL_2 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_CRITICAL_3 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_CRITICAL_4 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_1 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_2 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_3 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_4 | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护。说明: API12前长度为1-512字节。 |
DATA_LABEL_NORMAL_LOCAL_1^12+ ^ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
DATA_LABEL_NORMAL_LOCAL_212+ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
DATA_LABEL_NORMAL_LOCAL_312+ | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
DATA_LABEL_NORMAL_LOCA |