diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index 322ef9541956a428f36cb624f10f05d4df804bd6..3d7947be85a49718f2288d7c2d776853d7451bc9 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -200,6 +200,7 @@ - [@ohos.data.dataSharePredicates](js-apis-data-dataSharePredicates.md) - [@ohos.data.dataShareResultSet](js-apis-data-DataShareResultSet.md) - [@ohos.data.distributedDataObject](js-apis-data-distributedobject.md) + - [@ohos.data.distributedKVStore](js-apis-distributedKVStore.md) - [@ohos.data.preferences](js-apis-data-preferences.md) - [@ohos.data.rdb](js-apis-data-rdb.md) - [@ohos.data.ValuesBucket](js-apis-data-ValuesBucket.md) @@ -288,6 +289,7 @@ - [@ohos.runningLock](js-apis-runninglock.md) - [@ohos.sensor](js-apis-sensor.md) - [@ohos.settings](js-apis-settings.md) + - [@ohos.stationary](js-apis-stationary.md) - [@ohos.systemParameterV9](js-apis-system-parameterV9.md) - [@ohos.thermal](js-apis-thermal.md) - [@ohos.update](js-apis-update.md) @@ -342,7 +344,6 @@ - [@ohos.reminderAgent](js-apis-reminderAgent.md) - [@ohos.systemParameter](js-apis-system-parameter.md) - [@ohos.usb](js-apis-usb-deprecated.md) - - [@ohos.workScheduler](js-apis-workScheduler.md) - [@system.app](js-apis-system-app.md) - [@system.battery](js-apis-system-battery.md) - [@system.bluetooth](js-apis-system-bluetooth.md) diff --git a/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md b/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md index c03f26ef70644a43ec969a5288843838b266f883..49032dcbd7b58a404bd779635fc109a5f2336c38 100644 --- a/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md +++ b/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md @@ -1,4 +1,4 @@ -# Background Task Management +# @ohos.backgroundTaskManager (Background Task Management) The **BackgroundTaskManager** module provides APIs to manage background tasks. @@ -161,7 +161,7 @@ Requests a continuous task from the system. This API uses an asynchronous callba | Name | Type | Mandatory | Description | | --------- | ---------------------------------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | bgMode | [BackgroundMode](#backgroundmode8) | Yes | Background mode requested. | | wantAgent | [WantAgent](js-apis-wantAgent.md) | Yes | Notification parameter, which is used to specify the target page that is redirected to when a continuous task notification is clicked. | | callback | AsyncCallback<void> | Yes | Callback used to return the result. | @@ -253,7 +253,7 @@ Requests a continuous task from the system. This API uses a promise to return th | Name | Type | Mandatory | Description | | --------- | ---------------------------------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | bgMode | [BackgroundMode](#backgroundmode8) | Yes | Background mode requested. | | wantAgent | [WantAgent](js-apis-wantAgent.md) | Yes | Notification parameter, which is used to specify the target page that is redirected to when a continuous task notification is clicked. | @@ -339,7 +339,7 @@ Requests to cancel a continuous task. This API uses an asynchronous callback to | Name | Type | Mandatory | Description | | -------- | ------------------------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example** @@ -395,7 +395,7 @@ Requests to cancel a continuous task. This API uses a promise to return the resu | Name | Type | Mandatory | Description | | ------- | ------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| **Return value** @@ -452,14 +452,14 @@ Provides the information about the suspension delay. **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask -| Name | Description | -| ----------------------- | --------------------- | -| DATA_TRANSFER | Data transfer. | -| AUDIO_PLAYBACK | Audio playback. | -| AUDIO_RECORDING | Audio recording. | -| LOCATION | Positioning and navigation. | -| BLUETOOTH_INTERACTION | Bluetooth-related task. | -| MULTI_DEVICE_CONNECTION | Multi-device connection. | -| WIFI_INTERACTION | WLAN-related (system API).| -| VOIP | Audio and video calls (system API). | -| TASK_KEEPING | Computing task (effective only for specific devices). | +| Name | Value | Description | +| ----------------------- | ---- | --------------------- | +| DATA_TRANSFER | 1 | Data transfer. | +| AUDIO_PLAYBACK | 2 | Audio playback. | +| AUDIO_RECORDING | 3 | Audio recording. | +| LOCATION | 4 | Positioning and navigation. | +| BLUETOOTH_INTERACTION | 5 | Bluetooth-related task. | +| MULTI_DEVICE_CONNECTION | 6 | Multi-device connection. | +| WIFI_INTERACTION | 7 | WLAN-related.
This is a system API.| +| VOIP | 8 | Audio and video calls.
This is a system API. | +| TASK_KEEPING | 9 | Computing task (effective only for specific devices). | diff --git a/en/application-dev/reference/apis/js-apis-configPolicy.md b/en/application-dev/reference/apis/js-apis-configPolicy.md index 4e541cbfe0022219d9ebf57b0502e82984c84384..af8d2ba8f5fa0aa614d55205d176ce49132f9068 100644 --- a/en/application-dev/reference/apis/js-apis-configPolicy.md +++ b/en/application-dev/reference/apis/js-apis-configPolicy.md @@ -1,4 +1,4 @@ -# Configuration Policy +# @ohos.configPolicy (Configuration Policy) The **configPolicy** module provides APIs for obtaining the custom configuration directory and file path based on the predefined custom configuration level. @@ -24,6 +24,7 @@ For example, if the **config.xml** file is stored in **/system/etc/config.xml** **System capability**: SystemCapability.Customization.ConfigPolicy **Parameters** + | Name | Type | Mandatory | Description | | -------- | --------------------------- | ---- | --------------------- | | relPath | string | Yes | Name of the configuration file. | @@ -50,11 +51,13 @@ Obtains the path of a configuration file with the specified name and highest pri **System capability**: SystemCapability.Customization.ConfigPolicy **Parameters** + | Name | Type | Mandatory | Description | | ------- | ------ | ---- | ----- | | relPath | string | Yes | Name of the configuration file.| **Return value** + | Type | Description | | --------------------- | ------------ | | Promise<string> | Promise used to return the path of the configuration file.| @@ -79,6 +82,7 @@ For example, if the **config.xml** file is stored in **/system/etc/config.xml** **System capability**: SystemCapability.Customization.ConfigPolicy **Parameters** + | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------- | | relPath | string | Yes | Name of the configuration file. | @@ -105,11 +109,13 @@ Obtains a list of configuration files with the specified name, sorted in ascendi **System capability**: SystemCapability.Customization.ConfigPolicy **Parameters** + | Name | Type | Mandatory | Description | | ------- | ------ | ---- | ----- | | relPath | string | Yes | Name of the configuration file.| **Return value** + | Type | Description | | ---------------------------------- | ---- | | Promise<Array<string>> | Promise used to return the file list.| @@ -133,6 +139,7 @@ Obtains the list of configuration level directories. This API uses an asynchrono **System capability**: SystemCapability.Customization.ConfigPolicy **Parameters** + | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ----------------- | | callback | AsyncCallback<Array<string>> | Yes | Callback used to return the configuration level directory list.| @@ -158,6 +165,7 @@ Obtains the list of configuration level directories. This API uses a promise to **System capability**: SystemCapability.Customization.ConfigPolicy **Return value** + | Type | Description | | ---------------------------------- | -------- | | Promise<Array<string>> | Promise used to return the configuration level directory list.| diff --git a/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md b/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md index 8944052b4fed8899733d3cf924479ddc4359fc7e..03645ac62b8ec51c616fbfd6e923aef203a52ad6 100644 --- a/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md +++ b/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md @@ -1,4 +1,4 @@ -# Background Task Management +# @ohos.resourceschedule.backgroundTaskManager (Background Task Management) The **BackgroundTaskManager** module provides APIs to manage background tasks. @@ -234,7 +234,7 @@ Requests a continuous task from the system. This API uses an asynchronous callba | Name | Type | Mandatory | Description | | --------- | ---------------------------------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | bgMode | [BackgroundMode](#backgroundmode) | Yes | Background mode requested. | | wantAgent | [WantAgent](js-apis-wantAgent.md) | Yes | Notification parameter, which is used to specify the target page that is redirected to when a continuous task notification is clicked. | | callback | AsyncCallback<void> | Yes | Callback used to return the result. | @@ -308,7 +308,7 @@ Requests a continuous task from the system. This API uses a promise to return th | Name | Type | Mandatory | Description | | --------- | ---------------------------------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | bgMode | [BackgroundMode](#backgroundmode) | Yes | Background mode requested. | | wantAgent | [WantAgent](js-apis-wantAgent.md) | Yes | Notification parameter, which is used to specify the target page that is redirected to when a continuous task notification is clicked. | @@ -381,7 +381,7 @@ Requests to cancel a continuous task. This API uses an asynchronous callback to | Name | Type | Mandatory | Description | | -------- | ------------------------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Error codes** @@ -437,7 +437,7 @@ Requests to cancel a continuous task. This API uses a promise to return the resu | Name | Type | Mandatory | Description | | ------- | ------- | ---- | ---------------------------------------- | -| context | Context | Yes | Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| +| context | Context | Yes | Application context.
For details about the application context of the FA model, see [Context](js-apis-inner-app-context.md).
For details about the application context of the stage model, see [Context](js-apis-ability-context.md).| **Return value** @@ -618,12 +618,12 @@ Enumerates the efficiency resource types. **System API**: This is a system API. -| Name | Description | -| ----------------------- | --------------------- | -| CPU | CPU resources, which prevent the application from being suspended. | -| COMMON_EVENT | A type of software resources, which prevent common events from being proxied when the application is suspended. | -| TIMER | A type of software resources, which prevent timers from being proxied when the application is suspended. | -| WORK_SCHEDULER | WORK_SCHEDULER resources, which ensure that the application has more time to execute the task. | -| BLUETOOTH | A type of hardware resources, which prevent Bluetooth resources from being proxied when the application is suspended. | -| GPS | A type of hardware resources, which prevent GPS resources from being proxied when the application is suspended. | -| AUDIO | A type of hardware resources, which prevent audio resources from being proxied when the application is suspended.| +| Name | Value | Description | +| ----------------------- | ---- | --------------------- | +| CPU | 1 | CPU resources, which prevent the application from being suspended. | +| COMMON_EVENT | 2 | A type of software resources, which prevent common events from being proxied when the application is suspended. | +| TIMER | 4 | A type of software resources, which prevent timers from being proxied when the application is suspended. | +| WORK_SCHEDULER | 8 | WORK_SCHEDULER resources, which ensure that the application has more time to execute the task. | +| BLUETOOTH | 16 | A type of hardware resources, which prevent Bluetooth resources from being proxied when the application is suspended. | +| GPS | 32 | A type of hardware resources, which prevent GPS resources from being proxied when the application is suspended. | +| AUDIO | 64 | A type of hardware resources, which prevent audio resources from being proxied when the application is suspended.| diff --git a/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md b/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md index e62f6ca72f897772a8c98f21d14aaf18e398f575..77638dbfe38acf986f1b632349253c9ceb9496ed 100644 --- a/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md +++ b/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md @@ -1,4 +1,4 @@ -# Work Scheduler +# @ohos.resourceschedule.workScheduler The **workScheduler** module provides the APIs for registering, canceling, and querying Work Scheduler tasks, which do not have real-time constraints. @@ -437,45 +437,45 @@ Enumerates the network types that can trigger the task. **System capability**: SystemCapability.ResourceSchedule.WorkScheduler -| Name | Description | -| ---------------------- | ----------------------- | -| NETWORK_TYPE_ANY | Any network type. | -| NETWORK_TYPE_MOBILE | Mobile network. | -| NETWORK_TYPE_WIFI | Wi-Fi network. | -| NETWORK_TYPE_BLUETOOTH | Bluetooth network.| -| NETWORK_TYPE_WIFI_P2P | Wi-Fi P2P network. | -| NETWORK_TYPE_ETHERNET | Ethernet. | +| Name | Value | Description | +| ---------------------- | ---- | ----------------------- | +| NETWORK_TYPE_ANY | 0 | Any network type. | +| NETWORK_TYPE_MOBILE | 1 | Mobile network. | +| NETWORK_TYPE_WIFI | 2 | Wi-Fi network. | +| NETWORK_TYPE_BLUETOOTH | 3 | Bluetooth network.| +| NETWORK_TYPE_WIFI_P2P | 4 | Wi-Fi P2P network. | +| NETWORK_TYPE_ETHERNET | 5 | Ethernet. | ## ChargingType Enumerates the charging types that can trigger the task. **System capability**: SystemCapability.ResourceSchedule.WorkScheduler -| Name | Description | -| ------------------------- | -------------------- | -| CHARGING_PLUGGED_ANY | Any charging type.| -| CHARGING_PLUGGED_AC | DC charging. | -| CHARGING_PLUGGED_USB | USB charging. | -| CHARGING_PLUGGED_WIRELESS | Wireless charging. | +| Name | Value | Description | +| ------------------------- | ---- | -------------------- | +| CHARGING_PLUGGED_ANY | 0 | Any charging type.| +| CHARGING_PLUGGED_AC | 1 | DC charging. | +| CHARGING_PLUGGED_USB | 2 | USB charging. | +| CHARGING_PLUGGED_WIRELESS | 3 | Wireless charging. | ## BatteryStatus Enumerates the battery states that can trigger the task. **System capability**: SystemCapability.ResourceSchedule.WorkScheduler -| Name | Description | -| -------------------------- | -------------------------- | -| BATTERY_STATUS_LOW | A low battery alert is displayed. | -| BATTERY_STATUS_OKAY | The battery level is restored from low to normal. | -| BATTERY_STATUS_LOW_OR_OKAY | The battery level is restored from low to normal, or a low battery alert is displayed.| +| Name | Value | Description | +| -------------------------- | ---- | -------------------------- | +| BATTERY_STATUS_LOW | 0 | A low battery alert is displayed. | +| BATTERY_STATUS_OKAY | 1 | The battery level is restored from low to normal. | +| BATTERY_STATUS_LOW_OR_OKAY | 2 | The battery level is restored from low to normal, or a low battery alert is displayed.| ## StorageRequest Enumerates the storage states that can trigger the task. **System capability**: SystemCapability.ResourceSchedule.WorkScheduler -| Name | Description | -| ------------------------- | ------------------------------ | -| STORAGE_LEVEL_LOW | The storage space is insufficient. | -| STORAGE_LEVEL_OKAY | The storage space is restored from insufficient to normal. | -| STORAGE_LEVEL_LOW_OR_OKAY | The storage space is restored from insufficient to normal, or the storage space is insufficient.| +| Name | Value | Description | +| ------------------------- | ---- | ------------------------------ | +| STORAGE_LEVEL_LOW | 0 | The storage space is insufficient. | +| STORAGE_LEVEL_OKAY | 1 | The storage space is restored from insufficient to normal. | +| STORAGE_LEVEL_LOW_OR_OKAY | 2 | The storage space is restored from insufficient to normal, or the storage space is insufficient.| diff --git a/en/application-dev/reference/apis/js-apis-stationary.md b/en/application-dev/reference/apis/js-apis-stationary.md new file mode 100644 index 0000000000000000000000000000000000000000..ceae25ac4c711e8dd3664520290fda7b897c9ae9 --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-stationary.md @@ -0,0 +1,130 @@ +# @ohos.stationary (Device Status Awareness Framework) + +The **stationary** module provides APIs to report the device status, including absolute still and relative still. + +> **NOTE** +> +> The initial 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. + +## Modules to Import + +```js +import stationary from '@ohos.stationary' +``` + +## ActivityResponse + +Defines the response interface to receive the device status. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +### Attributes + +| Name| Type| Readable| Writable| Description| +| -------- | -------- | -------- | -------- | -------- | +| state | [ActivityState](#activitystate) | Yes| No| New device status.| + +## ActivityType + +Enumerates the device status types. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +| Name| Description| +| -------- | -------- | +| still | Absolutely still.| +| relativeStill | Relatively still.| + +## ActivityEvent + +Enumerates the device status events. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +| Name | Value | Description | +| ------------------------------ | ---- | ---------------------------------------- | +| ENTER | 1 | Event indicating entering device status. | +| EXIT | 2 | Event indicating exiting device status.| +| ENTER_EXIT | 3 | Event indicating entering and exiting device status.| + +## ActivityState + +Enumerates the device statuses. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +| Name | Value | Description | +| ------------------------------ | ---- | ---------------------------------------- | +| ENTER | 1 | Entering device status. | +| EXIT | 2 | Exiting device status.| + +## stationary.on('still' | 'relativeStill') + +on(activity: ActivityType, event: ActivityEvent, reportLatencyNs: number, callback: Callback<ActivityResponse>): void + +Subscribes to the device status. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------------------- | -------------------------------------------------- | ---- | ---------------------------- | +| activity | [ActivityType](#activitytype) | Yes | Device status type. | +| event | [ActivityEvent](#activityevent) | Yes | Event type. | +| reportLatencyNs | number | Yes | Event reporting period. | +| callback | Callback<[ActivityResponse](#activityresponse)\> | Yes | Callback used to receive reported data. | + +**Example** + +```js +var reportLatencyNs = 100; +stationary.on('still', stationary.ActivityEvent.ENTER, reportLatencyNs, (data) => { + console.log('data='+ JSON.stringify(data)); +}) +``` + +## stationary.once('still' | 'relativeStill') + +once(activity: ActivityType, callback: Callback<ActivityResponse>): void + +Obtains the device status. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------------------- | -------------------------------------------------- | ---- | ---------------------------- | +| activity | [ActivityType](#activitytype) | Yes | Device status type. | +| callback | Callback<[ActivityResponse](#activityresponse)\> | Yes | Callback used to receive reported data. | + +**Example** + +```js +stationary.once('still', (data) => { + console.log("data="+ JSON.stringify(data)); +}) +``` + +## stationary.off('still' | 'relativeStill') + +off(activity: ActivityType, event: ActivityEvent, callback?: Callback<ActivityResponse>): void + +Unsubscribes from the device status. + +**System capability**: SystemCapability.Msdp.DeviceStatus.Stationary + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------------------- | -------------------------------------------------- | ---- | ---------------------------- | +| activity | [ActivityType](#activitytype) | Yes | Device status type. | +| event | [ActivityEvent](#activityevent) | Yes | Event type. | +| callback | Callback<[ActivityResponse](#activityresponse)\> | No | Callback used to receive reported data. | + +**Example** + +```js +stationary.off('still', stationary.ActivityEvent.ENTER); +``` diff --git a/en/application-dev/reference/apis/js-apis-workScheduler.md b/en/application-dev/reference/apis/js-apis-workScheduler.md deleted file mode 100644 index d897bc91717348ee8addd00751741f83cc77c345..0000000000000000000000000000000000000000 --- a/en/application-dev/reference/apis/js-apis-workScheduler.md +++ /dev/null @@ -1,361 +0,0 @@ -# Work Scheduler - -The **workScheduler** module provides the APIs for registering, canceling, and querying Work Scheduler tasks, which do not have real-time constraints. - -The system executes Work Scheduler tasks at an appropriate time, subject to the storage space, power consumption, temperature, and more. - -> **NOTE** -> -> - The initial 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. -> - The APIs of this module can be used only in the stage model. -> - For details about the constraints on the Work Scheduler usage, see [Work Scheduler Overview](../../task-management/work-scheduler-overview.md). - - -## Modules to Import - -```js -import workScheduler from '@ohos.workScheduler'; -``` - -## workScheduler.startWork -startWork(work: WorkInfo): boolean - -Instructs the **WorkSchedulerService** to add the specified task to the execution queue. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| ---- | --------------------- | ---- | -------------- | -| work | [WorkInfo](#workinfo) | Yes | Task to be added to the execution queue.| - -**Return value** - -| Type | Description | -| ------- | -------------------------------- | -| boolean | Returns **true** if the task is added to the execution queue; returns **false** otherwise.| - -**Example** - -```js - let workInfo = { - workId: 1, - batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, - isRepeat: false, - isPersisted: true, - bundleName: "com.example.myapplication", - abilityName: "MyExtension", - parameters: { - mykey0: 1, - mykey1: "string value", - mykey2: true, - mykey3: 1.5 - } - } - var res = workScheduler.startWork(workInfo); - console.info(`workschedulerLog res: ${res}`); -``` - -## workScheduler.stopWork -stopWork(work: WorkInfo, needCancel?: boolean): boolean - -Instructs the **WorkSchedulerService** to stop the specified task. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| ---------- | --------------------- | ---- | ---------- | -| work | [WorkInfo](#workinfo) | Yes | Task to stop. | -| needCancel | boolean | Yes | Whether to cancel the task.| - -**Return value** - -| Type | Description | -| ------- | ----------------------- | -| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| - -**Example** - -```js - let workInfo = { - workId: 1, - batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, - isRepeat: false, - isPersisted: true, - bundleName: "com.example.myapplication", - abilityName: "MyExtension", - parameters: { - mykey0: 1, - mykey1: "string value", - mykey2: true, - mykey3: 1.5 - } - } - var res = workScheduler.stopWork(workInfo, false); - console.info(`workschedulerLog res: ${res}`); -``` - -## workScheduler.getWorkStatus -getWorkStatus(workId: number, callback : AsyncCallback\): void - -Obtains the latest task status. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| -------- | ------------------------------------- | ---- | ---------------------------------------- | -| workId | number | Yes | Task ID. | -| callback | AsyncCallback\<[WorkInfo](#workinfo)> | Yes | Callback used to return the result. Returns the task status obtained from the **WorkSchedulerService** if the specified task ID is valid; returns **null** otherwise.| - -**Example** - -```js - workScheduler.getWorkStatus(50, (err, res) => { - if (err) { - console.info(`workschedulerLog getWorkStatus failed, because: ${err.code}`); - } else { - for (let item in res) { - console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`); - } - } - }); -``` - -## workScheduler.getWorkStatus -getWorkStatus(workId: number): Promise\ - -Obtains the latest task status. This API uses a promise to return the result. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| ------ | ------ | ---- | -------- | -| workId | number | Yes | Task ID.| - -**Return value** - -| Type | Description | -| ------------------------------- | ---------------------------------------- | -| Promise\<[WorkInfo](#workinfo)> | Promise used to return the result. Returns the task status obtained from the **WorkSchedulerService** if the specified task ID is valid; returns **null** otherwise.| - -**Example** - -```js - workScheduler.getWorkStatus(50).then((res) => { - for (let item in res) { - console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`); - } - }).catch((err) => { - console.info(`workschedulerLog getWorkStatus failed, because: ${err.code}`); - }) -``` - -## workScheduler.obtainAllWorks -obtainAllWorks(callback : AsyncCallback\): Array\ - -Obtains all tasks associated with this application. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| -------- | -------------------- | ---- | ------------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return all tasks associated with the current application. | - -**Return value** - -| Type | Description | -| ----------------------------- | --------------- | -| Array\<[WorkInfo](#workinfo)> | All tasks associated with the current application.| - -**Example** - -```js - workScheduler.obtainAllWorks((err, res) =>{ - if (err) { - console.info(`workschedulerLog obtainAllWorks failed, because: ${err.code}`); - } else { - console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`); - } - }); -``` - -## workScheduler.obtainAllWorks -obtainAllWorks(): Promise> - -Obtains all tasks associated with this application. This API uses a promise to return the result. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Return value** - -| Type | Description | -| -------------------------------------- | ------------------------------ | -| Promise> | Promise used to return all tasks associated with the current application. | - -**Example** - -```js - workScheduler.obtainAllWorks().then((res) => { - console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`); - }).catch((err) => { - console.info(`workschedulerLog obtainAllWorks failed, because: ${err.code}`); - }) -``` - -## workScheduler.stopAndClearWorks -stopAndClearWorks(): boolean - -Stops and cancels all tasks associated with the current application. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Example** - -```js - let res = workScheduler.stopAndClearWorks(); - console.info(`workschedulerLog res: ${res}`); -``` - -## workScheduler.isLastWorkTimeOut -isLastWorkTimeOut(workId: number, callback : AsyncCallback\): boolean - -Checks whether the last execution of the specified task timed out. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| -------- | -------------------- | ---- | ---------------------------------------- | -| workId | number | Yes | Task ID. | -| callback | AsyncCallback\ | Yes | Callback used to return the result. Returns **true** if the last execution of the specified task timed out; returns **false** otherwise.| - -**Return value** - -| Type | Description | -| ------- | ---------------------------------------- | -| boolean | Callback used to return the result. Returns **true** if the last execution of the specified task timed out; returns **false** otherwise.| - -**Example** - -```js - workScheduler.isLastWorkTimeOut(500, (err, res) =>{ - if (err) { - console.info(`workschedulerLog isLastWorkTimeOut failed, because: ${err.code}`); - } else { - console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`); - } - }); -``` - -## workScheduler.isLastWorkTimeOut -isLastWorkTimeOut(workId: number): Promise\ - -Checks whether the last execution of the specified task timed out. This API uses a promise to return the result. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -**Parameters** - -| Name | Type | Mandatory | Description | -| ------ | ------ | ---- | -------- | -| workId | number | Yes | Task ID.| - -**Return value** - -| Type | Description | -| ----------------- | ---------------------------------------- | -| Promise\ | Promise used to return the result. Returns **true** if the last execution of the specified task timed out; returns **false** otherwise.| - -**Example** - -```js - workScheduler.isLastWorkTimeOut(500) - .then(res => { - console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`); - }) - .catch(err => { - console.info(`workschedulerLog isLastWorkTimeOut failed, because: ${err.code}`); - }); -``` - -## WorkInfo -Provides detailed information about the task. For details about the constraints on configuring **WorkInfo**, see [Work Scheduler Overview](../../task-management/work-scheduler-overview.md). - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -| Name | Type | Mandatory | Description | -| --------------- | --------------------------------- | ---- | ---------------- | -| workId | number | Yes | Task ID. | -| bundleName | string | Yes | Name of the Work Scheduler task bundle. | -| abilityName | string | Yes | Name of the component to be notified by a Work Scheduler callback.| -| networkType | [NetworkType](#networktype) | No | Network type. | -| isCharging | boolean | No | Whether the device is charging. | -| chargerType | [ChargingType](#chargingtype) | No | Charging type. | -| batteryLevel | number | No | Battery level. | -| batteryStatus | [BatteryStatus](#batterystatus) | No | Battery status. | -| storageRequest | [StorageRequest](#storagerequest) | No | Storage status. | -| isRepeat | boolean | No | Whether the task is repeated. | -| repeatCycleTime | number | No | Repeat interval. | -| repeatCount | number | No | Number of repeat times. | -| isPersisted | boolean | No | Whether to enable persistent storage for the task. | -| isDeepIdle | boolean | No | Whether the device needs to enter the idle state. | -| idleWaitTime | number | No | Time to wait in the idle state. | -| parameters | {[key: string]: any} | No | Carried parameters. | - -## NetworkType -Enumerates the network types that can trigger the task. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -| Name | Default Value | Description | -| ---------------------- | ---- | ----------------------- | -| NETWORK_TYPE_ANY | 0 | Any network type. | -| NETWORK_TYPE_MOBILE | 1 | Mobile network. | -| NETWORK_TYPE_WIFI | 2 | Wi-Fi network. | -| NETWORK_TYPE_BLUETOOTH | 3 | Bluetooth network.| -| NETWORK_TYPE_WIFI_P2P | 4 | Wi-Fi P2P network. | -| NETWORK_TYPE_ETHERNET | 5 | Ethernet. | - -## ChargingType -Enumerates the charging types that can trigger the task. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -| Name | Default Value | Description | -| ------------------------- | ---- | -------------------- | -| CHARGING_PLUGGED_ANY | 0 | Any charging type.| -| CHARGING_PLUGGED_AC | 1 | DC charging. | -| CHARGING_PLUGGED_USB | 2 | USB charging. | -| CHARGING_PLUGGED_WIRELESS | 3 | Wireless charging. | - -## BatteryStatus -Enumerates the battery states that can trigger the task. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -| Name | Default Value | Description | -| -------------------------- | ---- | -------------------------- | -| BATTERY_STATUS_LOW | 0 | A low battery alert is displayed. | -| BATTERY_STATUS_OKAY | 1 | The battery level is restored from low to normal. | -| BATTERY_STATUS_LOW_OR_OKAY | 2 | The battery level is restored from low to normal, or a low battery alert is displayed.| - -## StorageRequest -Enumerates the storage states that can trigger the task. - -**System capability**: SystemCapability.ResourceSchedule.WorkScheduler - -| Name | Default Value | Description | -| ------------------------- | ---- | ------------------------------ | -| STORAGE_LEVEL_LOW | 0 | The storage space is insufficient. | -| STORAGE_LEVEL_OKAY | 1 | The storage space is restored from insufficient to normal. | -| STORAGE_LEVEL_LOW_OR_OKAY | 2 | The storage space is restored from insufficient to normal, or the storage space is insufficient.| diff --git a/en/application-dev/reference/errorcodes/Readme-EN.md b/en/application-dev/reference/errorcodes/Readme-EN.md index 16157622d51a7b8e0331202c363a3abaa1ab24a2..baad748a3276fa43a4c891ef531fa62f11598ee3 100644 --- a/en/application-dev/reference/errorcodes/Readme-EN.md +++ b/en/application-dev/reference/errorcodes/Readme-EN.md @@ -15,6 +15,7 @@ - [Window Error Codes](errorcode-window.md) - Media - [Audio Error Codes](errorcode-audio.md) + - [Media Error Codes](errorcode-media.md) - [AVSession Management Error Codes](errorcode-avsession.md) - Resource Management - [I18N Error Codes](errorcode-i18n.md) @@ -34,6 +35,12 @@ - [Upload and Download Error Codes](errorcode-request.md) - Basic Features - [FaultLogger Error Codes](errorcode-faultlogger.md) + - [Application Event Logging Error Codes](errorcode-hiappevent.md) + - [HiSysEvent Error Codes](errorcode-hisysevent.md) + - [HiDebug Error Codes](errorcode-hiviewdfx-hidebug.md) + - [Input Method Framework Error Codes](errorcode-inputmethod-framework.md) + - [Pasteboard Error Codes](errorcode-pasteboard.md) + - [Webview Error Codes](errorcode-webview.md) - Account Management - [Account Error Codes](errorcode-account.md) - [App Account Error Codes](errorcode-app-account.md) @@ -43,6 +50,7 @@ - [Sensor Error Codes](errorcode-sensor.md) - [Vibrator Error Codes](errorcode-vibrator.md) - [System Parameter Error Codes](errorcode-system-parameterV9.md) + - [USB Error Codes](errorcode-usb.md) - Language Base Class Library - [Buffer Error Codes](errorcode-buffer.md) - [containers Error Codes](errorcode-containers.md) diff --git a/en/application-dev/website.md b/en/application-dev/website.md index 9f4a69cf61b3e6967575bdfd8e60660b8481af19..8eb6c7e4ba47d1f1950a4c787ebf1481ef6e96f4 100644 --- a/en/application-dev/website.md +++ b/en/application-dev/website.md @@ -34,40 +34,38 @@ - [Ability Assistant Usage](ability/ability-assistant-guidelines.md) - [ContinuationManager Development](ability/continuationmanager.md) - [Test Framework Usage](ability/ability-delegator.md) + + + - UI Development - [ArkUI Overview](ui/arkui-overview.md) - ArkTS-based Declarative Development Paradigm - [Overview](ui/ui-ts-overview.md) - - Framework Overview - - File Organization - - [Directory Structure](ui/ts-framework-directory.md) - - [Rules for Accessing Application Code Files](ui/ts-framework-file-access-rules.md) - - Resource Management - - [Resource File Categories](ui/ui-ts-basic-resource-file-categories.md) - - [Accessing Resources](ui/ts-resource-access.md) - - [Pixel Units](ui/ts-pixel-units.md) - - Componentization - - [Initialization of Custom Components' Member Variables](ui/ts-custom-component-initialization.md) - - [Custom Component Lifecycle Callbacks](ui/ts-custom-component-lifecycle-callbacks.md) - - [Component Creation and Re-initialization](ui/ts-component-creation-re-initialization.md) - - Common Component Development Guidelines - - [Button](ui/ui-ts-basic-components-button.md) - - [Web](ui/ui-ts-components-web.md) - - Common Layout Development Guidelines - - [Flex Layout](ui/ui-ts-layout-flex.md) - - [Grid Layout](ui/ui-ts-layout-grid-container.md) - - [Media Query](ui/ui-ts-layout-mediaquery.md) - - Experiencing the Declarative UI - - [Creating a Declarative UI Project](ui/ui-ts-creating-project.md) - - [Getting to Know Components](ui/ui-ts-components.md) + - [Declarative UI Development Guidelines](ui/ui-ts-developing-intro.md) + - Declarative UI Development Examples - [Creating a Simple Page](ui/ui-ts-creating-simple-page.md) - - Defining Page Layout and Connection - - [Building a Food Data Model](ui/ui-ts-building-data-model.md) - - [Building a Food Category List Layout](ui/ui-ts-building-category-list-layout.md) - - [Building a Food Category Grid Layout](ui/ui-ts-building-category-grid-layout.md) - - [Implementing Page Redirection and Data Transmission](ui/ui-ts-page-redirection-data-transmission.md) - - [Recommendations for Improving Performance](ui/ts-performance-improvement-recommendation.md) - - JavaScript-compatible Web-like Development Paradigm + - Building a Comprehensive Example + - [Building a Food Data Model](ui/ui-ts-building-data-model.md) + - [Building a Food Category List Layout](ui/ui-ts-building-category-list-layout.md) + - [Building a Food Category Grid Layout](ui/ui-ts-building-category-grid-layout.md) + - [Implementing Page Redirection and Data Transmission](ui/ui-ts-page-redirection-data-transmission.md) + - Adding a Splash Screen Animation + - [Using the Drawing Feature](ui/ui-ts-drawing-feature.md) + - [Using the Animation Feature](ui/ui-ts-animation-feature.md) + - [Common Components](ui/ui-ts-components-intro.md) + - Common Layout Development + - Adaptive Layouts + - [Linear Layout](ui/ui-ts-layout-linear.md) + - [Statck Layout](ui/ui-ts-layout-stack.md) + - [Flex Layout](ui/ui-ts-layout-flex.md) + - [Grid Layout](ui/ui-ts-layout-grid.md) + - Responsive Layouts + - [Grid Layout](ui/ui-ts-layout-grid-container-new.md) + - [Media Query](ui/ui-ts-layout-mediaquery.md) + - [Custom Component Lifecycle Callbacks](ui/ui-ts-custom-component-lifecycle-callbacks.md) + - [Web Component Development](ui/ui-ts-components-web.md) + - [Recommendations for Improving Performance](ui/ui-ts-performance-improvement-recommendation.md) + - UI Development with JavaScript-compatible Web-like Development Paradigm - [Overview](ui/ui-js-overview.md) - Framework - [File Organization](ui/js-framework-file.md) @@ -163,9 +161,14 @@ - [OpenSL ES Audio Playback Development](media/opensles-playback.md) - [OpenSL ES Audio Recording Development](media/opensles-capture.md) - [Audio Interruption Mode Development](media/audio-interruptmode.md) + - [Volume Management Development](media/audio-volume-manager.md) + - [Audio Routing and Device Management Development](media/audio-routing-manager.md) - Video - [Video Playback Development](media/video-playback.md) - [Video Recording Development](media/video-recorder.md) + - AVSession + - [AVSession Overview](media/avsession-overview.md) + - [AVSession Development](media/avsession-guidelines.md) - Image - [Image Development](media/image.md) - Camera @@ -183,6 +186,9 @@ - Key Management - [HUKS Overview](security/huks-overview.md) - [HUKS Development](security/huks-guidelines.md) + - Crypto Framework + - [Crypto Framework Overview](security/cryptoFramework-overview.md) + - [Crypto Framework Development](security/cryptoFramework-guidelines.md) - hapsigner - [hapsigner Overview](security/hapsigntool-overview.md) - [hapsigner Guide](security/hapsigntool-guidelines.md) @@ -216,13 +222,20 @@ - Data Share - [DataShare Overview](database/database-datashare-overview.md) - [DataShare Development](database/database-datashare-guidelines.md) + - File Management + - MediaLibrary + - [MediaLibrary Development Overview](file-management/medialibrary-overview.md) + - [Media Asset Management](file-management/medialibrary-resource-guidelines.md) + - [File Path Management](file-management/medialibrary-filepath-guidelines.md) + - [Album Management](file-management/medialibrary-album-guidelines.md) + - Task Management - Background Task Management - [Background Task Management Overview](task-management/background-task-overview.md) - - [Background Task Management Development](task-management/background-task-dev-guide.md) - - Work Scheduler - - [Work Scheduler Overview](task-management/work-scheduler-overview.md) + - [Transient Task Development](task-management/transient-task-dev-guide.md) + - [Continuous Task Development](task-management/continuous-task-dev-guide.md) - [Work Scheduler Development](task-management/work-scheduler-dev-guide.md) + - [Efficiency Resource Request Development](task-management/efficiency-resources-apply-dev-guide.md) - Device - USB Service - [USB Service Overview](device/usb-overview.md) @@ -240,19 +253,16 @@ - Update Service - [Sample Server Overview](device/sample-server-overview.md) - [Sample Server Development](device/sample-server-guidelines.md) + - Update Service + - [Sample Server Overview](device/sample-server-overview.md) + - [Sample Server Development](device/sample-server-guidelines.md) - Device Usage Statistics - [Device Usage Statistics Overview](device-usage-statistics/device-usage-statistics-overview.md) - - [Device Usage Statistics Development](device-usage-statistics/device-usage-statistics-dev-guide.md) + - [Device Usage Statistics Development](device-usage-statistics/device-usage-statistics-use-guide.md) - DFX - - Application Event Logging - - [Overview of Application Event Logging](dfx/hiappevent-overview.md) - - [Development of Application Event Logging](dfx/hiappevent-guidelines.md) - - Performance Tracing - - [Overview of Performance Tracing](dfx/hitracemeter-overview.md) - - [Development of Performance Tracing](dfx/hitracemeter-guidelines.md) - - Distributed Call Chain Tracing - - [Overview of Distributed Call Chain Tracing](dfx/hitracechain-overview.md) - - [Development of Distributed Call Chain Tracing](dfx/hitracechain-guidelines.md) + - [Development of Application Event Logging](dfx/hiappevent-guidelines.md) + - [Development of Performance Tracing](dfx/hitracemeter-guidelines.md) + - [Development of Distributed Call Chain Tracing](dfx/hitracechain-guidelines.md) - Error Management - [Development of Error Manager](dfx/errormanager-guidelines.md) - Internationalization @@ -274,6 +284,7 @@ - API References - [SysCap List](reference/syscap-list.md) - Component Reference (ArkTS-based Declarative Development Paradigm) + - [Component Overview](reference/arkui-ts/ts-components-summary.md) - Universal Component Information - Universal Events - [Click Event](reference/arkui-ts/ts-universal-events-click.md) @@ -339,6 +350,8 @@ - [LoadingProgress](reference/arkui-ts/ts-basic-components-loadingprogress.md) - [Marquee](reference/arkui-ts/ts-basic-components-marquee.md) - [Navigation](reference/arkui-ts/ts-basic-components-navigation.md) + - [NavRouter](reference/arkui-ts/ts-basic-components-navrouter.md) + - [NavDestination](reference/arkui-ts/ts-basic-components-navdestination.md) - [PatternLock](reference/arkui-ts/ts-basic-components-patternlock.md) - [PluginComponent](reference/arkui-ts/ts-basic-components-plugincomponent.md) - [Progress](reference/arkui-ts/ts-basic-components-progress.md) @@ -372,6 +385,7 @@ - [ColumnSplit](reference/arkui-ts/ts-container-columnsplit.md) - [Counter](reference/arkui-ts/ts-container-counter.md) - [Flex](reference/arkui-ts/ts-container-flex.md) + - [FlowItem](reference/arkui-ts/ts-container-flowitem.md) - [GridContainer](reference/arkui-ts/ts-container-gridcontainer.md) - [GridCol](reference/arkui-ts/ts-container-gridcol.md) - [GridRow](reference/arkui-ts/ts-container-gridrow.md) @@ -392,7 +406,8 @@ - [Swiper](reference/arkui-ts/ts-container-swiper.md) - [Tabs](reference/arkui-ts/ts-container-tabs.md) - [TabContent](reference/arkui-ts/ts-container-tabcontent.md) - - Media Components + - [WaterFlow](reference/arkui-ts/ts-container-waterflow.md) + - Media Component - [Video](reference/arkui-ts/ts-media-components-video.md) - Drawing Components - [Circle](reference/arkui-ts/ts-drawing-components-circle.md) @@ -420,7 +435,6 @@ - [Component Transition](reference/arkui-ts/ts-transition-animation-component.md) - [Transition of Shared Elements](reference/arkui-ts/ts-transition-animation-shared-elements.md) - [Motion Path Animation](reference/arkui-ts/ts-motion-path-animation.md) - - Global UI Methods - Pop-up Window - [Alert Dialog Box](reference/arkui-ts/ts-methods-alert-dialog-box.md) @@ -430,8 +444,12 @@ - [Time Picker Dialog Box](reference/arkui-ts/ts-methods-timepicker-dialog.md) - [Text Picker Dialog Box](reference/arkui-ts/ts-methods-textpicker-dialog.md) - [Menu](reference/arkui-ts/ts-methods-menu.md) + - [State Management with Application-level Variables](reference/arkui-ts/ts-state-management.md) + - [Pixel Units](reference/arkui-ts/ts-pixel-units.md) - [Built-in Enums](reference/arkui-ts/ts-appendix-enums.md) - [Types](reference/arkui-ts/ts-types.md) + - Deprecated Components + - [GridContainer](reference/arkui-ts/ts-container-gridcontainer.md) - Component Reference (JavaScript-compatible Web-like Development Paradigm) - Universal Component Information - [Universal Attributes](reference/arkui-js/js-components-common-attributes.md) @@ -527,122 +545,224 @@ - [animateTransform](reference/arkui-js/js-components-svg-animatetransform.md) - Custom Components - [Basic Usage](reference/arkui-js/js-components-custom-basic-usage.md) - - [Style Inheritance](reference/arkui-js/js-components-custom-style.md) - - [Custom Events](reference/arkui-js/js-components-custom-events.md) - [props](reference/arkui-js/js-components-custom-props.md) - - [Event Parameter](reference/arkui-js/js-components-custom-event-parameter.md) + - [Style Inheritance](reference/arkui-js/js-components-custom-style.md) - [slot](reference/arkui-js/js-components-custom-slot.md) - [Lifecycle Definition](reference/arkui-js/js-components-custom-lifecycle.md) - [Data Type Attributes](reference/arkui-js/js-appendix-types.md) + - JS Service Widget UI Components + - JS Service Widget UI Framework + - [File Organization](reference/js-service-widget-ui/js-service-widget-file.md) + - Syntax + - [HML](reference/js-service-widget-ui/js-service-widget-syntax-hml.md) + - [CSS](reference/js-service-widget-ui/js-service-widget-syntax-css.md) + - [Multi-Language Capability](reference/js-service-widget-ui/js-service-widget-multiple-languages.md) + - [Version Compatibility Adaptation](reference/js-service-widget-ui/js-service-widget-version-compatibility.md) + - [Theme Configuration](reference/js-service-widget-ui/js-service-widget-theme.md) + - Components + - Universal + - [Universal Attributes](reference/js-service-widget-ui/js-service-widget-common-attributes.md) + - [Universal Styles](reference/js-service-widget-ui/js-service-widget-common-styles.md) + - [Universal Events](reference/js-service-widget-ui/js-service-widget-common-events.md) + - [Gradient Styles](reference/js-service-widget-ui/js-service-widget-common-gradient.md) + - [Media Query](reference/js-service-widget-ui/js-service-widget-common-mediaquery.md) + - [Custom Font Styles](reference/js-service-widget-ui/js-service-widget-common-customizing-font.md) + - [Accessibility](reference/js-service-widget-ui/js-service-widget-common-accessibility.md) + - [Atomic Layout](reference/js-service-widget-ui/js-service-widget-common-atomic-layout.md) + - Container Components + - [badge](reference/js-service-widget-ui/js-service-widget-container-badge.md) + - [div](reference/js-service-widget-ui/js-service-widget-container-div.md) + - [list](reference/js-service-widget-ui/js-service-widget-container-list.md) + - [list-item](reference/js-service-widget-ui/js-service-widget-container-list-item.md) + - [stack](reference/js-service-widget-ui/js-service-widget-container-stack.md) + - [swiper](reference/js-service-widget-ui/js-service-widget-container-swiper.md) + - Basic Components + - [button](reference/js-service-widget-ui/js-service-widget-basic-button.md) + - [calendar](reference/js-service-widget-ui/js-service-widget-basic-calendar.md) + - [chart](reference/js-service-widget-ui/js-service-widget-basic-chart.md) + - [clock](reference/js-service-widget-ui/js-service-widget-basic-clock.md) + - [divider](reference/js-service-widget-ui/js-service-widget-basic-divider.md) + - [image](reference/js-service-widget-ui/js-service-widget-basic-image.md) + - [input](reference/js-service-widget-ui/js-service-widget-basic-input.md) + - [progress](reference/js-service-widget-ui/js-service-widget-basic-progress.md) + - [span](reference/js-service-widget-ui/js-service-widget-basic-span.md) + - [text](reference/js-service-widget-ui/js-service-widget-basic-text.md) + - [Custom Component Basic Usage](reference/js-service-widget-ui/js-service-widget-custom-basic-usage.md) + - [Data Types](reference/js-service-widget-ui/js-service-widget-appendix-types.md) - JS and TS APIs - [API Reference Document Description](reference/apis/development-intro.md) - Ability Framework - - FA Model - - [@ohos.ability.featureAbility](reference/apis/js-apis-featureAbility.md) - - [@ohos.ability.particleAbility](reference/apis/js-apis-particleAbility.md) - - [dataAbilityHelper](reference/apis/js-apis-dataAbilityHelper.md) - - [context](reference/apis/js-apis-Context.md) - - Stage Model + - Stage Model (Recommended) + - [@ohos.app.ability.Ability](reference/apis/js-apis-app-ability-ability.md) + - [@ohos.app.ability.AbilityConstant](reference/apis/js-apis-app-ability-abilityConstant.md) + - [@ohos.app.ability.abilityLifecycleCallback](reference/apis/js-apis-app-ability-abilityLifecycleCallback.md) + - [@ohos.app.ability.AbilityStage](reference/apis/js-apis-app-ability-abilityStage.md) + - [@ohos.app.ability.common](reference/apis/js-apis-app-ability-common.md) + - [@ohos.app.ability.contextConstant](reference/apis/js-apis-app-ability-contextConstant.md) + - [@ohos.app.ability.EnvironmentCallback](reference/apis/js-apis-app-ability-environmentCallback.md) + - [@ohos.app.ability.ExtensionAbility](reference/apis/js-apis-app-ability-extensionAbility.md) + - [@ohos.app.ability.ServiceExtensionAbility](reference/apis/js-apis-app-ability-serviceExtensionAbility.md) + - [@ohos.app.ability.StartOptions](reference/apis/js-apis-app-ability-startOptions.md) + - [@ohos.app.ability.UIAbility](reference/apis/js-apis-app-ability-uiAbility.md) + - [@ohos.app.form.FormExtensionAbility](reference/apis/js-apis-app-form-formExtensionAbility.md) + - Stage Model (To Be Deprecated Soon) - [@ohos.application.Ability](reference/apis/js-apis-application-ability.md) - [@ohos.application.AbilityConstant](reference/apis/js-apis-application-abilityConstant.md) - - [@ohos.application.AbilityStage](reference/apis/js-apis-application-abilitystage.md) - - [@ohos.application.abilityLifecycleCallback](reference/apis/js-apis-application-abilityLifecycleCallback.md) + - [@ohos.application.AbilityLifecycleCallback](reference/apis/js-apis-application-abilityLifecycleCallback.md) + - [@ohos.application.AbilityStage](reference/apis/js-apis-application-abilityStage.md) + - [@ohos.application.context](reference/apis/js-apis-application-context.md) - [@ohos.application.DataShareExtensionAbility](reference/apis/js-apis-application-DataShareExtensionAbility.md) - - [@ohos.application.FormExtension](reference/apis/js-apis-formextension.md) - - [@ohos.application.ServiceExtensionAbility](reference/apis/js-apis-service-extension-ability.md) - - [@ohos.application.StartOptions](reference/apis/js-apis-application-StartOptions.md) + - [@ohos.application.EnvironmentCallback](reference/apis/js-apis-application-environmentCallback.md) + - [@ohos.application.ExtensionAbility](reference/apis/js-apis-application-extensionAbility.md) + - [@ohos.application.FormExtension](reference/apis/js-apis-application-formExtension.md) + - [@ohos.application.ServiceExtensionAbility](reference/apis/js-apis-application-serviceExtensionAbility.md) + - [@ohos.application.StartOptions](reference/apis/js-apis-application-startOptions.md) - [@ohos.application.StaticSubscriberExtensionAbility](reference/apis/js-apis-application-staticSubscriberExtensionAbility.md) - - [@ohos.application.WindowExtensionAbility](reference/apis/js-apis-application-WindowExtensionAbility.md) - - [AbilityContext](reference/apis/js-apis-ability-context.md) - - [ApplicationContext](reference/apis/js-apis-application-applicationContext.md) - - [AbilityStageContext](reference/apis/js-apis-abilitystagecontext.md) - - [Context](reference/apis/js-apis-application-context.md) - - [ExtensionContext](reference/apis/js-apis-extension-context.md) - - [FormExtensionContext](reference/apis/js-apis-formextensioncontext.md) - - [PermissionRequestResult](reference/apis/js-apis-permissionrequestresult.md) - - [ServiceExtensionContext](reference/apis/js-apis-service-extension-context.md) - - FA and Stage Models - - [@ohos.ability.dataUriUtils](reference/apis/js-apis-DataUriUtils.md) + - FA Model + - [@ohos.ability.ability](reference/apis/js-apis-ability-ability.md) + - [@ohos.ability.featureAbility](reference/apis/js-apis-ability-featureAbility.md) + - [@ohos.ability.particleAbility](reference/apis/js-apis-ability-particleAbility.md) + - Both Models (Recommended) + - [@ohos.app.ability.abilityDelegatorRegistry](reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md) + - [@ohos.app.ability.abilityManager](reference/apis/js-apis-app-ability-abilityManager.md) + - [@ohos.app.ability.appManager](reference/apis/js-apis-app-ability-appManager.md) + - [@ohos.app.ability.appRecovery](reference/apis/js-apis-app-ability-appRecovery.md) + - [@ohos.app.ability.Configuration](reference/apis/js-apis-app-ability-configuration.md) + - [@ohos.app.ability.ConfigurationConstant](reference/apis/js-apis-app-ability-configurationConstant.md) + - [@ohos.app.ability.dataUriUtils](reference/apis/js-apis-app-ability-dataUriUtils.md) + - [@ohos.app.ability.errorManager](reference/apis/js-apis-app-ability-errorManager.md) + - [@ohos.app.ability.missionManager](reference/apis/js-apis-app-ability-missionManager.md) + - [@ohos.app.ability.quickFixManager](reference/apis/js-apis-app-ability-quickFixManager.md) + - [@ohos.app.ability.Want](reference/apis/js-apis-app-ability-want.md) + - [@ohos.app.ability.wantAgent](reference/apis/js-apis-app-ability-wantAgent.md) + - [@ohos.app.ability.wantConstant](reference/apis/js-apis-app-ability-wantConstant.md) + - [@ohos.app.form.formBindingData](reference/apis/js-apis-app-form-formBindingData.md) + - [@ohos.app.form.formHost](reference/apis/js-apis-app-form-formHost.md) + - [@ohos.app.form.formInfo](reference/apis/js-apis-app-form-formInfo.md) + - [@ohos.app.form.formProvider](reference/apis/js-apis-app-form-formProvider.md) + - Both Models (To Be Deprecated Soon) + - [@ohos.ability.dataUriUtils](reference/apis/js-apis-ability-dataUriUtils.md) - [@ohos.ability.errorCode](reference/apis/js-apis-ability-errorCode.md) - [@ohos.ability.wantConstant](reference/apis/js-apis-ability-wantConstant.md) - - [@ohos.application.abilityDelegatorRegistry](reference/apis/js-apis-abilityDelegatorRegistry.md) + - [@ohos.application.abilityDelegatorRegistry](reference/apis/js-apis-application-abilityDelegatorRegistry.md) - [@ohos.application.abilityManager](reference/apis/js-apis-application-abilityManager.md) - - [@ohos.application.AccessibilityExtensionAbility](reference/apis/js-apis-accessibility-extension-context.md) - - [@ohos.application.AccessibilityExtensionAbility](reference/apis/js-apis-application-AccessibilityExtensionAbility.md) - - [@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.EnvironmentCallback](reference/apis/js-apis-application-EnvironmentCallback.md) - - [@ohos.application.errorManager](reference/apis/js-apis-errorManager.md) - - [@ohos.application.formBindingData](reference/apis/js-apis-formbindingdata.md) - - [@ohos.application.formError](reference/apis/js-apis-formerror.md) - - [@ohos.application.formHost](reference/apis/js-apis-formhost.md) - - [@ohos.application.formInfo](reference/apis/js-apis-formInfo.md) - - [@ohos.application.formProvider](reference/apis/js-apis-formprovider.md) - - [@ohos.application.missionManager](reference/apis/js-apis-missionManager.md) - - [@ohos.application.quickFixManager](reference/apis/js-apis-application-quickFixManager.md) - - [@ohos.application.Want](reference/apis/js-apis-application-Want.md) - - [@ohos.continuation.continuationManager](reference/apis/js-apis-continuation-continuationExtraParams.md) - - [@ohos.continuation.continuationManager](reference/apis/js-apis-continuation-continuationManager.md) + - [@ohos.application.appManager](reference/apis/js-apis-application-appManager.md) + - [@ohos.application.Configuration](reference/apis/js-apis-application-configuration.md) + - [@ohos.application.ConfigurationConstant](reference/apis/js-apis-application-configurationConstant.md) + - [@ohos.application.errorManager](reference/apis/js-apis-application-errorManager.md) + - [@ohos.application.formBindingData](reference/apis/js-apis-application-formBindingData.md) + - [@ohos.application.formError](reference/apis/js-apis-application-formError.md) + - [@ohos.application.formHost](reference/apis/js-apis-application-formHost.md) + - [@ohos.application.formInfo](reference/apis/js-apis-application-formInfo.md) + - [@ohos.application.formProvider](reference/apis/js-apis-application-formProvider.md) + - [@ohos.application.missionManager](reference/apis/js-apis-application-missionManager.md) + - [@ohos.application.Want](reference/apis/js-apis-application-want.md) - [@ohos.wantAgent](reference/apis/js-apis-wantAgent.md) - - [abilityDelegator](reference/apis/js-apis-application-abilityDelegator.md) - - [abilityDelegatorArgs](reference/apis/js-apis-application-abilityDelegatorArgs.md) - - [abilityMonitor](reference/apis/js-apis-application-abilityMonitor.md) - - [AbilityRunningInfo](reference/apis/js-apis-abilityrunninginfo.md) - - [ExtensionRunningInfo](reference/apis/js-apis-extensionrunninginfo.md) - - [MissionSnapshot](reference/apis/js-apis-application-MissionSnapshot.md) - - [ProcessRunningInfo](reference/apis/js-apis-processrunninginfo.md) - - [ProcessRunningInformation](reference/apis/js-apis-processrunninginformation.md) - - [shellCmdResult](reference/apis/js-apis-application-shellCmdResult.md) - - [ContinuationResult](reference/apis/js-apis-continuation-continuationResult.md) + - Dependent Elements and Definitions + - ability + - [abilityResult](reference/apis/js-apis-inner-ability-abilityResult.md) + - [connectOptions](reference/apis/js-apis-inner-ability-connectOptions.md) + - [dataAbilityHelper](reference/apis/js-apis-inner-ability-dataAbilityHelper.md) + - [dataAbilityOperation](reference/apis/js-apis-inner-ability-dataAbilityOperation.md) + - [dataAbilityResult](reference/apis/js-apis-inner-ability-dataAbilityResult.md) + - [startAbilityParameter](reference/apis/js-apis-inner-ability-startAbilityParameter.md) + - [want](reference/apis/js-apis-inner-ability-want.md) + - app + - [appVersionInfo](reference/apis/js-apis-inner-app-appVersionInfo.md) + - [context](reference/apis/js-apis-inner-app-context.md) + - [processInfo](reference/apis/js-apis-inner-app-processInfo.md) + - application + - [AbilityContext](reference/apis/js-apis-ability-context.md) + - [abilityDelegator](reference/apis/js-apis-inner-application-abilityDelegator.md) + - [abilityDelegatorArgs](reference/apis/js-apis-inner-application-abilityDelegatorArgs.md) + - [abilityMonitor](reference/apis/js-apis-inner-application-abilityMonitor.md) + - [AbilityRunningInfo](reference/apis/js-apis-inner-application-abilityRunningInfo.md) + - [AbilityStageContext](reference/apis/js-apis-inner-application-abilityStageContext.md) + - [AbilityStateData](reference/apis/js-apis-inner-application-abilityStateData.md) + - [abilityStageMonitor](reference/apis/js-apis-inner-application-abilityStageMonitor.md) + - [ApplicationContext](reference/apis/js-apis-inner-application-applicationContext.md) + - [ApplicationStateObserver](reference/apis/js-apis-inner-application-applicationStateObserver.md) + - [AppStateData](reference/apis/js-apis-inner-application-appStateData.md) + - [BaseContext](reference/apis/js-apis-inner-application-baseContext.md) + - [Context](reference/apis/js-apis-inner-application-context.md) + - [ContinueCallback](reference/apis/js-apis-inner-application-continueCallback.md) + - [ContinueDeviceInfo](reference/apis/js-apis-inner-application-continueDeviceInfo.md) + - [ErrorObserver](reference/apis/js-apis-inner-application-errorObserver.md) + - [ExtensionContext](reference/apis/js-apis-inner-application-extensionContext.md) + - [ExtensionRunningInfo](reference/apis/js-apis-inner-application-extensionRunningInfo.md) + - [FormExtensionContext](reference/apis/js-apis-inner-application-formExtensionContext.md) + - [MissionCallbacks](reference/apis/js-apis-inner-application-missionCallbacks.md) + - [MissionDeviceInfo](reference/apis/js-apis-inner-application-missionDeviceInfo.md) + - [MissionInfo](reference/apis/js-apis-inner-application-missionInfo.md) + - [MissionListener](reference/apis/js-apis-inner-application-missionListener.md) + - [MissionParameter](reference/apis/js-apis-inner-application-missionParameter.md) + - [MissionSnapshot](reference/apis/js-apis-inner-application-missionSnapshot.md) + - [PermissionRequestResult](reference/apis/js-apis-inner-application-permissionRequestResult.md) + - [ProcessData](reference/apis/js-apis-inner-application-processData.md) + - [ProcessRunningInfo](reference/apis/js-apis-inner-application-processRunningInfo.md) + - [ProcessRunningInformation](reference/apis/js-apis-inner-application-processRunningInformation.md) + - [ServiceExtensionContext](reference/apis/js-apis-inner-application-serviceExtensionContext.md) + - [UIAbilityContext](reference/apis/js-apis-inner-application-uiAbilityContext.md) + - [shellCmdResult](reference/apis/js-apis-inner-application-shellCmdResult.md) + - wantAgent + - [triggerInfo](reference/apis/js-apis-inner-wantAgent-triggerInfo.md) + - [wantAgentInfo](reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md) + - Continuation + - [@ohos.continuation.continuationManager (continuationManager)](reference/apis/js-apis-continuation-continuationManager.md) + - continuation + - [continuationExtraParams](reference/apis/js-apis-continuation-continuationExtraParams.md) + - [continuationResult](reference/apis/js-apis-continuation-continuationResult.md) - Common Event and Notification - [@ohos.commonEvent](reference/apis/js-apis-commonEvent.md) - [@ohos.events.emitter](reference/apis/js-apis-emitter.md) - [@ohos.notification](reference/apis/js-apis-notification.md) - [@ohos.reminderAgent](reference/apis/js-apis-reminderAgent.md) - - [EventHub](reference/apis/js-apis-eventhub.md) + - application + - [EventHub](reference/apis/js-apis-inner-application-eventHub.md) - Bundle Management - - [@ohos.bundle](reference/apis/js-apis-Bundle.md) - - [@ohos.bundle.defaultAppManager](reference/apis/js-apis-bundle-defaultAppManager.md) - - [@ohos.bundle.innerBundleManager)](reference/apis/js-apis-Bundle-InnerBundleManager.md) - - [@ohos.bundleState](reference/apis/js-apis-deviceUsageStatistics.md) - - [@ohos.distributedBundle](reference/apis/js-apis-Bundle-distributedBundle.md) + - [@ohos.bundle.appControl](reference/apis/js-apis-appControl.md) + - [@ohos.bundle.bundleManager](reference/apis/js-apis-bundleManager.md) + - [@ohos.bundle.bundleMonitor](reference/apis/js-apis-bundleMonitor.md) + - [@ohos.bundle.defaultAppManager](reference/apis/js-apis-defaultAppManager.md) + - [@ohos.bundle.distributedBundle](reference/apis/js-apis-distributedBundle.md) + - [@ohos.bundle.freeInstall](reference/apis/js-apis-freeInstall.md) + - [@ohos.bundle.installer](reference/apis/js-apis-installer.md) + - [@ohos.bundle.launcherBundleManager](reference/apis/js-apis-launcherBundleManager.md) - [@ohos.zlib](reference/apis/js-apis-zlib.md) - - [AbilityInfo](reference/apis/js-apis-bundle-AbilityInfo.md) - - [ApplicationInfo](reference/apis/js-apis-bundle-ApplicationInfo.md) - - [BundleInfo](reference/apis/js-apis-bundle-BundleInfo.md) - - [BundleInstaller](reference/apis/js-apis-bundle-BundleInstaller.md) - - [BundleStatusCallback](reference/apis/js-apis-Bundle-BundleStatusCallback.md) - - [CustomizeData](reference/apis/js-apis-bundle-CustomizeData.md) - - [DispatchInfo](reference/apis/js-apis-dispatchInfo.md) - - [ElementName](reference/apis/js-apis-bundle-ElementName.md) - - [ExtensionAbilityInfo](reference/apis/js-apis-bundle-ExtensionAbilityInfo.md) - - [HapModuleInfo](reference/apis/js-apis-bundle-HapModuleInfo.md) - - [LauncherAbilityInfo](reference/apis/js-apis-bundle-LauncherAbilityInfo.md) - - [Metadata](reference/apis/js-apis-bundle-Metadata.md) - - [ModuleInfo](reference/apis/js-apis-bundle-ModuleInfo.md) - - [PackInfo](reference/apis/js-apis-bundle-PackInfo.md) - - [PermissionDef](reference/apis/js-apis-bundle-PermissionDef.md) - - [RemoteAbilityInfo](reference/apis/js-apis-bundle-remoteAbilityInfo.md) - - [ShortcutInfo](reference/apis/js-apis-bundle-ShortcutInfo.md) + - bundleManager + - [abilityInfo](reference/apis/js-apis-bundleManager-abilityInfo.md) + - [applicationInfo](reference/apis/js-apis-bundleManager-applicationInfo.md) + - [bundleInfo](reference/apis/js-apis-bundleManager-bundleInfo.md) + - [dispatchInfo](reference/apis/js-apis-bundleManager-dispatchInfo.md) + - [elementName](reference/apis/js-apis-bundleManager-elementName.md) + - [extensionAbilityInfo](reference/apis/js-apis-bundleManager-extensionAbilityInfo.md) + - [hapModuleInfo](reference/apis/js-apis-bundleManager-hapModuleInfo.md) + - [launcherAbilityInfo](reference/apis/js-apis-bundleManager-launcherAbilityInfo.md) + - [metadata](reference/apis/js-apis-bundleManager-metadata.md) + - [packInfo](reference/apis/js-apis-bundleManager-packInfo.md) + - [permissionDef](reference/apis/js-apis-bundleManager-permissionDef.md) + - [remoteAbilityInfo](reference/apis/js-apis-bundleManager-remoteAbilityInfo.md) + - [shortcutInfo](reference/apis/js-apis-bundleManager-shortcutInfo.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.promptAction](reference/apis/js-apis-promptAction.md) - [@ohos.router](reference/apis/js-apis-router.md) - - [@ohos.uiAppearance](reference/apis/js-apis-uiappearance.md) - Graphics - [@ohos.animation.windowAnimationManager](reference/apis/js-apis-windowAnimationManager.md) + - [@ohos.application.WindowExtensionAbility](reference/apis/js-apis-application-windowExtensionAbility.md) - [@ohos.display](reference/apis/js-apis-display.md) - [@ohos.effectKit](reference/apis/js-apis-effectKit.md) - [@ohos.graphics.colorSpaceManager](reference/apis/js-apis-colorSpaceManager.md) - [@ohos.screen](reference/apis/js-apis-screen.md) - [@ohos.screenshot](reference/apis/js-apis-screenshot.md) - [@ohos.window](reference/apis/js-apis-window.md) + - webgl - [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.avsession](reference/apis/js-apis-avsession.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) @@ -651,18 +771,16 @@ - [@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.distributedMissionManager](reference/apis/js-apis-distributedMissionManager.md) - - [@ohos.workScheduler](reference/apis/js-apis-workScheduler.md) + - [@ohos.reminderAgentManager](reference/apis/js-apis-reminderAgentManager.md) + - [@ohos.resourceschedule.backgroundTaskManager](reference/apis/js-apis-resourceschedule-backgroundTaskManager.md) + - [@ohos.resourceschedule.workScheduler](reference/apis/js-apis-resourceschedule-workScheduler.md) + - [@ohos.resourceschedule.usageStatistics](reference/apis/js-apis-resourceschedule-deviceUsageStatistics.md) - [@ohos.WorkSchedulerExtensionAbility](reference/apis/js-apis-WorkSchedulerExtensionAbility.md) - - Custom Management - - [@ohos.configPolicy](reference/apis/js-apis-config-policy.md) - - [@ohos.EnterpriseAdminExtensionAbility](reference/apis/js-apis-EnterpriseAdminExtensionAbility.md) - - [@ohos.enterpriseDeviceManager](reference/apis/js-apis-enterprise-device-manager.md) - - [DeviceSettingsManager](reference/apis/js-apis-enterpriseDeviceManager-DeviceSettingsManager.md) - Security - [@ohos.abilityAccessCtrl](reference/apis/js-apis-abilityAccessCtrl.md) - [@ohos.privacyManager](reference/apis/js-apis-privacyManager.md) + - [@ohos.security.cryptoFramework](reference/apis/js-apis-cryptoFramework.md) - [@ohos.security.huks](reference/apis/js-apis-huks.md) - [@ohos.userIAM.faceAuth](reference/apis/js-apis-useriam-faceauth.md) - [@ohos.userIAM.userAuth](reference/apis/js-apis-useriam-userauth.md) @@ -672,15 +790,17 @@ - [@ohos.data.dataShare](reference/apis/js-apis-data-dataShare.md) - [@ohos.data.dataSharePredicates](reference/apis/js-apis-data-dataSharePredicates.md) - [@ohos.data.dataShareResultSet](reference/apis/js-apis-data-DataShareResultSet.md) - - [@ohos.data.distributedData](reference/apis/js-apis-distributed-data.md) - [@ohos.data.distributedDataObject](reference/apis/js-apis-data-distributedobject.md) + - [@ohos.data.distributedKVStore](reference/apis/js-apis-distributedKVStore.md) - [@ohos.data.preferences](reference/apis/js-apis-data-preferences.md) - [@ohos.data.rdb](reference/apis/js-apis-data-rdb.md) - [@ohos.data.ValuesBucket](reference/apis/js-apis-data-ValuesBucket.md) + - data/rdb - [resultSet](reference/apis/js-apis-data-resultset.md) - File Management - - [@ohos.document](reference/apis/js-apis-document.md) - [@ohos.environment](reference/apis/js-apis-environment.md) + - [@ohos.data.fileAccess](reference/apis/js-apis-fileAccess.md) + - [@ohos.fileExtensionInfo](reference/apis/js-apis-fileExtensionInfo.md) - [@ohos.fileio](reference/apis/js-apis-fileio.md) - [@ohos.filemanagement.userfile_manager](reference/apis/js-apis-userfilemanager.md) - [@ohos.multimedia.medialibrary](reference/apis/js-apis-medialibrary.md) @@ -700,11 +820,8 @@ - [@ohos.net.connection](reference/apis/js-apis-net-connection.md) - [@ohos.net.ethernet](reference/apis/js-apis-net-ethernet.md) - [@ohos.net.http](reference/apis/js-apis-http.md) - - [@ohos.net.policy](reference/apis/js-apis-net-policy.md) - [@ohos.net.sharing](reference/apis/js-apis-net-sharing.md) - [@ohos.net.socket](reference/apis/js-apis-socket.md) - - [@ohos.net.statistics](reference/apis/js-apis-net-statistics.md) - - [@ohos.net.tlsSocket](reference/apis/js-apis-tlsSocket.md) - [@ohos.net.webSocket](reference/apis/js-apis-webSocket.md) - [@ohos.request](reference/apis/js-apis-request.md) - Connectivity @@ -722,22 +839,25 @@ - [@ohos.accessibility](reference/apis/js-apis-accessibility.md) - [@ohos.accessibility.config](reference/apis/js-apis-accessibility-config.md) - [@ohos.faultLogger](reference/apis/js-apis-faultLogger.md) - - [@ohos.hiAppEvent](reference/apis/js-apis-hiappevent.md) - [@ohos.hichecker](reference/apis/js-apis-hichecker.md) - [@ohos.hidebug](reference/apis/js-apis-hidebug.md) - [@ohos.hilog](reference/apis/js-apis-hilog.md) - [@ohos.hiSysEvent](reference/apis/js-apis-hisysevent.md) - [@ohos.hiTraceChain](reference/apis/js-apis-hitracechain.md) - [@ohos.hiTraceMeter](reference/apis/js-apis-hitracemeter.md) - - [@ohos.inputMethod](reference/apis/js-apis-inputmethod.md) - - [@ohos.inputMethodEngine](reference/apis/js-apis-inputmethodengine.md) + - [@ohos.hiviewdfx.hiAppEvent](reference/apis/js-apis-hiviewdfx-hiappevent.md) + - [@ohos.inputmethod](reference/apis/js-apis-inputmethod.md) + - [@ohos.inputmethodengine](reference/apis/js-apis-inputmethodengine.md) - [@ohos.inputmethodextensionability](reference/apis/js-apis-inputmethod-extension-ability.md) - [@ohos.inputmethodextensioncontext](reference/apis/js-apis-inputmethod-extension-context.md) + - [@ohos.inputmethodsubtype](reference/apis/js-apis-inputmethod-subtype.md) - [@ohos.pasteboard](reference/apis/js-apis-pasteboard.md) - [@ohos.screenLock](reference/apis/js-apis-screen-lock.md) - [@ohos.systemTime](reference/apis/js-apis-system-time.md) - [@ohos.systemTimer](reference/apis/js-apis-system-timer.md) - [@ohos.wallpaper](reference/apis/js-apis-wallpaper.md) + - [@ohos.web.webview](reference/apis/js-apis-webview.md) + - [console](reference/apis/js-apis-logs.md) - [Timer](reference/apis/js-apis-timer.md) - Device Management - [@ohos.batteryInfo](reference/apis/js-apis-battery-info.md) @@ -747,6 +867,7 @@ - [@ohos.geolocation](reference/apis/js-apis-geolocation.md) - [@ohos.multimodalInput.inputConsumer](reference/apis/js-apis-inputconsumer.md) - [@ohos.multimodalInput.inputDevice](reference/apis/js-apis-inputdevice.md) + - [@ohos.multimodalInput.inputDeviceCooperate](reference/apis/js-apis-cooperate.md) - [@ohos.multimodalInput.inputEvent](reference/apis/js-apis-inputevent.md) - [@ohos.multimodalInput.inputEventClient](reference/apis/js-apis-inputeventclient.md) - [@ohos.multimodalInput.inputMonitor](reference/apis/js-apis-inputmonitor.md) @@ -759,7 +880,8 @@ - [@ohos.runningLock](reference/apis/js-apis-runninglock.md) - [@ohos.sensor](reference/apis/js-apis-sensor.md) - [@ohos.settings](reference/apis/js-apis-settings.md) - - [@ohos.systemParameter](reference/apis/js-apis-system-parameter.md) + - [@ohos.stationary](reference/apis/js-apis-stationary.md) + - [@ohos.systemParameterV9](reference/apis/js-apis-system-parameterV9.md) - [@ohos.thermal](reference/apis/js-apis-thermal.md) - [@ohos.update](reference/apis/js-apis-update.md) - [@ohos.usb](reference/apis/js-apis-usb.md) @@ -768,6 +890,10 @@ - [@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) + + - Custom Management + - [@ohos.configPolicy](reference/apis/js-apis-configPolicy.md) + - [@ohos.EnterpriseAdminExtensionAbility](reference/apis/js-apis-EnterpriseAdminExtensionAbility.md) - Language Base Class Library - [@ohos.buffer](reference/apis/js-apis-buffer.md) - [@ohos.convertxml](reference/apis/js-apis-convertxml.md) @@ -792,11 +918,24 @@ - [@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.application.testRunner (TestRunner)](reference/apis/js-apis-application-testRunner.md) - [@ohos.uitest](reference/apis/js-apis-uitest.md) - APIs No Longer Maintained + - [@ohos.backgroundTaskManager](reference/apis/js-apis-backgroundTaskManager.md) + - [@ohos.bundle](reference/apis/js-apis-Bundle.md) + - [@ohos.bundle.innerBundleManager](reference/apis/js-apis-Bundle-InnerBundleManager.md) + - [@ohos.bundleState](reference/apis/js-apis-deviceUsageStatistics.md) - [@ohos.bytrace](reference/apis/js-apis-bytrace.md) - [@ohos.data.storage](reference/apis/js-apis-data-storage.md) + - [@ohos.data.distributedData](reference/apis/js-apis-distributed-data.md) + - [@ohos.distributedBundle](reference/apis/js-apis-Bundle-distributedBundle.md) + - [@ohos.document](reference/apis/js-apis-document.md) + - [@ohos.geolocation](reference/apis/js-apis-geolocation.md) + - [@ohos.hiAppEvent](reference/apis/js-apis-hiappevent.md) + - [@ohos.prompt](reference/apis/js-apis-prompt.md) + - [@ohos.reminderAgent](reference/apis/js-apis-reminderAgent.md) + - [@ohos.systemParameter](reference/apis/js-apis-system-parameter.md) + - [@ohos.usb](reference/apis/js-apis-usb-deprecated.md) - [@system.app](reference/apis/js-apis-system-app.md) - [@system.battery](reference/apis/js-apis-system-battery.md) - [@system.bluetooth](reference/apis/js-apis-system-bluetooth.md) @@ -816,7 +955,75 @@ - [@system.sensor](reference/apis/js-apis-system-sensor.md) - [@system.storage](reference/apis/js-apis-system-storage.md) - [@system.vibrator](reference/apis/js-apis-system-vibrate.md) - - [console](reference/apis/js-apis-logs.md) + - bundle + - [abilityInfo](reference/apis/js-apis-bundle-AbilityInfo.md) + - [applicationInfo](reference/apis/js-apis-bundle-ApplicationInfo.md) + - [bundleInfo](reference/apis/js-apis-bundle-BundleInfo.md) + - [bundleInstaller](reference/apis/js-apis-bundle-BundleInstaller.md) + - [bundleStatusCallback](reference/apis/js-apis-Bundle-BundleStatusCallback.md) + - [customizeData](reference/apis/js-apis-bundle-CustomizeData.md) + - [elementName](reference/apis/js-apis-bundle-ElementName.md) + - [hapModuleInfo](reference/apis/js-apis-bundle-HapModuleInfo.md) + - [launcherAbilityInfo](reference/apis/js-apis-bundle-LauncherAbilityInfo.md) + - [moduleInfo](reference/apis/js-apis-bundle-ModuleInfo.md) + - [PermissionDef](reference/apis/js-apis-bundle-PermissionDef.md) + - [remoteAbilityInfo](reference/apis/js-apis-bundle-remoteAbilityInfo.md) + - [shortcutInfo](reference/apis/js-apis-bundle-ShortcutInfo.md) + - Error Codes + - Ability Framework + - [Ability Error Codes](reference/errorcodes/errorcode-ability.md) + - [Distributed Scheduler Error Codes](reference/errorcodes/errorcode-DistributedSchedule.md) + - Bundle Management + - [Bundle Error Codes](reference/errorcodes/errorcode-bundle.md) + - [zlib Error Codes](reference/errorcodes/errorcode-zlib.md) + - UI Page + - [promptAction Error Codes](reference/errorcodes/errorcode-promptAction.md) + - [Router Error Codes](reference/errorcodes/errorcode-router.md) + - Graphics + - [colorSpaceManager Error Codes](reference/errorcodes/errorcode-colorspace-manager.md) + - [Display Error Codes](reference/errorcodes/errorcode-display.md) + - [Window Error Codes](reference/errorcodes/errorcode-window.md) + - Media + - [Audio Error Codes](reference/errorcodes/errorcode-audio.md) + - [Media Error Codes](reference/errorcodes/errorcode-media.md) + - [AVSession Management Error Codes](reference/errorcodes/errorcode-avsession.md) + - Resource Management + - [I18N Error Codes](reference/errorcodes/errorcode-i18n.md) + - [Resource Manager Error Codes](reference/errorcodes/errorcode-resource-manager.md) + - Resource Scheduling + - [backgroundTaskManager Error Codes](reference/errorcodes/errorcode-backgroundTaskMgr.md) + - [DeviceUsageStatistics Error Codes](reference/errorcodes/errorcode-DeviceUsageStatistics.md) + - [reminderAgentManager Error Codes](reference/errorcodes/errorcode-reminderAgentManager.md) + - [workScheduler Error Codes](reference/errorcodes/errorcode-workScheduler.md) + - Security + - [Ability Access Control Error Codes](reference/errorcodes/errorcode-access-token.md) + - [HUKS Error Codes](reference/errorcodes/errorcode-huks.md) + - Data Management + - [RDB Error Codes](reference/errorcodes/errorcode-data-rdb.md) + - [Preferences Error Codes](reference/errorcodes/errorcode-preferences.md) + - Network Management + - [Upload and Download Error Codes](reference/errorcodes/errorcode-request.md) + - Basic Features + - [FaultLogger Error Codes](reference/errorcodes/errorcode-faultlogger.md) + - [Application Event Logging Error Codes](reference/errorcodes/errorcode-hiappevent.md) + - [HiSysEvent Error Codes](reference/errorcodes/errorcode-hisysevent.md) + - [HiDebug Error Codes](reference/errorcodes/errorcode-hiviewdfx-hidebug.md) + - [Input Method Framework Error Codes](reference/errorcodes/errorcode-inputmethod-framework.md) + - [Pasteboard Error Codes](reference/errorcodes/errorcode-pasteboard.md) + - [Webview Error Codes](reference/errorcodes/errorcode-webview.md) + - Account Management + - [Account Error Codes](reference/errorcodes/errorcode-account.md) + - [App Account Error Codes](reference/errorcodes/errorcode-app-account.md) + - Device Management + - [Device Management Error Codes](reference/errorcodes/errorcode-device-manager.md) + - [Screen Hopping Error Codes](reference/errorcodes/errorcode-multimodalinput.md) + - [Sensor Error Codes](reference/errorcodes/errorcode-sensor.md) + - [Vibrator Error Codes](reference/errorcodes/errorcode-vibrator.md) + - [System Parameter Error Codes](reference/errorcodes/errorcode-system-parameterV9.md) + - [USB Error Codes](reference/errorcodes/errorcode-usb.md) + - Language Base Class Library + - [Buffer Error Codes](reference/errorcodes/errorcode-buffer.md) + - [containers Error Codes](reference/errorcodes/errorcode-containers.md) - Native APIs - Standard Libraries Supported by Native APIs - [Node_API](reference/native-lib/third_party_napi/napi.md) @@ -829,10 +1036,13 @@ - FAQs - [Guide to Switching to Full SDK](quick-start/full-sdk-switch-guide.md) - [Ability Framework Development](faqs/faqs-ability.md) - - [ArkUI (JavaScript) Development](faqs/faqs-ui-js.md) + - [Bundle Management Development](faqs/faqs-bundle.md) - [ArkUI (ArkTS) Development](faqs/faqs-ui-ets.md) + + - [ArkUI (JavaScript) Development](faqs/faqs-ui-js.md) - [Graphics and Image Development](faqs/faqs-graphics.md) - [File Management Development](faqs/faqs-file-management.md) + - [Media Development](faqs/faqs-media.md) - [Network and Connection Development](faqs/faqs-connectivity.md) - [Device Management Development](faqs/faqs-data-management.md) - [Device Management Development](faqs/faqs-device-management.md)