Removing Assets (ArkTS)

Available APIs

For details about the API, see:

The following table describes the parameters of AssetMap.

Attribute Name (Tag)	Attribute Content (Value)	Mandatory	Description
ALIAS	Type: Uint8Array Length: 1-256 bytes	No	Asset alias, which uniquely identifies an asset.
ACCESSIBILITY	Type: number Value range: see Accessibility	No	Access control based on the lock screen status.
REQUIRE_PASSWORD_SET	Type: bool	No	Whether the asset is accessible only when a lock screen password is set.
AUTH_TYPE	Type: number Value range: see AuthType	No	Type of user authentication required for accessing the asset.
SYNC_TYPE	Type: number Value range: see SyncType	No	Type of sync supported by the asset.
IS_PERSISTENT	Type: bool	No	Whether to retain the asset when the application is uninstalled.
DATA_LABEL_CRITICAL_1	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service with integrity protection.
DATA_LABEL_CRITICAL_2	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service with integrity protection.
DATA_LABEL_CRITICAL_3	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service with integrity protection.
DATA_LABEL_CRITICAL_4	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service with integrity protection.
DATA_LABEL_NORMAL_1	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service without integrity protection.
DATA_LABEL_NORMAL_2	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service without integrity protection.
DATA_LABEL_NORMAL_3	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service without integrity protection.
DATA_LABEL_NORMAL_4	Type: Uint8Array Length: 1-512 bytes	No	Additional asset data customized by the service without integrity protection.

Example

Remove asset 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')); // Specify the alias of the asset to remove. If no alias is specified, all assets will be removed.
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}`);
}

Constraints

N/A.