• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 更新关键资产(ArkTS)
2
3<!--Kit: Asset Store Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @JeremyXu-->
6<!--Designer: @skye_you-->
7<!--Tester: @nacyli-->
8<!--Adviser: @zengyawen-->
9
10## 接口介绍
11
12可通过API文档查看更新关键资产的异步接口[update(query: AssetMap, attributesToUpdate: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetupdate)、同步接口[updateSync(query: AssetMap, attributesToUpdate: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetupdatesync12)的详细介绍。
13
14在更新关键资产时,关键资产属性的内容(AssetMap)参数如下表所示:
15
16>**注意:**
17>
18>下表中“ALIAS”和名称包含“DATA_LABEL”的关键资产属性,用于存储业务自定义信息,其内容不会被加密,请勿存放敏感个人数据。
19
20- **query的参数列表:**
21
22  | 属性名称(Tag)        | 属性内容(Value)                                             | 是否必选  | 说明                                             |
23  | --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------ |
24  | ALIAS                 | 类型为Uint8Array,长度为1-256字节。                            | 必选     | 关键资产别名,每条关键资产的唯一索引。           |
25  | ACCESSIBILITY         | 类型为number,取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility)。 | 可选     | 基于锁屏状态的访问控制。                                     |
26  | REQUIRE_PASSWORD_SET  | 类型为boolean。                                                   | 可选     | 是否仅在设置了锁屏密码的情况下,可访问关键资产。为true时表示更新仅用户设置了锁屏密码才允许访问的关键资产;为false时表示更新无论用户是否设置锁屏密码,均可访问的关键资产。     |
27  | AUTH_TYPE             | 类型为number,取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype)。 | 可选     | 访问关键资产所需的用户认证类型。                   |
28  | SYNC_TYPE             | 类型为number,取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype)。 | 可选     | 关键资产支持的同步类型。                           |
29  | IS_PERSISTENT         | 类型为boolean。                                                   | 可选     | 在应用卸载时是否需要保留关键资产。为true时表示更新应用卸载后会被保留的关键资产;为false时表示更新应用卸载后会被删除的关键资产。               |
30  | DATA_LABEL_CRITICAL_1 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
31  | DATA_LABEL_CRITICAL_2 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
32  | DATA_LABEL_CRITICAL_3 | 类型为Uint8Array,长度为1-2048字节。                       | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
33  | DATA_LABEL_CRITICAL_4 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
34  | DATA_LABEL_NORMAL_1   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
35  | DATA_LABEL_NORMAL_2   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
36  | DATA_LABEL_NORMAL_3   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
37  | DATA_LABEL_NORMAL_4   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
38  | DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
39  | DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
40  | DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
41  | DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
42  | REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为boolean。 | 可选 | 是否更新业务自定义附属信息被加密的数据。为true时表示更新业务自定义附属信息加密存储的数据,为false时表示更新业务自定义附属信息不加密存储的数据。默认值为false。|
43  | GROUP_ID<sup>18+</sup> | 类型为Uint8Array,长度为7-127字节。 | 可选 | 待更新的关键资产所属群组,默认更新不属于任何群组的关键资产。|
44
45- **attributesToUpdate的参数列表:**
46
47  | 属性名称(Tag)        | 属性内容(Value)                      | 是否必选  | 说明                                                         |
48  | --------------------- | -------------------------------| -------- | ------------------------------- |
49  | SECRET                | 类型为Uint8Array,长度为1-1024字节。                           | 可选     | 关键资产明文。                                                 |
50  | DATA_LABEL_NORMAL_1   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
51  | DATA_LABEL_NORMAL_2   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
52  | DATA_LABEL_NORMAL_3   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
53  | DATA_LABEL_NORMAL_4   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
54  | DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
55  | DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
56  | DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
57  | DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
58
59## 代码示例
60
61> **说明:**
62>
63> 本模块提供了异步和同步两套接口,以下为异步接口的使用示例,同步接口详见[API文档](../../reference/apis-asset-store-kit/js-apis-asset.md)。
64>
65> 在指定群组中更新一条关键资产的使用示例详见[更新群组关键资产](asset-js-group-access-control.md#更新群组关键资产)。
66
67更新别名是demo_alias的关键资产,将关键资产明文更新为demo_pwd_new,附属属性更新成demo_label_new。
68
69```typescript
70import { asset } from '@kit.AssetStoreKit';
71import { util } from '@kit.ArkTS';
72import { BusinessError } from '@kit.BasicServicesKit';
73
74function stringToArray(str: string): Uint8Array {
75  let textEncoder = new util.TextEncoder();
76  return textEncoder.encodeInto(str);
77}
78
79let query: asset.AssetMap = new Map();
80query.set(asset.Tag.ALIAS, stringToArray('demo_alias'));
81let attrsToUpdate: asset.AssetMap = new Map();
82attrsToUpdate.set(asset.Tag.SECRET, stringToArray('demo_pwd_new'));
83attrsToUpdate.set(asset.Tag.DATA_LABEL_NORMAL_1, stringToArray('demo_label_new'));
84try {
85  asset.update(query, attrsToUpdate).then(() => {
86    console.info(`Succeeded in updating Asset.`);
87  }).catch((err: BusinessError) => {
88    console.error(`Failed to update Asset. Code is ${err.code}, message is ${err.message}`);
89  });
90} catch (err) {
91  console.error(`Failed to update Asset. Code is ${err?.code}, message is ${err?.message}`);
92}
93```
94