大网数据广告活动
OpenHarmony 设备与应用开发

删除关键资产(ArkTS)

· 52CE 我爱测

# 删除关键资产(ArkTS) ## 接口介绍 开发者可以查阅API文档,获取关键资产删除接口的详细说明:异步接口remove(query: AssetMap)、同步接口removeSync(query: AssetMap)。 在删除关键资产时,关键资产属性的内容(AssetMap)参数如下表所示: > **注意:** > > 下表中“ALIAS”和名称包含“DATA_LABEL”的关键资产属性,用于存储业务自定义信息,其内容不会被加密

删除关键资产(ArkTS)

接口介绍

开发者可以查阅API文档,获取关键资产删除接口的详细说明:异步接口remove(query: AssetMap)、同步接口removeSync(query: AssetMap)。

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

注意:

下表中“ALIAS”和名称包含“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_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+ 类型为boolean。 可选 是否删除业务自定义附属信息被加密的数据。为true时表示删除业务自定义附属信息加密存储的数据,为false时表示删除业务自定义附属信息不加密存储的数据。默认值为false。
GROUP_ID18+ 类型为Uint8Array,长度为7-127字节。 可选 待删除的关键资产所属群组,默认删除不属于任何群组的关键资产。

代码示例

说明:

本模块提供了异步和同步两套接口,以下为异步接口的使用示例,同步接口详见@ohos.security.asset (关键资产存储服务)。

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

在删除前,需确保已有关键资产,可参考指南文档新增关键资产,否则将抛出NOT_FOUND错误(错误码24000002)。

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

  1. 引用头文件,定义工具函数。

    
    function stringToArray(str: string): Uint8Array {
      let textEncoder = new util.TextEncoder();
      return textEncoder.encodeInto(str);
    }
    
  2. 参考如下示例代码,进行业务功能开发。

    let query: asset.AssetMap = new Map();
    query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); // 此处指定别名删除单条关键资产,也可不指定别名删除多条关键资产。
    try {
      asset.remove(query).then(() => {
        console.info(`Succeeded in removing Asset.`);
        // ...
      }).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}`);
      // ...
    }
    

本文来自 OpenHarmony 文档贡献者,按 CC BY 4.0 整理版式与相对链接,保留正文与代码。图示请参阅原文。作者与贡献记录。

资料来源与适用范围

资料来源
OpenHarmony 文档贡献者
适用范围
master 文档快照(2026-11-16)
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。