跳到主要内容

删除关键资产(C/C++)

接口介绍

开发者可以查阅API文档,获取关键资产删除接口的详细说明:OH_Asset_Remove

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

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

属性名称(Asset_Tag)属性内容(Asset_Value)是否必选说明
ASSET_TAG_ALIAS类型为uint8[],长度为1-256字节。可选关键资产别名,每条关键资产的唯一索引。
ASSET_TAG_ACCESSIBILITY类型为uint32_t,取值范围详见Asset_Accessibility可选基于锁屏状态的访问控制。
ASSET_TAG_REQUIRE_PASSWORD_SET类型为bool。可选是否仅在设置了锁屏密码的情况下,可访问关键资产。为true时表示删除仅用户设置了锁屏密码才允许访问的关键资产;为false时表示删除无论用户是否设置锁屏密码,均可访问的关键资产。
ASSET_TAG_AUTH_TYPE类型为uint32_t,取值范围详见Asset_AuthType可选访问关键资产所需的用户认证类型。
ASSET_TAG_SYNC_TYPE类型为uint32_t,取值范围详见Asset_SyncType可选关键资产支持的同步类型。
ASSET_TAG_IS_PERSISTENT类型为bool。可选在应用卸载时是否需要保留关键资产。为true时表示删除应用卸载后会被保留的关键资产;为false时表示删除应用卸载后会被删除的关键资产。
ASSET_TAG_DATA_LABEL_CRITICAL_1类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且有完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_CRITICAL_2类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且有完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_CRITICAL_3类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且有完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_CRITICAL_4类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且有完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_NORMAL_1类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且无完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_NORMAL_2类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且无完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_NORMAL_3类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且无完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_NORMAL_4类型为uint8[],长度为1-2048字节。可选关键资产附属信息,内容由业务自定义且无完整性保护。 说明: API12前长度为1-512字节。
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_112+类型为uint8[],长度为1-2048字节。可选关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_212+类型为uint8[],长度为1-2048字节。可选关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_312+类型为uint8[],长度为1-2048字节。可选关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_412+类型为uint8[],长度为1-2048字节。可选关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。
ASSET_TAG_REQUIRE_ATTR_ENCRYPTED14+类型为bool。可选是否删除业务自定义附属信息被加密的数据。为true时表示删除业务自定义附属信息加密存储的数据,为false时表示删除业务自定义附属信息不加密存储的数据。默认值为false。
ASSET_TAG_GROUP_ID18+类型为uint8[],长度为7-127字节。可选待删除的关键资产所属群组,默认删除不属于任何群组的关键资产。

代码示例

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

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

在指定群组中删除一条关键资产的示例代码详见删除群组关键资产

  1. 在CMake脚本中链接相关动态库。

    target_link_libraries(entry PUBLIC libasset_ndk.z.so)
  2. 引用头文件。

    #include "napi/native_api.h"
    #include <string.h>
    #include "asset/asset_api.h"
  3. 参考如下示例代码,进行业务功能开发。

    static napi_value RemoveAsset(napi_env env, napi_callback_info info)
    {
    const char *aliasStr = "demo_alias";

    Asset_Blob alias = {(uint32_t)(strlen(aliasStr)), (uint8_t *)aliasStr};
    Asset_Attr attr[] = {
    {.tag = ASSET_TAG_ALIAS, .value.blob = alias}, // 此处指定别名删除单条关键资产,也可不指定别名删除多条关键资产。
    };

    int32_t removeResult = OH_Asset_Remove(attr, sizeof(attr) / sizeof(attr[0]));
    napi_value ret;
    napi_create_int32(env, removeResult, &ret);
    return ret;
    }