• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 删除关键资产(ArkTS)
2
3## 接口介绍
4
5接口文档链接:
6
7[remove(query: AssetMap): Promise\<void>](../../reference/apis-asset-store-kit/js-apis-asset.md#assetremove)
8
9参数列表:
10
11| 属性名称(Tag)        | 属性内容(Value)                                             | 是否必选  | 说明                                             |
12| --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------ |
13| ALIAS                 | 类型为Uint8Array,长度为1-256字节                            | 可选     | 关键资产别名,每条关键资产的唯一索引;            |
14| ACCESSIBILITY         | 类型为number,取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility) | 可选     | 基于锁屏状态的访问控制                                     |
15| REQUIRE_PASSWORD_SET  | 类型为bool                                                   | 可选     | 是否仅在设置了锁屏密码的情况下,可访问关键资产     |
16| AUTH_TYPE             | 类型为number,取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype) | 可选     | 访问关键资产所需的用户认证类型                   |
17| SYNC_TYPE             | 类型为number,取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype) | 可选     | 关键资产支持的同步类型                           |
18| IS_PERSISTENT         | 类型为bool                                                   | 可选     | 在应用卸载时是否需要保留关键资产                 |
19| DATA_LABEL_CRITICAL_1 | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护 |
20| DATA_LABEL_CRITICAL_2 | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护 |
21| DATA_LABEL_CRITICAL_3 | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护 |
22| DATA_LABEL_CRITICAL_4 | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护 |
23| DATA_LABEL_NORMAL_1   | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护 |
24| DATA_LABEL_NORMAL_2   | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护 |
25| DATA_LABEL_NORMAL_3   | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护 |
26| DATA_LABEL_NORMAL_4   | 类型为Uint8Array,长度为1-512字节                            | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护 |
27
28## 代码示例
29
30删除一条别名是demo_alias的关键资产。
31
32```typescript
33import { asset } from '@kit.AssetStoreKit';
34import { util } from '@kit.ArkTS';
35import { BusinessError } from '@kit.BasicServicesKit';
36
37function stringToArray(str: string): Uint8Array {
38  let textEncoder = new util.TextEncoder();
39  return textEncoder.encodeInto(str);
40}
41
42let query: asset.AssetMap = new Map();
43query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); // 此处指定别名删除单条数据,也可不指定别名删除多条数据
44try {
45  asset.remove(query).then(() => {
46    console.info(`Asset removed successfully.`);
47  }).catch((err: BusinessError) => {
48    console.error(`Failed to remove Asset. Code is ${err.code}, message is ${err.message}`);
49  });
50} catch (error) {
51  let err = error as BusinessError;
52  console.error(`Failed to remove Asset. Code is ${err.code}, message is ${err.message}`);
53}
54```
55
56## 约束和限制
57
58