目录

Syncing Assets (Backup and Restore) (ArkTS)

Adding Assets That Support Sync

Add an asset with the password demo_pwd, alias demo_alias, and additional information demo_label.

  1. Include the header file and define the tool function.

    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);
}

  2. Develop the desired feature.

    let attr: asset.AssetMap = new Map();
attr.set(asset.Tag.SECRET, stringToArray('demo_pwd'));
attr.set(asset.Tag.ALIAS, stringToArray('demo_alias'));
attr.set(asset.Tag.DATA_LABEL_NORMAL_1, stringToArray('demo_label'));
attr.set(asset.Tag.SYNC_TYPE, asset.SyncType.TRUSTED_DEVICE); // You need to specify the sync type between trusted devices (for example, clone between old and new devices).
try {
  asset.add(attr).then(() => {
    console.info(`Succeeded in adding Asset with sync.`);
    // ...
  }).catch((err: BusinessError) => {
    console.error(`Failed to add Asset with sync. Code is ${err.code}, message is ${err.message}`);
    // ...
  })
} catch (error) {
  let err = error as BusinessError;
  console.error(`Failed to add Asset with sync. Code is ${err?.code}, message is ${err?.message}`);
  // ...
}

Accessing the Backup and Restore Extension Capability

To trigger the backup and restore of application data, see Accessing Backup and Restore.

Querying the Sync Result of Assets

[h2]Available APIs

You can call asset.querySyncResult to query the sync result of assets. For more information, see the API reference.

The following table describes the attributes of AssetMap for querying the sync result of assets.

Attribute Name (Tag) Attribute Content (Value) Required Remarks
REQUIRE_ATTR_ENCRYPTED14+ boolean type. Optional Whether to query the sync result of assets whose business custom attached information is encrypted. The value true means to query the sync result of assets whose business custom attached information is stored encrypted, and false means to query the sync result of assets whose business custom attached information is stored unencrypted. The default value is false.
GROUP_ID18+ Uint8Array type, 7 to 127 bytes in length. Optional The group to which the assets to be queried belong. By default, the sync result of assets that do not belong to any group is queried.

[h2]Sample Code

  1. Include the header file and define the tool function.

    import { asset } from '@kit.AssetStoreKit';
import { BusinessError } from '@kit.BasicServicesKit';

  2. Develop the desired feature.

    let query: asset.AssetMap = new Map();
asset.querySyncResult(query).then((res: asset.SyncResult) => {
  console.info(`Succeeded in querying sync result: ${JSON.stringify(res)}`);
  // ...
}).catch((err: BusinessError) => {
  console.error(`Failed to query sync result of Asset. Code is ${err.code}, message is ${err.message}`);
  // ...
});

Notes and Constraints

For a successful sync between trusted devices, the assets of both old and new devices must be accessible. Otherwise, the sync might fail.