diff --git a/en/application-dev/database/database-mdds-guidelines.md b/en/application-dev/database/database-mdds-guidelines.md index 2205df9ceffb51c3c6cb7816f6d11784ba532b20..8cec5ca111cd814d599d159ab7b333259f669ea8 100644 --- a/en/application-dev/database/database-mdds-guidelines.md +++ b/en/application-dev/database/database-mdds-guidelines.md @@ -50,18 +50,41 @@ The following uses a single KV store as an example to describe the development p This permission must also be granted by the user when the application is started for the first time. The sample code is as follows: ```js + // FA model import featureAbility from '@ohos.ability.featureAbility'; - + function grantPermission() { - console.info('grantPermission'); - let context = featureAbility.getContext(); - context.requestPermissionsFromUser(['ohos.permission.DISTRIBUTED_DATASYNC'], 666, function (result) { - console.info(`result.requestCode=${result.requestCode}`) - - }) - console.info('end grantPermission'); + console.info('grantPermission'); + let context = featureAbility.getContext(); + context.requestPermissionsFromUser(['ohos.permission.DISTRIBUTED_DATASYNC'], 666).then((data) => { + console.info('success: ${data}'); + }).catch((error) => { + console.info('failed: ${error}'); + }) } - + + grantPermission(); + + // Stage model + import Ability from '@ohos.application.Ability'; + + let context = null; + + function grantPermission() { + class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + let context = this.context; + } + } + + let permissions = ['ohos.permission.DISTRIBUTED_DATASYNC']; + context.requestPermissionsFromUser(permissions).then((data) => { + console.log('success: ${data}'); + }).catch((error) => { + console.log('failed: ${error}'); + }); + } + grantPermission(); ``` @@ -73,25 +96,39 @@ The following uses a single KV store as an example to describe the development p The sample code is as follows: ```js + // Obtain the context of the FA model. + import featureAbility from '@ohos.ability.featureAbility'; + let context = featureAbility.getContext(); + + // Obtain the context of the stage model. + import AbilityStage from '@ohos.application.Ability'; + let context = null; + class MainAbility extends AbilityStage{ + onWindowStageCreate(windowStage){ + context = this.context; + } + } + let kvManager; try { const kvManagerConfig = { bundleName: 'com.example.datamanagertest', userInfo: { + context:context, userId: '0', userType: distributedData.UserType.SAME_USER_ID } } distributedData.createKVManager(kvManagerConfig, function (err, manager) { if (err) { - console.log("createKVManager err: " + JSON.stringify(err)); + console.log('Failed to create KVManager: ${error}'); return; } - console.log("createKVManager success"); + console.log('Created KVManager successfully'); kvManager = manager; }); } catch (e) { - console.log("An unexpected error occurred. Error: " + e); + console.log('An unexpected error occurred. Error: ${e}'); } ``` @@ -115,14 +152,14 @@ The following uses a single KV store as an example to describe the development p }; kvManager.getKVStore('storeId', options, function (err, store) { if (err) { - console.log("getKVStore err: " + JSON.stringify(err)); + console.log('Failed to get KVStore: ${err}'); return; } - console.log("getKVStore success"); + console.log('Got KVStore successfully'); kvStore = store; }); } catch (e) { - console.log("An unexpected error occurred. Error: " + e); + console.log('An unexpected error occurred. Error: ${e}'); } ``` @@ -136,7 +173,7 @@ The following uses a single KV store as an example to describe the development p ```js kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) { - console.log("dataChange callback call data: " + JSON.stringify(data)); + console.log("dataChange callback call data: ${data}"); }); ``` @@ -153,13 +190,13 @@ The following uses a single KV store as an example to describe the development p try { kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err, data) { if (err != undefined) { - console.log("put err: " + JSON.stringify(err)); + console.log('Failed to put data: ${error}'); return; } - console.log("put success"); + console.log('Put data successfully'); }); } catch (e) { - console.log("An unexpected error occurred. Error: " + e); + console.log('An unexpected error occurred. Error: ${e}'); } ``` @@ -176,16 +213,16 @@ The following uses a single KV store as an example to describe the development p try { kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err, data) { if (err != undefined) { - console.log("put err: " + JSON.stringify(err)); + console.log('Failed to put data: ${error}'); return; } - console.log("put success"); + console.log('Put data successfully'); kvStore.get(KEY_TEST_STRING_ELEMENT, function (err, data) { - console.log("get success data: " + data); + console.log('Got data successfully: ${data}'); }); }); } catch (e) { - console.log("An unexpected error occurred. Error: " + e); + console.log('An unexpected error occurred. Error: ${e}'); } ``` @@ -204,7 +241,7 @@ The following uses a single KV store as an example to describe the development p let devManager; // Create deviceManager. - deviceManager.createDeviceManager("bundleName", (err, value) => { + deviceManager.createDeviceManager('bundleName', (err, value) => { if (!err) { devManager = value; // deviceIds is obtained by deviceManager by calling getTrustedDeviceListSync(). @@ -219,7 +256,7 @@ The following uses a single KV store as an example to describe the development p // 1000 indicates that the maximum delay is 1000 ms. kvStore.sync(deviceIds, distributedData.SyncMode.PUSH_ONLY, 1000); } catch (e) { - console.log("An unexpected error occurred. Error: " + e); + console.log('An unexpected error occurred. Error: ${e}'); } } }); diff --git a/en/application-dev/reference/apis/js-apis-distributed-data.md b/en/application-dev/reference/apis/js-apis-distributed-data.md index 09a68ffcbed741da9913afd1a9aff717f5f755c8..b1ceeabca8640799415596532a757f67d62e92c8 100644 --- a/en/application-dev/reference/apis/js-apis-distributed-data.md +++ b/en/application-dev/reference/apis/js-apis-distributed-data.md @@ -500,7 +500,7 @@ Obtains the IDs of all KV stores that are created by [getKVStore()](#getkvstore) | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | appId | string | Yes | Bundle name of the app that invokes the KV store. | -| callback | AsyncCallback<string[]> | Yes |Callback used to return the KV store IDs obtained. | +| callback | AsyncCallback<string[]> | Yes |Callback invoked to return the KV store IDs obtained. | **Example** @@ -600,7 +600,7 @@ Unsubscribes from service status changes. This API returns the result synchronou | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | event | string | Yes | Event to unsubscribe from. The value is **distributedDataServiceDie**, which indicates a service status change event.| -| deathCallback | Callback<void> | No | Callback for the service status change event. | +| deathCallback | Callback<void> | No | Callback for the service status change event.| **Example** @@ -1008,7 +1008,7 @@ try { }).catch((err) => { console.log('getResultSet failed: ' + err); }); - const moved5 = resultSet.move(); + const moved5 = resultSet.move(1); console.log("move succeed:" + moved5); } catch (e) { console.log("move failed: " + e); @@ -1048,7 +1048,7 @@ try { }).catch((err) => { console.log('getResultSet failed: ' + err); }); - const moved6 = resultSet.moveToPosition(); + const moved6 = resultSet.moveToPosition(1); console.log("moveToPosition succeed: " + moved6); } catch (e) { console.log("moveToPosition failed: " + e); @@ -2520,7 +2520,7 @@ Deletes a backup file. This API uses an asynchronous callback to return the resu | Name | Type | Mandatory| Description | | -------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | -| files | Array<string> | Yes | Name of the backup file to delete. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants).| +| files | Array<string> | Yes | Name of the backup file to delete. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants). | | callback | AsyncCallback<Array<[string, number]>> | Yes | Callback invoked to return the name of the backup file deleted and the operation result. | **Example** @@ -2609,7 +2609,7 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -Subscribes to the synchronization complete events. This API returns the result synchronously. +Subscribes to synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -3615,7 +3615,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses an | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | Yes |Key prefix to match. | -| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback used to return the KV pairs obtained. | +| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback invoked to return the KV pairs obtained. | **Example** @@ -4270,7 +4270,7 @@ try { on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -Subscribes to the synchronization complete events. This API returns the result synchronously. +Subscribes to synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -4306,7 +4306,7 @@ try { off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -Unsubscribes from the synchronization complete events. This API returns the result synchronously. +Unsubscribes from synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -4404,7 +4404,7 @@ class KvstoreModel { sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -4617,7 +4617,7 @@ Obtains a string value that matches the specified device ID and key. This API us | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes |ID of the target device. | | key |string | Yes |Key to match. | -| callback |AsyncCallback<boolean\|string\|number\|Uint8Array> | Yes |Callback used to return the value obtained. | +| callback |AsyncCallback<boolean\|string\|number\|Uint8Array> | Yes |Callback invoked to return the value obtained. | **Example** @@ -4696,7 +4696,7 @@ Obtains all KV pairs that match the specified device ID and key prefix. This API | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes |ID of the target device. | | keyPrefix |string | Yes |Key prefix to match. | -| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback used to return the KV pairs obtained. | +| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback invoked to return the KV pairs obtained. | **Example** @@ -4802,7 +4802,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses an | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | Yes |**Query** object to match. | -| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback used to return the KV pairs obtained. | +| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback invoked to return the KV pairs obtained. | **Example** @@ -5699,7 +5699,7 @@ try { sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -5738,7 +5738,7 @@ try { sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. This API returns the result synchronously. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. This API returns the result synchronously. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -5816,7 +5816,7 @@ try { off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -Unsubscribes from the synchronization complete events. This API returns the result synchronously. +Unsubscribes from synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core