HarmonyOS 5.0.3(15) 版本的配套文档,该版本API能力级别为API 15 Release

文章目录

在这里插入图片描述
在这里插入图片描述


接口介绍

可通过API文档查看更新关键资产的异步接口update(query: AssetMap, attributesToUpdate: AssetMap)、同步接口updateSync(query: AssetMap, attributesToUpdate: AssetMap)的详细介绍。

在更新关键资产时,关键资产属性的内容(AssetMap)参数如下表所示:

注意
下表中名称包含“DATA_LABEL”的关键资产属性,用于存储业务自定义信息,其内容不会被加密,请勿存放个人数据。

  • query的参数列表:
属性名称(Tag) 属性内容(Value) 是否必选 说明
ALIAS 类型为Uint8Array,长度为1-256字节。 必选 关键资产别名,每条关键资产的唯一索引。
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_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字节。 可选 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。
  • attributesToUpdate的参数列表:
属性名称(Tag) 属性内容(Value) 是否必选 说明
SECRET 类型为Uint8Array,长度为1-1024字节。 可选 关键资产明文。
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。 可选 是否更新业务自定义附属信息被加密的数据,默认更新业务附属信息不加密的数据。

代码示例

说明
本模块提供了异步和同步两套接口,以下为异步接口的使用示例,同步接口详见API文档。

更新别名是demo_alias的关键资产,将关键资产明文更新为demo_pwd_new,附属属性更新成demo_label_new。

import { asset } from '@kit.AssetStoreKit';
import { util } from '@kit.ArkTS';
import { BusinessError } from '@kit.BasicServicesKit';

function stringToArray(str: string): Uint8Array {
  let textEncoder = new util.TextEncoder();
  return textEncoder.encodeInto(str);
}

let query: asset.AssetMap = new Map();
query.set(asset.Tag.ALIAS, stringToArray('demo_alias'));
let attrsToUpdate: asset.AssetMap = new Map();
attrsToUpdate.set(asset.Tag.SECRET, stringToArray('demo_pwd_new'));
attrsToUpdate.set(asset.Tag.DATA_LABEL_NORMAL_1, stringToArray('demo_label_new'));
try {
  asset.update(query, attrsToUpdate).then(() => {
    console.info(`Asset updated successfully.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to update Asset. Code is ${err.code}, message is ${err.message}`);
  });
} catch (error) {
  let err = error as BusinessError;
  console.error(`Failed to update Asset. Code is ${err.code}, message is ${err.message}`);
}

在这里插入图片描述

Logo

讨论HarmonyOS开发技术,专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐