Update an Asset (C/C++)

Available APIs

You can use OH_Asset_Update to update an asset.

The following table describes the attributes for updating an asset.

NOTE

In the following table, the attributes starting with ASSET_TAG_DATA_LABEL are custom asset attributes reserved. These attributes are not encrypted. Therefore, do not put personal data in these attributes.

Attributes in query:

Attribute Name (Asset_Tag)	Attribute Content (Asset_Value)	Mandatory	Description
ASSET_TAG_ALIAS	Type: uint8[] Length: 1-256 bytes	Yes	Asset alias, which uniquely identifies an asset.
ASSET_TAG_ACCESSIBILITY	Type: uint32_t Value range: see Asset_Accessibility	No	Access control based on the lock screen status.
ASSET_TAG_REQUIRE_PASSWORD_SET	Type: bool	No	Whether the asset is accessible only when a lock screen password is set.
ASSET_TAG_AUTH_TYPE	Type: uint32_t Value range: see Asset_AuthType	No	Type of user authentication required for accessing the asset.
ASSET_TAG_SYNC_TYPE	Type: uint32_t Value range: see Asset_SyncType	No	Type of sync supported by the asset.
ASSET_TAG_IS_PERSISTENT	Type: bool	No	Whether to retain the asset when the application is uninstalled.
ASSET_TAG_DATA_LABEL_CRITICAL_1	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service with integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_CRITICAL_2	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service with integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_CRITICAL_3	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service with integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_CRITICAL_4	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service with integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_1	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_2	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_3	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_4	Type: uint8[] Length: 1-2048 bytes	No	Asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_1¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_2¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_3¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_4¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_REQUIRE_ATTR_ENCRYPTED¹⁴⁺	Type: bool	No	Whether to update the customized asset attribute information that is encrypted. By default, the unencrypted, customized asset attribute information is updated.
ASSET_TAG_GROUP_ID¹⁸⁺	Type: Uint8[] Length: 7-127 bytes	No	Group to which the asset to be updated belongs. By default, this parameter is not specified.

Attributes in attributesToUpdate:

Attribute Name (Asset_Tag)	Attribute Content (Asset_Value)	Mandatory	Description
ASSET_TAG_SECRET	Type: uint8[] Length: 1-1024 bytes	No	New asset in plaintext.
ASSET_TAG_DATA_LABEL_NORMAL_1	Type: uint8[] Length: 1-2048 bytes	No	New asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_2	Type: uint8[] Length: 1-2048 bytes	No	New asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_3	Type: uint8[] Length: 1-2048 bytes	No	New asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_4	Type: uint8[] Length: 1-2048 bytes	No	New asset attribute information customized by the service without integrity protection. NOTE: The data length is 1 to 512 bytes before API version 12.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_1¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the new asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_2¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the new asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_3¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the new asset. The value is assigned by the service without integrity protection and will not be synced.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_4¹²⁺	Type: uint8[] Length: 1-2048 bytes	No	Local attribute information about the new asset. The value is assigned by the service without integrity protection and will not be synced.

Example

Update asset demo_alias as follows: change the asset plaintext to demo_pwd_new and additional attribute to demo_label_new.

For details about how to update an asset in a group, see Updating an asset in a Group.

Add the dynamic library in the CMake script.

target_link_libraries(entry PUBLIC libasset_ndk.z.so)

Add an asset.

#include <string.h>

#include "asset/asset_api.h"

void UpdateAsset() {
   static const char *ALIAS = "demo_alias";
   static const char *SECRET = "demo_pwd_new";
   static const char *LABEL = "demo_label_new";

   Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS };
   Asset_Blob new_secret = { (uint32_t)(strlen(SECRET)), (uint8_t *)SECRET };
   Asset_Blob new_label = { (uint32_t)(strlen(LABEL)), (uint8_t *)LABEL };
   Asset_Attr query[] = { { .tag = ASSET_TAG_ALIAS, .value.blob = alias } };
   Asset_Attr attributesToUpdate[] = {
      { .tag = ASSET_TAG_SECRET, .value.blob = new_secret },
      { .tag = ASSET_TAG_DATA_LABEL_NORMAL_1, .value.blob = new_label },
   };

   int32_t ret = OH_Asset_Update(query, sizeof(query) / sizeof(query[0]), attributesToUpdate,
                                 sizeof(attributesToUpdate) / sizeof(attributesToUpdate[0]));
   if (ret == ASSET_SUCCESS) {
      // Asset updated successfully.
   } else {
      // Failed to update Asset.
   }
}