diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index f62fac08754fa1e24a432a2168b0cc37fce1fcd3..97d64ac3ff9e26945372209671c595379117577d 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -12,7 +12,6 @@ - [@ohos.application.appManager](js-apis-appmanager.md) - [@ohos.application.Configuration](js-apis-configuration.md) - [@ohos.application.ConfigurationConstant](js-apis-configurationconstant.md) - - [@ohos.application.DataShareExtensionAbility](js-apis-application-DataShareExtensionAbility.md) - [@ohos.ability.featureAbility](js-apis-featureAbility.md) - [@ohos.application.formBindingData](js-apis-formbindingdata.md) - [@ohos.application.FormExtension](js-apis-formextension.md) @@ -45,7 +44,6 @@ - application/[ProcessRunningInfo](js-apis-processrunninginfo.md) - application/[ServiceExtensionContext](js-apis-service-extension-context.md) - application/[shellCmdResult](js-apis-application-shellCmdResult.md) - - Common Event and Notification - [@ohos.commonEvent](js-apis-commonEvent.md) @@ -53,19 +51,16 @@ - [@ohos.notification](js-apis-notification.md) - [@ohos.reminderAgent](js-apis-reminderAgent.md) - application/[EventHub](js-apis-eventhub.md) - - Bundle Management - [@ohos.bundle](js-apis-Bundle.md) - [@ohos.zlib](js-apis-zlib.md) - - UI Page - [@ohos.animator](js-apis-animator.md) - [@ohos.mediaquery](js-apis-mediaquery.md) - [@ohos.prompt](js-apis-prompt.md) - [@ohos.router](js-apis-router.md) - - Graphics - [@ohos.display ](js-apis-display.md) @@ -73,7 +68,6 @@ - [@ohos.window](js-apis-window.md) - [webgl](js-apis-webgl.md) - [webgl2](js-apis-webgl2.md) - - Media - [@ohos.multimedia.audio](js-apis-audio.md) @@ -81,12 +75,10 @@ - [@ohos.multimedia.image](js-apis-image.md) - [@ohos.multimedia.media](js-apis-media.md) - [@ohos.multimedia.medialibrary](js-apis-medialibrary.md) - - Resource Management - [@ohos.i18n](js-apis-i18n.md) - [@ohos.intl](js-apis-intl.md) - [@ohos.resourceManager](js-apis-resource-manager.md) - - Resource Scheduling - [@ohos.backgroundTaskManager](js-apis-backgroundTaskManager.md) @@ -94,19 +86,16 @@ - [@ohos.WorkSchedulerExtensionAbility](js-apis-WorkSchedulerExtensionAbility.md) - [@ohos.bundleState ](js-apis-deviceUsageStatistics.md) - - Custom Management - [@ohos.configPolicy](js-apis-config-policy.md) - [@ohos.enterpriseDeviceManager](js-apis-enterprise-device-manager.md) - - Security - [@ohos.abilityAccessCtrl](js-apis-abilityAccessCtrl.md) - [@ohos.security.huks ](js-apis-huks.md) - [@ohos.userIAM.userAuth ](js-apis-useriam-userauth.md) - [@system.cipher](js-apis-system-cipher.md) - - Data Management - [@ohos.data.dataAbility ](js-apis-data-ability.md) @@ -116,7 +105,6 @@ - [@ohos.data.rdb](js-apis-data-rdb.md) - [@ohos.settings](js-apis-settings.md) - data/rdb/[resultSet](js-apis-data-resultset.md) - - File Management - [@ohos.document](js-apis-document.md) @@ -126,7 +114,6 @@ - [@ohos.statfs](js-apis-statfs.md) - [@ohos.storageStatistics](js-apis-storage-statistics.md) - [@ohos.volumeManager](js-apis-volumemanager.md) - - Telephony Service - [@ohos.contact](js-apis-contact.md) @@ -136,14 +123,12 @@ - [@ohos.telephony.sim](js-apis-sim.md) - [@ohos.telephony.sms](js-apis-sms.md) - [@ohos.telephony.data](js-apis-telephony-data.md) - - Network Management - [@ohos.net.connection](js-apis-net-connection.md) - [@ohos.net.http](js-apis-http.md) - [@ohos.request](js-apis-request.md) - [@ohos.net.socket](js-apis-socket.md) - [@ohos.net.webSocket](js-apis-webSocket.md) - - Connectivity - [@ohos.bluetooth](js-apis-bluetooth.md) @@ -151,7 +136,6 @@ - [@ohos.rpc](js-apis-rpc.md) - [@ohos.wifi](js-apis-wifi.md) - [@ohos.wifiext](js-apis-wifiext.md) - - Basic Features - [@ohos.accessibility](js-apis-accessibility.md) @@ -169,7 +153,6 @@ - [@ohos.systemTime](js-apis-system-time.md) - [@ohos.wallpaper](js-apis-wallpaper.md) - [Timer](js-apis-timer.md) - - Device Management - [@ohos.batteryInfo ](js-apis-battery-info.md) @@ -189,13 +172,11 @@ - [@ohos.update](js-apis-update.md) - [@ohos.usb](js-apis-usb.md) - [@ohos.vibrator](js-apis-vibrator.md) - - Account Management - [@ohos.account.appAccount](js-apis-appAccount.md) - [@ohos.account.distributedAccount](js-apis-distributed-account.md) - [@ohos.account.osAccount](js-apis-osAccount.md) - - Language Base Class Library - [@ohos.convertxml](js-apis-convertxml.md) @@ -219,11 +200,9 @@ - [@ohos.util.Vector](js-apis-vector.md) - [@ohos.worker](js-apis-worker.md) - [@ohos.xml](js-apis-xml.md) - - Test - [@ohos.application.testRunner](js-apis-testRunner.md) - [@ohos.uitest](js-apis-uitest.md) - - APIs No Longer Maintained - [@ohos.bytrace](js-apis-bytrace.md) diff --git a/en/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md b/en/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md deleted file mode 100644 index 65b685c14b6f1c23468f44f6cde41b3de4641202..0000000000000000000000000000000000000000 --- a/en/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md +++ /dev/null @@ -1,347 +0,0 @@ -# DataShareExtensionAbility - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** -> The APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. - - -Provides the Extension ability for data sharing. - - -## Modules to Import - - -``` -import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility'; -``` - -## Attributes - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -| Name| Readable| Writable| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -------- | -------- | -| context | Yes| No| ExtensionContext | No| Context of the Data Share Extension ability.| - - -## DataShareExtensionAbility.onCreate - -onCreate?(want: Want): void; - -Called when the Data Share Extension ability is initialized. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | want | Want | Yes| Connection information about the Data Share Extension ability.| - -**Example** - - ```js - class myAbility extends DataShareExtensionAbility { - onCreate(want) { - console.log('onCreate, want:' + want.abilityName); - } - } - ``` - -## DataShareExtensionAbility.getFileTypes - -getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void - -Obtains the supported MIME types of a specified file. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------------- | ------------------------------ | ---- | ---------------------------------- | -| uri | string | Yes | URI of the file. | -| mimeTypeFilter | string | Yes | MIME type of the file. | -| callback | AsyncCallback\> | Yes | Callback used to return the supported MIME types.| - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getFileTypes( - "dataability:///com.example.DataAbility", - "image/*", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.insert - -insert?(uri: string, valueBucket: rdb.ValuesBucket, callback: AsyncCallback\): void - -Inserts a single data record into the database. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------------ | ---------------------- | ---- | ------------------------------------------------------ | -| uri | string | Yes | URI of the data to insert. | -| valuesBucket | rdb.ValuesBucket | Yes | Data record to insert. If this parameter is **null**, a blank row will be inserted.| -| callback | AsyncCallback\ | Yes | Callback used to return the index of the inserted data record. | - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const valueBucket = { - "name": "rose", - "age": 22, - "salary": 200.5, - "blobType": u8, -} -DAHelper.insert( - "dataability:///com.example.DataAbility", - valueBucket, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.update - -update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -Updates one or more data records in the database. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | Yes | URI of the data to update. | -| valuesBucket | rdb.ValuesBucket | Yes | New data. | -| predicates | dataAbility.DataAbilityPredicates | Yes | Filter criteria. You should define the processing logic when this parameter is **null**.| -| callback | AsyncCallback\ | Yes | Callback used to return the number of updated data records. | - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataability' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const va = { - "name": "roe1", - "age": 21, - "salary": 20.5, - "blobType": u8, -} -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.update( - "dataability:///com.example.DataAbility", - va, - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.delete - -delete?(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -Deletes one or more data records from the database. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | Yes | URI of the data to delete. | -| valuesBucket | dataAbility.DataAbilityPredicates | Yes | Filter criteria. You should define the processing logic when this parameter is **null**.| -| callback | AsyncCallback\ | Yes | Callback used to return the number of deleted data records. | - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataability' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.delete( - "dataability:///com.example.DataAbility", - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.query - -query?(uri: string, columns: Array\, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -Queries data in the database. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | Yes | URI of the data to query. | -| columns | rdb.ValuesBucket | Yes | Columns to query. If this parameter is **null**, all columns will be queried. | -| predicates | dataAbility.DataAbilityPredicates | Yes | Filter criteria. You should define the processing logic when this parameter is **null**.| -| callback | AsyncCallback\ | Yes | Callback used to return the query result. | - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataability' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars=new Array("value1", "value2", "value3", "value4"); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.query( - "dataability:///com.example.DataAbility", - cars, - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.getType - -getType?(uri: string, callback: AsyncCallback\): void - -Obtains the MIME type of the data specified by a given URI. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------- | ---- | --------------------------------------------- | -| uri | string | Yes | URI of the data. | -| callback | AsyncCallback\ | Yes | Callback used to return the MIME type.| - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getType( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.batchInsert - -batchInsert?(uri: string, valueBuckets: Array, callback: AsyncCallback\): void - -Inserts multiple data records into the database. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------------ | ----------------------- | ---- | -------------------------------- | -| uri | string | Yes | URI of the data to insert. | -| valuesBucket | Array | Yes | Data record to insert. | -| callback | AsyncCallback\ | Yes | Callback used to return the number of inserted data records.| - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,}, - {"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,}, - {"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,}) -DAHelper.batchInsert( - "dataability:///com.example.DataAbility", - cars, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.normalizeUri - -normalizeUri?(uri: string, callback: AsyncCallback\): void - -Converts the URI that refers to the Data ability into a normalized URI. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------- | ---- | ------------------------------------------------------------ | -| uri | string | Yes | URI object to normalize. | -| callback | AsyncCallback\ | Yes | Callback used to return the normalized URI object if the Data ability supports URI normalization. If the Data ability does not support URI normalization, **null** is returned.| - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.normalizeUri( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.denormalizeUri - -denormalizeUri?(uri: string, callback: AsyncCallback\): void - -Converts a normalized URI generated by **normalizeUri** to a denormalized one. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.DistributedDataManager.DataShare.Provider - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------- | ---- | --------------------------------------------------- | -| uri | string | Yes | URI object to denormalize. | -| callback | AsyncCallback\ | Yes | Callback used to return the denormalized URI object.| - -**Example** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.denormalizeUri( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` diff --git a/en/application-dev/website.md b/en/application-dev/website.md index 35ff141a933ca400736dfaa2dd15affd1d141be6..b2b122312b144ae108d7d6fcc44f4192a390278b 100644 --- a/en/application-dev/website.md +++ b/en/application-dev/website.md @@ -515,7 +515,6 @@ - [@ohos.application.appManager](reference/apis/js-apis-appmanager.md) - [@ohos.application.Configuration](reference/apis/js-apis-configuration.md) - [@ohos.application.ConfigurationConstant](reference/apis/js-apis-configurationconstant.md) - - [@ohos.application.DataShareExtensionAbility](reference/apis/js-apis-application-DataShareExtensionAbility.md) - [@ohos.ability.featureAbility](reference/apis/js-apis-featureAbility.md) - [@ohos.application.formBindingData](reference/apis/js-apis-formbindingdata.md) - [@ohos.application.FormExtension](reference/apis/js-apis-formextension.md) @@ -548,7 +547,6 @@ - [ProcessRunningInfo](reference/apis/js-apis-processrunninginfo.md) - [ServiceExtensionContext](reference/apis/js-apis-service-extension-context.md) - [shellCmdResult](reference/apis/js-apis-application-shellCmdResult.md) - - Common Event and Notification - [@ohos.commonEvent](reference/apis/js-apis-commonEvent.md) @@ -556,61 +554,52 @@ - [@ohos.notification](reference/apis/js-apis-notification.md) - [@ohos.reminderAgent](reference/apis/js-apis-reminderAgent.md) - [EventHub](reference/apis/js-apis-eventhub.md) - - Bundle Management - + - [@ohos.bundle](reference/apis/js-apis-Bundle.md) - [@ohos.bundleState ](reference/apis/js-apis-deviceUsageStatistics.md) - [@ohos.zlib](reference/apis/js-apis-zlib.md) - - UI Page - + - [@ohos.animator](reference/apis/js-apis-animator.md) - [@ohos.mediaquery](reference/apis/js-apis-mediaquery.md) - [@ohos.prompt](reference/apis/js-apis-prompt.md) - [@ohos.router](reference/apis/js-apis-router.md) - - Graphics - + - [@ohos.display ](reference/apis/js-apis-display.md) - [@ohos.screenshot](reference/apis/js-apis-screenshot.md) - [@ohos.window](reference/apis/js-apis-window.md) - [webgl](reference/apis/js-apis-webgl.md) - [webgl2](reference/apis/js-apis-webgl2.md) - - Media - + - [@ohos.multimedia.audio](reference/apis/js-apis-audio.md) - [@ohos.multimedia.camera](reference/apis/js-apis-camera.md) - [@ohos.multimedia.image](reference/apis/js-apis-image.md) - [@ohos.multimedia.media](reference/apis/js-apis-media.md) - [@ohos.multimedia.medialibrary](reference/apis/js-apis-medialibrary.md) - - Resource Management - [@ohos.i18n](reference/apis/js-apis-i18n.md) - [@ohos.intl](reference/apis/js-apis-intl.md) - [@ohos.resourceManager](reference/apis/js-apis-resource-manager.md) - - Resource Scheduling - + - [@ohos.backgroundTaskManager](reference/apis/js-apis-backgroundTaskManager.md) - [@ohos.workScheduler ](reference/apis/js-apis-workScheduler.md) - [@ohos.WorkSchedulerExtensionAbility](reference/apis/js-apis-WorkSchedulerExtensionAbility.md) - - Custom Management - + - [@ohos.configPolicy](reference/apis/js-apis-config-policy.md) - [@ohos.enterpriseDeviceManager](reference/apis/js-apis-enterprise-device-manager.md) - - Security - + - [@ohos.abilityAccessCtrl](reference/apis/js-apis-abilityAccessCtrl.md) - [@ohos.security.huks ](reference/apis/js-apis-huks.md) - [@ohos.userIAM.userAuth ](reference/apis/js-apis-useriam-userauth.md) - [@system.cipher](reference/apis/js-apis-system-cipher.md) - - Data Management - + - [@ohos.data.dataAbility ](reference/apis/js-apis-data-ability.md) - [@ohos.data.distributedData](reference/apis/js-apis-distributed-data.md) - [@ohos.data.distributedDataObject](reference/apis/js-apis-data-distributedobject.md) @@ -618,7 +607,6 @@ - [@ohos.data.rdb](reference/apis/js-apis-data-rdb.md) - [@ohos.settings](reference/apis/js-apis-settings.md) - [resultSet](reference/apis/js-apis-data-resultset.md) - - File Management - [@ohos.environment](reference/apis/js-apis-environment.md) @@ -627,9 +615,8 @@ - [@ohos.statfs](reference/apis/js-apis-statfs.md) - [@ohos.storageStatistics](reference/apis/js-apis-storage-statistics.md) - [@ohos.volumeManager](reference/apis/js-apis-volumemanager.md) - - Telephony Service - + - [@ohos.contact](reference/apis/js-apis-contact.md) - [@ohos.telephony.call](reference/apis/js-apis-call.md) - [@ohos.telephony.observer](reference/apis/js-apis-observer.md) @@ -637,24 +624,21 @@ - [@ohos.telephony.sim](reference/apis/js-apis-sim.md) - [@ohos.telephony.sms](reference/apis/js-apis-sms.md) - [@ohos.telephony.data](reference/apis/js-apis-telephony-data.md) - - Network Management - [@ohos.net.connection](reference/apis/js-apis-net-connection.md) - [@ohos.net.http](reference/apis/js-apis-http.md) - [@ohos.request](reference/apis/js-apis-request.md) - [@ohos.net.socket](reference/apis/js-apis-socket.md) - [@ohos.net.webSocket](reference/apis/js-apis-webSocket.md) - - Connectivity - + - [@ohos.bluetooth](reference/apis/js-apis-bluetooth.md) - [@ohos.connectedTag](reference/apis/js-apis-connectedTag.md) - [@ohos.rpc](reference/apis/js-apis-rpc.md) - [@ohos.wifi](reference/apis/js-apis-wifi.md) - [@ohos.wifiext](reference/apis/js-apis-wifiext.md) - - Basic Features - + - [@ohos.accessibility](reference/apis/js-apis-accessibility.md) - [@ohos.faultLogger](reference/apis/js-apis-faultLogger.md) - [@ohos.hiAppEvent](reference/apis/js-apis-hiappevent.md) @@ -670,9 +654,8 @@ - [@ohos.systemTime](reference/apis/js-apis-system-time.md) - [@ohos.wallpaper](reference/apis/js-apis-wallpaper.md) - [Timer](reference/apis/js-apis-timer.md) - - Device Management - + - [@ohos.batteryInfo ](reference/apis/js-apis-battery-info.md) - [@ohos.brightness](reference/apis/js-apis-brightness.md) - [@ohos.deviceInfo](reference/apis/js-apis-device-info.md) @@ -690,15 +673,13 @@ - [@ohos.update](reference/apis/js-apis-update.md) - [@ohos.usb](reference/apis/js-apis-usb.md) - [@ohos.vibrator](reference/apis/js-apis-vibrator.md) - - Account Management - + - [@ohos.account.appAccount](reference/apis/js-apis-appAccount.md) - [@ohos.account.distributedAccount](reference/apis/js-apis-distributed-account.md) - [@ohos.account.osAccount](reference/apis/js-apis-osAccount.md) - - Language Base Class Library - + - [@ohos.convertxml](reference/apis/js-apis-convertxml.md) - [@ohos.process](reference/apis/js-apis-process.md) - [@ohos.uri](reference/apis/js-apis-uri.md) @@ -720,13 +701,11 @@ - [@ohos.util.Vector](reference/apis/js-apis-vector.md) - [@ohos.worker](reference/apis/js-apis-worker.md) - [@ohos.xml](reference/apis/js-apis-xml.md) - - Test - [@ohos.application.testRunner](reference/apis/js-apis-testRunner.md) - [@ohos.uitest](reference/apis/js-apis-uitest.md) - - APIs No Longer Maintained - + - [@ohos.bytrace](reference/apis/js-apis-bytrace.md) - [@ohos.data.storage](reference/apis/js-apis-data-storage.md) - [@system.app](reference/apis/js-apis-system-app.md) diff --git a/zh-cn/application-dev/quick-start/start-overview.md b/zh-cn/application-dev/quick-start/start-overview.md index 0b23348ed04aa7fa496e332aeabf70127e8e44f9..77592bd907882d3391a58e11351ed83ebcb5f992 100644 --- a/zh-cn/application-dev/quick-start/start-overview.md +++ b/zh-cn/application-dev/quick-start/start-overview.md @@ -14,7 +14,7 @@ ### UI框架 -OpenHarmony提供了一套UI开发框架，即方舟开发框架（ArkUI框架）。方舟开发框架可为开发者提供应用UI开发所必需的能力，比如多种组件、布局计算、动画能力、UI交互、绘制等等。 +OpenHarmony提供了一套UI开发框架，即方舟开发框架（ArkUI框架）。方舟开发框架可为开发者提供应用UI开发所必需的能力，比如多种组件、布局计算、动画能力、UI交互、绘制等。 方舟开发框架针对不同目的和技术背景的开发者提供了两种开发范式，分别是基于JS扩展的类Web开发范式（简称“类Web开发范式”）和基于TS扩展的声明式开发范式（简称“声明式开发范式”）。以下是两种开发范式的简单对比。 @@ -27,14 +27,14 @@ OpenHarmony提供了一套UI开发框架，即方舟开发框架（ArkUI框架 对于eTS语言开发，除传统代码方式外，低代码方式则在DevEco Studio V3.0 Beta3及更高版本中支持。 -OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，遵循JS开发规范，通过可视化界面开发方式快速构建布局，可有效降低用户的上手成本并提升用户构建UI界面的效率。 +OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，遵循JS开发规范，通过可视化界面开发方式快速构建布局，可有效降低开发者的上手成本并提升开发者构建UI界面的效率。 ### Ability Ability是应用所具备能力的抽象，也是应用程序的重要组成部分。一个应用可以具备多种能力（即可以包含多个Ability）。OpenHarmony支持应用以Ability为单位进行部署。 -Ability可以分为[FA（Feature Ability）](../../glossary.md#f)和[PA（Particle Ability）](../../glossary.md#p)两种类型，每种类型为开发者提供了不同的模板，以便实现不同的业务功能。其中，FA支持[Page Ability](../ability/fa-pageability.md)模板，以提供与用户交互的能力。一个Page Ability可以含有一个或多个页面（即Page），Page Ability与Page的关系如下图所示： +Ability分为[FA（Feature Ability）](../../glossary.md#f)和[PA（Particle Ability）](../../glossary.md#p)两种类型，每种类型为开发者提供了不同的模板，以便实现不同的业务功能。其中，FA支持[Page Ability](../ability/fa-pageability.md)模板，以提供与用户交互的能力。一个Page Ability可以含有一个或多个页面（即Page），Page Ability与Page的关系如下图所示： ![zh-cn_image_0000001215206886](figures/zh-cn_image_0000001215206886.png) diff --git a/zh-cn/application-dev/quick-start/start-with-ets-low-code.md b/zh-cn/application-dev/quick-start/start-with-ets-low-code.md index 1c475372fd5fe7c769ce7c8d01af5f00403bdfcf..848c0525318884fa0f5417f528d6c43a64d8b05c 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets-low-code.md +++ b/zh-cn/application-dev/quick-start/start-with-ets-low-code.md @@ -9,7 +9,7 @@ > 为确保运行效果，本文以使用**DevEco Studio V3.0.0.900 Beta3**版本为例，点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download_beta_openharmony)获取下载链接。 -OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可视化界面开发方式快速构建布局，可有效降低用户的上手成本并提升用户构建UI界面的效率。 +OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可视化界面开发方式快速构建布局，可有效降低开发者的上手成本并提升开发者构建UI界面的效率。 使用低代码开发应用或服务有以下两种开发方式： @@ -22,7 +22,7 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可 ## 创建新工程支持低代码开发 -1. 打开**DevEco Studio**，点击**File** > **New** > **Create Project**，选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 +1. 若首次打开**DevEco Studio**，请点击**Create Project**创建工程。如果已有一个工程，请点击**File** > **New** > **Create Project**。选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 ![zh-cn_image_0000001233528152](figures/zh-cn_image_0000001233528152.png) diff --git a/zh-cn/application-dev/quick-start/start-with-ets.md b/zh-cn/application-dev/quick-start/start-with-ets.md index f7b2d9f26e34cad1c54c0f545c60654b0597c36b..5feed1264b76dc9a790b834388157f01cfc739e2 100644 --- a/zh-cn/application-dev/quick-start/start-with-ets.md +++ b/zh-cn/application-dev/quick-start/start-with-ets.md @@ -8,7 +8,7 @@ ## 创建eTS工程 -1. 打开**DevEco Studio**，点击**File** > **New** > **Create Project**，选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 +1. 若首次打开**DevEco Studio**，请点击**Create Project**创建工程。如果已有一个工程，请点击**File** > **New** > **Create Project**。选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 ![zh-cn_image_0000001223556342](figures/zh-cn_image_0000001223556342.png) @@ -21,14 +21,14 @@ ## eTS工程项目文件 -- **entry** ：OpenHarmony工程模块，编译构建生成一个Hap包。 +- **entry** ：OpenHarmony工程模块，编译构建生成一个[HAP](../../glossary.md#hap)包。 - **src > main > ets** ：用于存放ets源码。 - **src > main > ets > MainAbility** ：应用/服务的入口。 - **src > main > ets > MainAbility > pages** ：MainAbility包含的页面。 - **src > main > ets > MainAbility > app.ets** ：承载Ability生命周期。 - **src > main > resources** ：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。 - **src > main > config.json** ：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。 - - **build-profile.json5** ：模块的模块信息 、编译信息配置项，包括 buildOption target配置等。 + - **build-profile.json5** ：当前的模块信息 、编译信息配置项，包括 buildOption target配置等。 - **hvigorfile.js** ：模块级编译构建任务脚本，开发者可以自定义相关任务和代码实现。 - **build-profile.json5** ：应用级配置信息，包括签名、产品配置等。 @@ -63,7 +63,7 @@ ``` 2. **添加按钮。** - 在默认页面基础上，我们添加一个Button组件，作为按钮接受用户点击的动作，从而实现跳转到另一个页面。“**index.ets**”文件的示例如下： + 在默认页面基础上，我们添加一个Button组件，作为按钮接收用户点击的动作，从而实现跳转到另一个页面。“**index.ets**”文件的示例如下： ``` @@ -78,7 +78,7 @@ Text(this.message) .fontSize(50) .fontWeight(FontWeight.Bold) - // 添加按钮，以接受用户点击 + // 添加按钮，以接收用户点击 Button() { Text('Next') .fontSize(30) @@ -170,7 +170,7 @@ Text(this.message) .fontSize(50) .fontWeight(FontWeight.Bold) - // 添加按钮，以接受用户点击 + // 添加按钮，以接收用户点击 Button() { Text('Next') .fontSize(30) diff --git a/zh-cn/application-dev/quick-start/start-with-js-low-code.md b/zh-cn/application-dev/quick-start/start-with-js-low-code.md index cf8dd9550c800183d93147d9bfa969195e5eae97..f7f7a6898e99b9c791875a031955885e8a00a1e6 100644 --- a/zh-cn/application-dev/quick-start/start-with-js-low-code.md +++ b/zh-cn/application-dev/quick-start/start-with-js-low-code.md @@ -7,7 +7,7 @@ > 为确保运行效果，本文以使用**DevEco Studio V3.0.0.900 Beta3**版本为例，点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download_beta_openharmony)获取下载链接。 -OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可视化界面开发方式快速构建布局，可有效降低用户的上手成本并提升用户构建UI界面的效率。 +OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可视化界面开发方式快速构建布局，可有效降低开发者的上手成本并提升开发者构建UI界面的效率。 使用低代码开发应用或服务有以下两种开发方式： @@ -23,7 +23,7 @@ OpenHarmony低代码开发方式具有丰富的UI界面编辑功能，通过可 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 该功能在DevEco Studio 3.0 Beta2及更高版本中支持，且compileSdkVersion必须为7或以上。 -1. 打开**DevEco Studio**，点击**File** > **New** > **Create Project**，选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 +1. 若首次打开**DevEco Studio**，请点击**Create Project**创建工程。如果已有一个工程，请点击**File** > **New** > **Create Project**。选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 ![zh-cn_image_0000001268198893](figures/zh-cn_image_0000001268198893.png) diff --git a/zh-cn/application-dev/quick-start/start-with-js.md b/zh-cn/application-dev/quick-start/start-with-js.md index 3ef22d0a3e34fa12819988174ba89707fdd614c4..a65e74890ca39259be58b85f51fdaf07e0cbd2ac 100644 --- a/zh-cn/application-dev/quick-start/start-with-js.md +++ b/zh-cn/application-dev/quick-start/start-with-js.md @@ -7,7 +7,7 @@ ## 创建JS工程 -1. 打开**DevEco Studio**，点击**File** > **New** > **Create Project**，选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 +1. 若首次打开**DevEco Studio**，请点击**Create Project**创建工程。如果已有一个工程，请点击**File** > **New** > **Create Project**。选择模板“**Empty Ability**”，点击**Next**进行下一步配置。 ![zh-cn_image_0000001223558814](figures/zh-cn_image_0000001223558814.png) @@ -20,7 +20,7 @@ ## JS工程项目文件 -- **entry**：OpenHarmony工程模块，编译构建生成一个Hap包。 +- **entry**：OpenHarmony工程模块，编译构建生成一个[HAP](../../glossary.md#hap)包。 - **src > main > js** ：用于存放js源码。 - **src > main > js > MainAbility** ：应用/服务的入口。 - **src > main > js > MainAbility > i18n** ：用于配置不同语言场景资源内容，比如应用文本词条、图片路径等资源。 @@ -29,7 +29,7 @@ - **src > main > resources** ：用于存放应用/服务所用到的资源文件，如图形、多媒体、字符串、布局文件等。 - **src > main > config.json** ：模块配置文件。主要包含HAP包的配置信息、应用/服务在具体设备上的配置信息以及应用/服务的全局配置信息。 - - **build-profile.json5** ：模块的模块信息 、编译信息配置项，包括 buildOption target配置等。 + - **build-profile.json5** ：当前的模块信息 、编译信息配置项，包括 buildOption target配置等。 - **hvigorfile.js** ：模块级编译构建任务脚本，开发者可以自定义相关任务和代码实现。 - **build-profile.json5** ：应用级配置信息，包括签名、产品配置等。 @@ -52,7 +52,7 @@ ``` 2. **添加按钮，并绑定onclick方法。** - 在默认页面基础上，我们添加一个button类型的input组件，作为按钮接受用户点击的动作，从而实现跳转到另一个页面。“**index.hml**”文件的示例代码如下： + 在默认页面基础上，我们添加一个button类型的input组件，作为按钮接收用户点击的动作，从而实现跳转到另一个页面。“**index.hml**”文件的示例代码如下： ``` diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index c65f57df8079cb2ec673b7e20f8fba180c5de023..dba338b22c9a6bc34b2b89381ef7bec4dd3519f1 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -12,7 +12,6 @@ - [@ohos.application.appManager (appManager)](js-apis-appmanager.md) - [@ohos.application.Configuration (Configuration)](js-apis-configuration.md) - [@ohos.application.ConfigurationConstant (ConfigurationConstant)](js-apis-configurationconstant.md) - - [@ohos.application.DataShareExtensionAbility (DataShareExtensionAbility)](js-apis-application-DataShareExtensionAbility.md) - [@ohos.ability.featureAbility (FeatureAbility模块)](js-apis-featureAbility.md) - [@ohos.application.formBindingData (卡片数据绑定类)](js-apis-formbindingdata.md) - [@ohos.application.FormExtension (FormExtension)](js-apis-formextension.md) @@ -45,7 +44,6 @@ - application/[ProcessRunningInfo (ProcessRunningInfo)](js-apis-processrunninginfo.md) - application/[ServiceExtensionContext (ServiceExtensionContext)](js-apis-service-extension-context.md) - application/[shellCmdResult (ShellCmdResult)](js-apis-application-shellCmdResult.md) - - 公共事件与通知 - [@ohos.commonEvent (公共事件模块)](js-apis-commonEvent.md) @@ -53,20 +51,17 @@ - [@ohos.notification (Notification模块)](js-apis-notification.md) - [@ohos.reminderAgent (后台代理提醒)](js-apis-reminderAgent.md) - application/[EventHub (EventHub)](js-apis-eventhub.md) - - 应用程序包管理 - [@ohos.bundle (Bundle模块)](js-apis-Bundle.md) - [@ohos.bundleState (设备使用信息统计)](js-apis-deviceUsageStatistics.md) - [@ohos.zlib (Zip模块)](js-apis-zlib.md) - - UI界面 - [@ohos.animator (动画)](js-apis-animator.md) - [@ohos.mediaquery (媒体查询)](js-apis-mediaquery.md) - [@ohos.prompt (弹窗)](js-apis-prompt.md) - [@ohos.router (页面路由)](js-apis-router.md) - - 图形图像 - [@ohos.display (屏幕属性)](js-apis-display.md) @@ -74,7 +69,6 @@ - [@ohos.window (窗口)](js-apis-window.md) - [webgl (WebGL)](js-apis-webgl.md) - [webgl2 (WebGL2)](js-apis-webgl2.md) - - 媒体 - [@ohos.multimedia.audio (音频管理)](js-apis-audio.md) @@ -82,30 +76,25 @@ - [@ohos.multimedia.image (图片处理)](js-apis-image.md) - [@ohos.multimedia.media (媒体服务)](js-apis-media.md) - [@ohos.multimedia.medialibrary (媒体库管理)](js-apis-medialibrary.md) - - 资源管理 - [@ohos.i18n (国际化-I18n)](js-apis-i18n.md) - [@ohos.intl (国际化-Intl)](js-apis-intl.md) - [@ohos.resourceManager (资源管理)](js-apis-resource-manager.md) - - 资源调度 - [@ohos.backgroundTaskManager (后台任务管理)](js-apis-backgroundTaskManager.md) - [@ohos.workScheduler (延迟任务调度)](js-apis-workScheduler.md) - [@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)](js-apis-WorkSchedulerExtensionAbility.md) - - 定制管理 - [@ohos.configPolicy (配置策略)](js-apis-config-policy.md) - [@ohos.enterpriseDeviceManager (企业设备管理)](js-apis-enterprise-device-manager.md) - - 安全 - [@ohos.abilityAccessCtrl (访问控制管理)](js-apis-abilityAccessCtrl.md) - [@ohos.security.huks (通用密钥库系统)](js-apis-huks.md) - [@ohos.userIAM.userAuth (用户认证)](js-apis-useriam-userauth.md) - [@system.cipher (加密算法)](js-apis-system-cipher.md) - - 数据管理 - [@ohos.data.dataAbility (DataAbility谓词)](js-apis-data-ability.md) @@ -115,7 +104,6 @@ - [@ohos.data.rdb (关系型数据库)](js-apis-data-rdb.md) - [@ohos.settings (设置数据项名称)](js-apis-settings.md) - data/rdb/[resultSet (结果集)](js-apis-data-resultset.md) - - 文件管理 - [@ohos.document (文件交互)](js-apis-document.md) @@ -125,7 +113,6 @@ - [@ohos.statfs (statfs)](js-apis-statfs.md) - [@ohos.storageStatistics (应用空间统计)](js-apis-storage-statistics.md) - [@ohos.volumeManager (卷管理)](js-apis-volumemanager.md) - - 电话服务 - [@ohos.contact (联系人)](js-apis-contact.md) @@ -135,14 +122,12 @@ - [@ohos.telephony.sim (SIM卡管理)](js-apis-sim.md) - [@ohos.telephony.sms (短信服务)](js-apis-sms.md) - [@ohos.telephony.data (蜂窝数据)](js-apis-telephony-data.md) - - 网络管理 - [@ohos.net.connection (网络连接管理)](js-apis-net-connection.md) - [@ohos.net.http (数据请求)](js-apis-http.md) - [@ohos.request (上传下载)](js-apis-request.md) - [@ohos.net.socket (Socket连接)](js-apis-socket.md) - [@ohos.net.webSocket (WebSocket连接)](js-apis-webSocket.md) - - 通信与连接 - [@ohos.bluetooth (蓝牙)](js-apis-bluetooth.md) @@ -150,7 +135,6 @@ - [@ohos.rpc (RPC通信)](js-apis-rpc.md) - [@ohos.wifi (WLAN)](js-apis-wifi.md) - [@ohos.wifiext (WLAN)](js-apis-wifiext.md) - - 系统基础能力 - [@ohos.accessibility (辅助功能)](js-apis-accessibility.md) @@ -168,7 +152,6 @@ - [@ohos.systemTime (设置系统时间)](js-apis-system-time.md) - [@ohos.wallpaper (壁纸)](js-apis-wallpaper.md) - [Timer (定时器)](js-apis-timer.md) - - 设备管理 - [@ohos.batteryInfo (电量信息)](js-apis-battery-info.md) @@ -188,13 +171,11 @@ - [@ohos.update (升级)](js-apis-update.md) - [@ohos.usb (USB管理)](js-apis-usb.md) - [@ohos.vibrator (振动)](js-apis-vibrator.md) - - 帐号管理 - [@ohos.account.appAccount (应用帐号管理)](js-apis-appAccount.md) - [@ohos.account.distributedAccount (分布式帐号管理)](js-apis-distributed-account.md) - [@ohos.account.osAccount (系统帐号管理)](js-apis-osAccount.md) - - 语言基础类库 - [@ohos.convertxml (xml转换JavaScript)](js-apis-convertxml.md) @@ -218,11 +199,9 @@ - [@ohos.util.Vector (线性容器Vector)](js-apis-vector.md) - [@ohos.worker (启动一个Worker)](js-apis-worker.md) - [@ohos.xml (xml解析与生成)](js-apis-xml.md) - - 测试 - [@ohos.application.testRunner (TestRunner)](js-apis-testRunner.md) - [@ohos.uitest (UiTest)](js-apis-uitest.md) - - 已停止维护的接口 - [@ohos.bytrace (性能打点)](js-apis-bytrace.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md deleted file mode 100644 index 108dc8e016b3df2a7815089a11b079c30d5e47f2..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md +++ /dev/null @@ -1,352 +0,0 @@ -# DataShareExtensionAbility - -- [导入模块](#导入模块) -- [属性](#属性) - - - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - - -类的数据共享扩展能力。 - - -## 导入模块 - - -``` -import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility'; -``` - -## 属性 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -| 名称 | 可读 | 可写 | 参数类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -------- | -| context | 是 | 否 | ExtensionContext | 否 | 指示数据共享扩展能力上下文。| - - -## DataShareExtensionAbility.onCreate - -onCreate?(want: Want): void; - -在启动数据共享扩展功能进行初始化时回调。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | Want | 是 | want表示有关数据共享扩展功能的连接信息。| - -**示例：** - - ```js - class myAbility extends DataShareExtensionAbility { - onCreate(want) { - console.log('onCreate, want:' + want.abilityName); - } - } - ``` - -## DataShareExtensionAbility.getFileTypes - -getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void - -获取支持的文件的MIME类型（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------------- | ------------------------------ | ---- | ---------------------------------- | -| uri | string | 是 | 指示要获取的文件的路径。 | -| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | -| callback | AsyncCallback\> | 是 | 回调方法，返回匹配的MIME类型数组。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getFileTypes( - "dataability:///com.example.DataAbility", - "image/*", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.insert - -insert?(uri: string, valueBucket: rdb.ValuesBucket, callback: AsyncCallback\): void - -将单个数据记录插入数据库（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ------------ | ---------------------- | ---- | ------------------------------------------------------ | -| uri | string | 是 | 指示要插入的数据的路径。 | -| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回插入数据记录的索引。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const valueBucket = { - "name": "rose", - "age": 22, - "salary": 200.5, - "blobType": u8, -} -DAHelper.insert( - "dataability:///com.example.DataAbility", - valueBucket, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.update - -update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -更新数据库中的数据记录（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要更新的数据的路径。 | -| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | -| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回更新的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataability' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -const va = { - "name": "roe1", - "age": 21, - "salary": 20.5, - "blobType": u8, -} -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.update( - "dataability:///com.example.DataAbility", - va, - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.delete - -delete?(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -从数据库中删除一个或多个数据记录（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ------------ | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要删除的数据的路径。 | -| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | -| callback | AsyncCallback\ | 是 | 回调方法。返回已删除的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataability' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.delete( - "dataability:///com.example.DataAbility", - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.query - -query?(uri: string, columns: Array\, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void - -查询数据库中的数据（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---------- | --------------------------------- | ---- | ------------------------------------------------ | -| uri | string | 是 | 指示要查询的数据的路径。 | -| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 | -| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回查询结果。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -import ohos_data_ability from '@ohos.data.dataability' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars=new Array("value1", "value2", "value3", "value4"); -let da = new ohos_data_ability.DataAbilityPredicates() -DAHelper.query( - "dataability:///com.example.DataAbility", - cars, - da, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.getType - -getType?(uri: string, callback: AsyncCallback\): void - -获取给定URI指定数据的MIME类型（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | --------------------------------------------- | -| uri | string | 是 | 指示要操作的数据的路径。 | -| callback | AsyncCallback\ | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.getType( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.batchInsert - -batchInsert?(uri: string, valueBuckets: Array, callback: AsyncCallback\): void - -插入数据库（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ------------ | ----------------------- | ---- | -------------------------------- | -| uri | string | 是 | 指示要插入的数据的路径。 | -| valuesBucket | Array | 是 | 指示要插入的数据记录。 | -| callback | AsyncCallback\ | 是 | 回调方法。返回插入的数据记录数。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,}, - {"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,}, - {"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,}) -DAHelper.batchInsert( - "dataability:///com.example.DataAbility", - cars, - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.normalizeUri - -normalizeUri?(uri: string, callback: AsyncCallback\): void - -将引用数据功能的给定uri转换为规范化uri（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | ------------------------------------------------------------ | -| uri | string | 是 | 指示要规范化的uri对象。 | -| callback | AsyncCallback\ | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.normalizeUri( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` - -## DataShareExtensionAbility.denormalizeUri - -denormalizeUri?(uri: string, callback: AsyncCallback\): void - -将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。 - -**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | --------------------------------------------------- | -| uri | string | 是 | 指示要规范化的uri对象。 | -| callback | AsyncCallback\ | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 | - -**示例：** - -```js -import featureAbility from '@ohos.ability.featureAbility' -var DAHelper = featureAbility.acquireDataAbilityHelper( - "dataability:///com.example.DataAbility" -); -DAHelper.denormalizeUri( - "dataability:///com.example.DataAbility", - (err, data) => { - console.info("==========================>Called=======================>"); -}); -``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index df834dddcca95d853221711878b045e13c46c8a0..b7678bac77529d84a3ea70772a1c64a17c45c87b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -488,7 +488,7 @@ try { ``` -### on8+ ### +### on('distributedDataServiceDie')8+ ### on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void @@ -500,7 +500,7 @@ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): voi | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | +| event | string | 是 | 订阅的事件名，固定为'distributedDataServiceDie'，即服务状态变更事件。 | | deathCallback | Callback<void> | 是 | 回调函数，在设备状态改变时获取通知。 | **示例** @@ -520,7 +520,7 @@ try { ``` -### off8+ ### +### off('distributedDataServiceDie')8+ ### off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): void @@ -532,7 +532,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | +| event | string | 是 | 取消订阅的事件名，固定为'distributedDataServiceDie'，即服务状态变更事件。 | | deathCallback | Callback<void> | 否 | 回调函数，取消设备状态改变时获取通知。 | @@ -571,7 +571,7 @@ try { ## KVStoreType -用于指定创建的数据库的类型。 +用于指定创建的数据库类型。 **系统能力**：以下各项对应的系统能力均为 SystemCapability.DistributedDataManager.KVStore.Core。 @@ -2220,7 +2220,7 @@ try { ``` -### on +### on('dataChange') on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void @@ -2232,7 +2232,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotific | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'dataChange' | 是 |回调函数名称。
'dataChange'表示数据变更事件。 | +| event |string | 是 |订阅的事件名，固定为'dataChange'，表示数据变更事件。 | | type |[SubscribeType](#subscribetype) | 是 |表示订阅的类型。 | | observer |Callback<[ChangeNotification](#changenotification)> | 是 |回调函数。 | @@ -2246,7 +2246,7 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun ``` -### on +### on('syncComplete') on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void @@ -2258,7 +2258,7 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'syncComplete' | 是 |回调函数名称。
'syncComplete'表示同步完成事件。 | +| event |string | 是 |订阅的事件名，固定为'syncComplete'，表示同步完成事件。 | | syncCallback |Callback<Array<[string, number]>> | 是 |回调函数。 | **示例** @@ -2270,7 +2270,7 @@ kvStore.on('syncComplete', function (data) { }); ``` -### off8+ +### off('dataChange')8+ off(event:'dataChange', observer?: Callback<ChangeNotification>): void @@ -2282,7 +2282,7 @@ off(event:'dataChange', observer?: Callback<ChangeNotification>): void | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'dataChange' | 是 |回调函数名称。
'dataChange'表示数据变更事件。 | +| event |string | 是 |取消订阅的事件名，固定为'dataChange'，表示数据变更事件。 | | observer |Callback<[ChangeNotification](#changenotification)> |否 |回调函数。 | **示例** @@ -3695,7 +3695,7 @@ try { ``` -### on8+ ### +### on('syncComplete')8+ ### on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void @@ -3707,12 +3707,12 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| event |string | 是 |订阅的事件名，固定为'syncComplete'，表示同步完成事件。 | | syncCallback |Callback<Array<[string, number]>> | 是 |用于向调用方发送同步结果的回调。 | **示例** -``` +```js let kvStore; const KEY_TEST_FLOAT_ELEMENT = 'key_test_float'; const VALUE_TEST_FLOAT_ELEMENT = 321.12; @@ -3731,7 +3731,7 @@ try { ``` -### off8+ ### +### off('syncComplete')8+ ### off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void @@ -3743,7 +3743,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]& | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| event |string | 是 |取消订阅的事件名，固定为'syncComplete'，表示同步完成事件。 | | syncCallback |Callback<Array<[string, number]>> | 否 |用于向调用方发送同步结果的回调。 | **示例** @@ -5052,7 +5052,7 @@ try { } ``` -### on8+ ### +### on('syncComplete')8+ ### on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void @@ -5064,8 +5064,8 @@ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'syncComplete' | 是 |同步完成时触发的事件名。 | -| syncCallback |Callback | 是 |用于向调用方发送同步结果的回调。 | **示例** @@ -5087,7 +5087,7 @@ try { ``` -### off8+ ### +### off('syncComplete')8+ ### off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void @@ -5099,7 +5099,7 @@ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]& | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| event |'syncComplete' | 是 |同步完成时触发的事件名。 | +| event |string | 是 |取消订阅的事件名，固定为'syncComplete'，表示同步完成事件。 | | syncCallback |Callback