harmony 鸿蒙删除关键资产(ArkTS)

2025-06-16
浏览 (2)

删除关键资产(ArkTS)

接口介绍

可通过API文档查询删除关键资产的异步接口remove(query: AssetMap)、同步接口removeSync(query: AssetMap)的详细介绍。

在删除关键资产时，关键资产属性的内容（AssetMap）参数如下表所示：

注意：

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

属性名称（Tag）	属性内容（Value）	是否必选	说明
ALIAS	类型为Uint8Array，长度为1-256字节。	可选	关键资产别名，每条关键资产的唯一索引。
ACCESSIBILITY	类型为number，取值范围详见Accessibility。	可选	基于锁屏状态的访问控制。
REQUIRE_PASSWORD_SET	类型为boolean。	可选	是否仅在设置了锁屏密码的情况下，可访问关键资产。为true时表示删除仅用户设置了锁屏密码才允许访问的关键资产；为false时表示删除无论用户是否设置锁屏密码，均可访问的关键资产。
AUTH_TYPE	类型为number，取值范围详见AuthType。	可选	访问关键资产所需的用户认证类型。
SYNC_TYPE	类型为number，取值范围详见SyncType。	可选	关键资产支持的同步类型。
IS_PERSISTENT	类型为boolean。	可选	在应用卸载时是否需要保留关键资产。为true时表示删除应用卸载后会被保留的关键资产；为false时表示删除应用卸载后会被删除的关键资产。
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¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
DATA_LABEL_NORMAL_LOCAL_2¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
DATA_LABEL_NORMAL_LOCAL_3¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
DATA_LABEL_NORMAL_LOCAL_4¹²⁺	类型为Uint8Array，长度为1-2048字节。	可选	关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。
REQUIRE_ATTR_ENCRYPTED¹⁴⁺	类型为boolean。	可选	是否删除业务自定义附属信息被加密的数据。为true时表示删除业务自定义附属信息加密存储的数据，为false时表示删除业务自定义附属信息不加密存储的数据。默认值为false。
GROUP_ID¹⁸⁺	类型为Uint8Array，长度为7-127字节。	可选	待删除的关键资产所属群组，默认删除不属于任何群组的关键资产。

代码示例

说明：

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

在指定群组中删除一条关键资产的使用示例详见删除群组关键资产。

删除一条别名是demo_alias的关键资产。

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')); // 此处指定别名删除单条关键资产，也可不指定别名删除多条关键资产
try {
  asset.remove(query).then(() => {
    console.info(`Asset removed successfully.`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to remove Asset. Code is ${err.code}, message is ${err.message}`);
  });
} catch (error) {
  let err = error as BusinessError;
  console.error(`Failed to remove Asset. Code is ${err.code}, message is ${err.message}`);
}