1# 删除关键资产(ArkTS)
2
3## 接口介绍
4
5可通过API文档查询删除关键资产的异步接口[remove(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetremove)、同步接口[removeSync(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetremovesync12)的详细介绍。
6
7在删除关键资产时,关键资产属性的内容(AssetMap)参数如下表所示:
8
9>**注意:**
10>
11>下表中名称包含“DATA_LABEL”的关键资产属性,用于存储业务自定义信息,其内容不会被加密,请勿存放个人数据。
12
13| 属性名称(Tag)        | 属性内容(Value)                                             | 是否必选  | 说明                                             |
14| --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------ |
15| ALIAS                 | 类型为Uint8Array,长度为1-256字节。                            | 可选     | 关键资产别名,每条关键资产的唯一索引。            |
16| ACCESSIBILITY         | 类型为number,取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility)。 | 可选     | 基于锁屏状态的访问控制。                                     |
17| REQUIRE_PASSWORD_SET  | 类型为bool。                                                   | 可选     | 是否仅在设置了锁屏密码的情况下,可访问关键资产。     |
18| AUTH_TYPE             | 类型为number,取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype)。 | 可选     | 访问关键资产所需的用户认证类型。                   |
19| SYNC_TYPE             | 类型为number,取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype)。 | 可选     | 关键资产支持的同步类型。                           |
20| IS_PERSISTENT         | 类型为bool。                                                   | 可选     | 在应用卸载时是否需要保留关键资产。                 |
21| DATA_LABEL_CRITICAL_1 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
22| DATA_LABEL_CRITICAL_2 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
23| DATA_LABEL_CRITICAL_3 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
24| DATA_LABEL_CRITICAL_4 | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
25| DATA_LABEL_NORMAL_1   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
26| DATA_LABEL_NORMAL_2   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
27| DATA_LABEL_NORMAL_3   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
28| DATA_LABEL_NORMAL_4   | 类型为Uint8Array,长度为1-2048字节。                        | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
29| DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
30| DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
31| DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
32| DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为Uint8Array,长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
33| REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为bool。 | 可选 | 是否删除业务自定义附属信息被加密的数据,默认删除业务附属信息不加密的数据。|
34
35## 代码示例
36
37> **说明:**
38>
39> 本模块提供了异步和同步两套接口,以下为异步接口的使用示例,同步接口详见[API文档](../../reference/apis-asset-store-kit/js-apis-asset.md)。
40
41删除一条别名是demo_alias的关键资产。
42
43```typescript
44import { asset } from '@kit.AssetStoreKit';
45import { util } from '@kit.ArkTS';
46import { BusinessError } from '@kit.BasicServicesKit';
47
48function stringToArray(str: string): Uint8Array {
49  let textEncoder = new util.TextEncoder();
50  return textEncoder.encodeInto(str);
51}
52
53let query: asset.AssetMap = new Map();
54query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); // 此处指定别名删除单条数据,也可不指定别名删除多条数据
55try {
56  asset.remove(query).then(() => {
57    console.info(`Asset removed successfully.`);
58  }).catch((err: BusinessError) => {
59    console.error(`Failed to remove Asset. Code is ${err.code}, message is ${err.message}`);
60  });
61} catch (error) {
62  let err = error as BusinessError;
63  console.error(`Failed to remove Asset. Code is ${err.code}, message is ${err.message}`);
64}
65```
66