diff --git a/CODEOWNERS b/CODEOWNERS
index c07dcbcb07683ecb03d698d85d0c99d91107d5e9..0cc5520e8da6a6006fb978bdb1c9c9058fab86ef 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -256,12 +256,12 @@ zh-cn/application-dev/reference/apis/js-apis-hidebug.md @zengyawen
zh-cn/application-dev/reference/apis/js-apis-hilog.md @zengyawen
zh-cn/application-dev/reference/apis/js-apis-hitracechain.md @zengyawen
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md @zengyawen
-zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @sun-yue14
-zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @sun-yue14
+zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @ge-yafang
+zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @ge-yafang
zh-cn/application-dev/reference/apis/js-apis-pasteboard.md @ge-yafang
-zh-cn/application-dev/reference/apis/js-apis-screen-lock.md @sun-yue14
-zh-cn/application-dev/reference/apis/js-apis-system-time.md @sun-yue14
-zh-cn/application-dev/reference/apis/js-apis-wallpaper.md @sun-yue14
+zh-cn/application-dev/reference/apis/js-apis-screen-lock.md @ge-yafang
+zh-cn/application-dev/reference/apis/js-apis-system-time.md @ge-yafang
+zh-cn/application-dev/reference/apis/js-apis-wallpaper.md @ge-yafang
zh-cn/application-dev/reference/apis/js-apis-timer.md @HelloCrease
zh-cn/application-dev/reference/apis/js-apis-battery-info.md @sun-yue14
zh-cn/application-dev/reference/apis/js-apis-brightness.md @sun-yue14
diff --git a/en/application-dev/reference/apis/js-apis-data-storage.md b/en/application-dev/reference/apis/js-apis-data-storage.md
index 5f1daa3d0ca5b492e4c5c9b8ce057f3b46966451..724e8d767f52bf38a43530f57550eaf8825f7271 100644
--- a/en/application-dev/reference/apis/js-apis-data-storage.md
+++ b/en/application-dev/reference/apis/js-apis-data-storage.md
@@ -3,13 +3,10 @@
Lightweight storage provides applications with data processing capability and allows applications to perform lightweight data storage and query. Data is stored in key-value (KV) pairs. Keys are of the string type, and values can be of the number, string, or Boolean type.
-> **NOTE**
+> **NOTE**
>
-> - The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
->
-> - The APIs of this module are no longer maintained since API Version 9. You are advised to use [`@ohos.data.preferences`](js-apis-data-preferences.md).
->
-> - The APIs of this module can be used only in the FA model.
+> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+
## Modules to Import
diff --git a/en/application-dev/reference/apis/js-apis-i18n.md b/en/application-dev/reference/apis/js-apis-i18n.md
index 06d2731b53f9e803be6cb72a60f63076f595c4f8..424273bb6749b2884edd63882135912715150b36 100644
--- a/en/application-dev/reference/apis/js-apis-i18n.md
+++ b/en/application-dev/reference/apis/js-apis-i18n.md
@@ -2,10 +2,10 @@
This module provides system-related or enhanced I18N capabilities, such as locale management, phone number formatting, and calendar, through supplementary I18N APIs that are not defined in ECMA 402.
-The [Intl](intl-guidelines.md) module provides basic I18N capabilities through the standard I18N APIs defined in ECMA 402. It works with the I18N module to provide a complete suite of I18N capabilities.
+The [Intl](js-apis-intl.md) module provides basic I18N capabilities through the standard I18N APIs defined in ECMA 402. It works with the I18N module to provide a complete suite of I18N capabilities.
> **NOTE**
->
+>
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
@@ -26,16 +26,16 @@ Obtains the localized script for the specified language.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------------ | ------- | ---- | ---------------- |
-| language | string | Yes | Specified language. |
-| locale | string | Yes | Locale ID. |
-| sentenceCase | boolean | No | Whether to use sentence case for the localized script.|
+| Name | Type | Mandatory | Description |
+| ------------ | ------- | --------- | ---------------------------------------- |
+| language | string | Yes | Specified language. |
+| locale | string | Yes | Locale ID. |
+| sentenceCase | boolean | No | Whether to use sentence case for the localized script. |
**Return Value**
-| Type | Description |
-| ------ | ------------- |
-| string | Localized script for the specified language.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Localized script for the specified language. |
**Example**
```
@@ -53,16 +53,16 @@ Obtains the localized script for the specified country.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------------ | ------- | ---- | ----------------------------- |
-| country | string | Yes | Specified country. |
-| locale | string | Yes | Locale ID. |
-| sentenceCase | boolean | No | Whether to use sentence case for the localized script.|
+| Name | Type | Mandatory | Description |
+| ------------ | ------- | --------- | ---------------------------------------- |
+| country | string | Yes | Specified country. |
+| locale | string | Yes | Locale ID. |
+| sentenceCase | boolean | No | Whether to use sentence case for the localized script. |
**Return Value**
-| Type | Description |
-| ------ | ------------------------------------------ |
-| string | Localized script for the specified country.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Localized script for the specified country. |
**Example**
```
@@ -85,9 +85,9 @@ Checks whether the localized script for the specified language is displayed from
| locale | string | Locale ID. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the localized script is displayed from right to left; returns **false** otherwise.|
+| boolean | Returns **true** if the localized script is displayed from right to left; returns **false** otherwise. |
**Example**
```
@@ -105,9 +105,9 @@ Obtains the system language.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------- |
-| string | System language ID.|
+| Type | Description |
+| ------ | ------------------- |
+| string | System language ID. |
**Example**
```
@@ -130,14 +130,14 @@ Sets the system language. Currently, this API does not support real-time updatin
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Description |
-| -------- | ------ | ----- |
-| language | string | Language ID.|
+| Name | Type | Description |
+| -------- | ------ | ------------ |
+| language | string | Language ID. |
**Return Value**
-| Type | Description |
-| ------- | ------------------------------------- |
-| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise. |
**Example**
```
@@ -156,9 +156,9 @@ Obtains the list of system languages.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------------------- | ------------ |
-| Array<string> | List of the IDs of system languages.|
+| Type | Description |
+| ------------------- | ------------------------------------ |
+| Array<string> | List of the IDs of system languages. |
**Example**
```
@@ -177,14 +177,14 @@ Obtains the list of countries and regions supported for the specified language.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Description |
-| -------- | ------ | ----- |
-| language | string | Language ID.|
+| Name | Type | Description |
+| -------- | ------ | ------------ |
+| language | string | Language ID. |
**Return Value**
-| Type | Description |
-| ------------------- | ------------ |
-| Array<string> | List of the IDs of the countries and regions supported for the specified language.|
+| Type | Description |
+| ------------------- | ---------------------------------------- |
+| Array<string> | List of the IDs of the countries and regions supported for the specified language. |
**Example**
```
@@ -201,9 +201,9 @@ Obtains the system region.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------- |
-| string | System region ID.|
+| Type | Description |
+| ------ | ----------------- |
+| string | System region ID. |
**Example**
```
@@ -224,14 +224,14 @@ Sets the system region.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Description |
-| ------ | ------ | ----- |
-| region | string | Region ID.|
+| Name | Type | Description |
+| ------ | ------ | ----------- |
+| region | string | Region ID. |
**Return Value**
-| Type | Description |
-| ------- | ------------------------------------- |
-| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise. |
**Example**
```
@@ -248,9 +248,9 @@ Obtains the system locale.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------- |
-| string | System locale ID.|
+| Type | Description |
+| ------ | ----------------- |
+| string | System locale ID. |
**Example**
```
@@ -271,14 +271,14 @@ Sets the system locale.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Description |
-| ------ | ------ | --------------- |
-| locale | string | System locale ID, for example, **zh-CN**.|
+| Name | Type | Description |
+| ------ | ------ | ---------------------------------------- |
+| locale | string | System locale ID, for example, **zh-CN**. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the operation is successful; returns **false** otherwise.|
+| boolean | Returns **true** if the operation is successful; returns **false** otherwise. |
**Example**
```
@@ -297,15 +297,15 @@ Checks whether the system language matches the specified region.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| -------- | ------ | ---- | ------------- |
-| language | string | Yes | Valid language ID, for example, **zh**.|
-| region | string | No | Valid region ID, for example, **CN**. |
+| Name | Type | Mandatory | Description |
+| -------- | ------ | --------- | --------------------------------------- |
+| language | string | Yes | Valid language ID, for example, **zh**. |
+| region | string | No | Valid region ID, for example, **CN**. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the system language matches the specified region; returns **false** otherwise.|
+| boolean | Returns **true** if the system language matches the specified region; returns **false** otherwise. |
**Example**
```
@@ -322,15 +322,15 @@ Obtains a **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------------------------------------- |
-| locale | string | Yes | Valid locale value, for example, **zh-Hans-CN**. |
-| type | string | No | Valid calendar type. Currently, the valid types are as follows: **buddhist**, **chinese**, **coptic**, **ethiopic**, **hebrew**, **gregory**, **indian**, **islamic\_civil**, **islamic\_tbla**, **islamic\_umalqura**, **japanese**, and **persian**. If this parameter is left unspecified, the default calendar type of the specified locale is used.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| locale | string | Yes | Valid locale value, for example, **zh-Hans-CN**. |
+| type | string | No | Valid calendar type. Currently, the valid types are as follows: **buddhist**, **chinese**, **coptic**, **ethiopic**, **hebrew**, **gregory**, **indian**, **islamic\_civil**, **islamic\_tbla**, **islamic\_umalqura**, **japanese**, and **persian**. If this parameter is left unspecified, the default calendar type of the specified locale is used. |
**Return Value**
-| Type | Description |
-| ---------------------- | ----- |
-| [Calendar](#calendar8) | **Calendar** object.|
+| Type | Description |
+| ---------------------- | -------------------- |
+| [Calendar](#calendar8) | **Calendar** object. |
**Example**
```
@@ -350,9 +350,9 @@ Sets the date for this **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ---- | ---- | ----------------- |
-| date | Date | Yes | Date to be set for the **Calendar** object.|
+| Name | Type | Mandatory | Description |
+| ---- | ---- | --------- | ---------------------------------------- |
+| date | Date | Yes | Date to be set for the **Calendar** object. |
**Example**
```
@@ -371,9 +371,9 @@ Sets the date and time for this **Calendar** object. The value is represented by
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ---------------------------------------- |
-| time | number | Yes | Number of milliseconds that have elapsed since the Unix epoch.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------------------------------- |
+| time | number | Yes | Number of milliseconds that have elapsed since the Unix epoch. |
**Example**
```
@@ -391,14 +391,14 @@ Sets the year, month, day, hour, minute, and second for this **Calendar** object
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ------ |
-| year | number | Yes | Year to set. |
-| month | number | Yes | Month to set. |
-| date | number | Yes | Day to set. |
-| hour | number | No | Hour to set.|
-| minute | number | No | Minute to set.|
-| second | number | No | Second to set. |
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | -------------- |
+| year | number | Yes | Year to set. |
+| month | number | Yes | Month to set. |
+| date | number | Yes | Day to set. |
+| hour | number | No | Hour to set. |
+| minute | number | No | Minute to set. |
+| second | number | No | Second to set. |
**Example**
```
@@ -416,9 +416,9 @@ Sets the time zone of this **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| -------- | ------ | ---- | ------------------------- |
-| timezone | string | Yes | Time zone, for example, **Asia/Shanghai**.|
+| Name | Type | Mandatory | Description |
+| -------- | ------ | --------- | ---------------------------------------- |
+| timezone | string | Yes | Time zone, for example, **Asia/Shanghai**. |
**Example**
```
@@ -436,9 +436,9 @@ Obtains the time zone of this **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ---------- |
-| string | Time zone of the **Calendar** object.|
+| Type | Description |
+| ------ | ------------------------------------- |
+| string | Time zone of the **Calendar** object. |
**Example**
```
@@ -457,9 +457,9 @@ Obtains the start day of a week for this **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | --------------------- |
-| number | Start day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Start day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday. |
**Example**
```
@@ -477,9 +477,9 @@ Sets the start day of a week for this **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | --------------------- |
-| value | number | No | Start day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| value | number | No | Start day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday. |
**Example**
```
@@ -497,9 +497,9 @@ Obtains the minimum number of days in the first week of a year.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------------ |
-| number | Minimum number of days in the first week of a year.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Minimum number of days in the first week of a year. |
**Example**
```
@@ -517,9 +517,9 @@ Sets the minimum number of days in the first week of a year.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | ------------ |
-| value | number | No | Minimum number of days in the first week of a year.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| value | number | No | Minimum number of days in the first week of a year. |
**Example**
```
@@ -537,14 +537,14 @@ Obtains the value of the specified field in the **Calendar** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | ---------------------------------------- |
-| field | string | Yes | Value of the specified field in the **Calendar** object. Currently, a valid field can be any of the following: **era**, **year**, **month**, **week\_of\_year**, **week\_of\_month**, **date**, **day\_of\_year**, **day\_of\_week**, **day\_of\_week\_in\_month**, **hour**, **hour\_of\_day**, **minute**, **second**, **millisecond**, **zone\_offset**, **dst\_offset**, **year\_woy**, **dow\_local**, **extended\_year**, **julian\_day**, **milliseconds\_in\_day**, **is\_leap\_month**.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| field | string | Yes | Value of the specified field in the **Calendar** object. Currently, a valid field can be any of the following: **era**, **year**, **month**, **week\_of\_year**, **week\_of\_month**, **date**, **day\_of\_year**, **day\_of\_week**, **day\_of\_week\_in\_month**, **hour**, **hour\_of\_day**, **minute**, **second**, **millisecond**, **zone\_offset**, **dst\_offset**, **year\_woy**, **dow\_local**, **extended\_year**, **julian\_day**, **milliseconds\_in\_day**, **is\_leap\_month**. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------ | ---------------------------------------- |
-| number | Value of the specified field. For example, if the year in the internal date of this **Calendar** object is **1990**, the **get("year")** function will return **1990**.|
+| number | Value of the specified field. For example, if the year in the internal date of this **Calendar** object is **1990**, the **get("year")** function will return **1990**. |
**Example**
```
@@ -563,14 +563,14 @@ Obtains the name of the **Calendar** object displayed for the specified locale.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------------------------------------- |
-| locale | string | Yes | Locale for which the name of the **Calendar** object is displayed. For example, if **locale** is **en-US**, the name of the Buddhist calendar will be **Buddhist Calendar**.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| locale | string | Yes | Locale for which the name of the **Calendar** object is displayed. For example, if **locale** is **en-US**, the name of the Buddhist calendar will be **Buddhist Calendar**. |
**Return Value**
-| Type | Description |
-| ------ | ------------------- |
-| string | Name of the **Calendar** object displayed for the specified locale.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Name of the **Calendar** object displayed for the specified locale. |
**Example**
```
@@ -588,14 +588,14 @@ Checks whether the specified date in this **Calendar** object is a weekend.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ---- | ---- | ---------------------------------------- |
-| date | Date | No | Specified date in this **Calendar** object. If this parameter is left unspecified, the system checks whether the current date in the **Calendar** object is a weekend.|
+| Name | Type | Mandatory | Description |
+| ---- | ---- | --------- | ---------------------------------------- |
+| date | Date | No | Specified date in this **Calendar** object. If this parameter is left unspecified, the system checks whether the current date in the **Calendar** object is a weekend. |
**Return Value**
-| Type | Description |
-| ------- | ----------------------------------- |
-| boolean | Returns **true** if the date is a weekend; returns **false** if the date is a weekday.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the date is a weekend; returns **false** if the date is a weekday. |
**Example**
```
@@ -619,10 +619,10 @@ Creates a **PhoneNumberFormat** object.
**System capability**: SystemCapability.Global.I18n
Parameters
-| Name | Type | Mandatory | Description |
-| ------- | ---------------------------------------- | ---- | ---------------- |
-| country | string | Yes | Country or region to which the phone number to be formatted belongs.|
-| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | No | Options of the **PhoneNumberFormat** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ---------------------------------------- | --------- | ---------------------------------------- |
+| country | string | Yes | Country or region to which the phone number to be formatted belongs. |
+| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | No | Options of the **PhoneNumberFormat** object. |
**Example**
```
@@ -639,14 +639,14 @@ Checks whether the format of the specified phone number is valid.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | --------- |
-| number | string | Yes | Phone number to be checked.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | --------------------------- |
+| number | string | Yes | Phone number to be checked. |
**Return Value**
-| Type | Description |
-| ------- | ------------------------------------- |
-| boolean | Returns **true** if the phone number format is valid; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the phone number format is valid; returns **false** otherwise. |
**Example**
```
@@ -664,14 +664,14 @@ Formats a phone number.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------- |
-| number | string | Yes | Phone number to be formatted.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ----------------------------- |
+| number | string | Yes | Phone number to be formatted. |
**Return Value**
-| Type | Description |
-| ------ | ---------- |
-| string | Formatted phone number.|
+| Type | Description |
+| ------ | ----------------------- |
+| string | Formatted phone number. |
**Example**
```
@@ -688,15 +688,15 @@ Obtains the home location of a phone number.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------- |
-| number | string | Yes | Phone number.|
-| locale | string | Yes | Locale ID.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ------------- |
+| number | string | Yes | Phone number. |
+| locale | string | Yes | Locale ID. |
**Return value**
-| Type | Description |
-| ------ | ---------- |
-| string | Home location of the phone number.|
+| Type | Description |
+| ------ | ---------------------------------- |
+| string | Home location of the phone number. |
**Example**
```js
@@ -711,9 +711,9 @@ Defines the options for this PhoneNumberFormat object.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| ---- | ------ | ---- | ---- | ---------------------------------------- |
-| type | string | Yes | Yes | Format type of a phone number. The value can be **E164**, **INTERNATIONAL**, **NATIONAL**, or **RFC3966**.|
+| Name | Type | Readable | Writable | Description |
+| ---- | ------ | -------- | -------- | ---------------------------------------- |
+| type | string | Yes | Yes | Format type of a phone number. The value can be **E164**, **INTERNATIONAL**, **NATIONAL**, or **RFC3966**. |
## UnitInfo8+
@@ -722,10 +722,10 @@ Defines the measurement unit information.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| ------------- | ------ | ---- | ---- | ---------------------------------------- |
-| unit | string | Yes | Yes | Name of the measurement unit, for example, **meter**, **inch**, or **cup**.|
-| measureSystem | string | Yes | Yes | Measurement system. The value can be **SI**, **US**, or **UK**.|
+| Name | Type | Readable | Writable | Description |
+| ------------- | ------ | -------- | -------- | ---------------------------------------- |
+| unit | string | Yes | Yes | Name of the measurement unit, for example, **meter**, **inch**, or **cup**. |
+| measureSystem | string | Yes | Yes | Measurement system. The value can be **SI**, **US**, or **UK**. |
## Util8+
@@ -740,18 +740,18 @@ Converts one measurement unit into another and formats the unit based on the spe
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| -------- | ---------------------- | ---- | ---------------------------------------- |
-| fromUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted. |
-| toUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted to. |
-| value | number | Yes | Value of the measurement unit to be converted. |
-| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**. |
-| style | string | No | Style used for formatting. The value can be **long**, **short**, or **medium**.|
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------- | --------- | ---------------------------------------- |
+| fromUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted. |
+| toUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted to. |
+| value | number | Yes | Value of the measurement unit to be converted. |
+| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**. |
+| style | string | No | Style used for formatting. The value can be **long**, **short**, or **medium**. |
**Return Value**
-| Type | Description |
-| ------ | ----------------------- |
-| string | Character string obtained after formatting based on the measurement unit specified by **toUnit**.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Character string obtained after formatting based on the measurement unit specified by **toUnit**. |
**Example**
```
@@ -767,14 +767,14 @@ Obtains the sequence of the year, month, and day in the specified locale.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| -------- | ---------------------- | ---- | ---------------------------------------- |
-| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**. |
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**. |
**Return value**
-| Type | Description |
-| ------ | ----------------------- |
-| string | Sequence of the year, month, and day.|
+| Type | Description |
+| ------ | ------------------------------------- |
+| string | Sequence of the year, month, and day. |
**Example**
```
@@ -790,14 +790,14 @@ Creates an **IndexUtil** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------------------------- |
-| locale | string | No | A string containing locale information, including the language, optional script, and region.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| locale | string | No | A string containing locale information, including the language, optional script, and region. |
**Return Value**
-| Type | Description |
-| ------------------------ | --------------------- |
-| [IndexUtil](#indexutil8) | **IndexUtil** object mapping to the specified locale.|
+| Type | Description |
+| ------------------------ | ---------------------------------------- |
+| [IndexUtil](#indexutil8) | **IndexUtil** object mapping to the specified locale. |
**Example**
```
@@ -817,9 +817,9 @@ Obtains the index list for this **locale** object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------------------- | ------------------ |
-| Array<string> | Index list for this **locale** object.|
+| Type | Description |
+| ------------------- | -------------------------------------- |
+| Array<string> | Index list for this **locale** object. |
**Example**
```
@@ -837,9 +837,9 @@ Adds the index of the new **locale** object to the index list.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------------------------- |
-| locale | string | Yes | A string containing locale information, including the language, optional script, and region.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| locale | string | Yes | A string containing locale information, including the language, optional script, and region. |
**Example**
```
@@ -857,14 +857,14 @@ Obtains the index of a text object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ------------ |
-| text | string | Yes | **text** object whose index is to be obtained.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------------------------------- |
+| text | string | Yes | **text** object whose index is to be obtained. |
**Return Value**
-| Type | Description |
-| ------ | ----------- |
-| string | Index of the **text** object.|
+| Type | Description |
+| ------ | ----------------------------- |
+| string | Index of the **text** object. |
**Example**
```
@@ -885,14 +885,14 @@ Checks whether the input character string is composed of digits.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
-| ------- | ------------------------------------ |
-| boolean | Returns **true** if the input character is a digit; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the input character is a digit; returns **false** otherwise. |
**Example**
```
@@ -909,14 +909,14 @@ Checks whether the input character is a space.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
-| ------- | -------------------------------------- |
-| boolean | Returns **true** if the input character is a space; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the input character is a space; returns **false** otherwise. |
**Example**
```
@@ -933,14 +933,14 @@ Checks whether the input character is a white space.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
-| ------- | -------------------------------------- |
-| boolean | Returns **true** if the input character is a white space; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the input character is a white space; returns **false** otherwise. |
**Example**
```
@@ -957,14 +957,14 @@ Checks whether the input character is of the right to left (RTL) language.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the input character is of the RTL language; returns **false** otherwise.|
+| boolean | Returns **true** if the input character is of the RTL language; returns **false** otherwise. |
**Example**
```
@@ -981,14 +981,14 @@ Checks whether the input character is an ideographic character.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the input character is an ideographic character; returns **false** otherwise.|
+| boolean | Returns **true** if the input character is an ideographic character; returns **false** otherwise. |
**Example**
```
@@ -1005,14 +1005,14 @@ Checks whether the input character is a letter.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
-| ------- | ------------------------------------ |
-| boolean | Returns **true** if the input character is a letter; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the input character is a letter; returns **false** otherwise. |
**Example**
```
@@ -1029,14 +1029,14 @@ Checks whether the input character is a lowercase letter.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the input character is a lowercase letter; returns **false** otherwise.|
+| boolean | Returns **true** if the input character is a lowercase letter; returns **false** otherwise. |
**Example**
```
@@ -1053,14 +1053,14 @@ Checks whether the input character is an uppercase letter.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the input character is an uppercase letter; returns **false** otherwise.|
+| boolean | Returns **true** if the input character is an uppercase letter; returns **false** otherwise. |
**Example**
```
@@ -1077,14 +1077,14 @@ Obtains the type of the input character string.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----- |
-| char | string | Yes | Input character.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------- |
+| char | string | Yes | Input character. |
**Return Value**
-| Type | Description |
-| ------ | ----------- |
-| string | Type of the input character.|
+| Type | Description |
+| ------ | ---------------------------- |
+| string | Type of the input character. |
**Example**
```
@@ -1101,14 +1101,14 @@ Obtains a [BreakIterator](#breakiterator8) object for text segmentation.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------------------------------------- |
-| locale | string | Yes | Valid locale value, for example, **zh-Hans-CN**. The [BreakIterator](#breakiterator8) object segments text according to the rules of the specified locale.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| locale | string | Yes | Valid locale value, for example, **zh-Hans-CN**. The [BreakIterator](#breakiterator8) object segments text according to the rules of the specified locale. |
**Return Value**
-| Type | Description |
-| -------------------------------- | ----------- |
-| [BreakIterator](#breakiterator8) | [BreakIterator](#breakiterator8) object used for text segmentation.|
+| Type | Description |
+| -------------------------------- | ---------------------------------------- |
+| [BreakIterator](#breakiterator8) | [BreakIterator](#breakiterator8) object used for text segmentation. |
**Example**
```
@@ -1128,9 +1128,9 @@ Sets the text to be processed by the [BreakIterator](#breakiterator8) object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ----------------------- |
-| text | string | Yes | Text to be processed by the **BreakIterator** object.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------------------------------- |
+| text | string | Yes | Text to be processed by the **BreakIterator** object. |
**Example**
```
@@ -1148,9 +1148,9 @@ Obtains the text being processed by the [BreakIterator](#breakiterator8) object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ---------------------- |
-| string | Text being processed by the **BreakIterator** object.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Text being processed by the **BreakIterator** object. |
**Example**
```
@@ -1169,9 +1169,9 @@ Obtains the position of the [BreakIterator](#breakiterator8) object in the text
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | --------------------------- |
-| number | Position of the **BreakIterator** object in the text being processed.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Position of the **BreakIterator** object in the text being processed. |
**Example**
```
@@ -1190,9 +1190,9 @@ Puts the [BreakIterator](#breakiterator8) object to the first text boundary, whi
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ----------------- |
-| number | Offset to the first text boundary of the processed text.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Offset to the first text boundary of the processed text. |
**Example**
```
@@ -1211,9 +1211,9 @@ Puts the [BreakIterator](#breakiterator8) object to the last text boundary, whic
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------------------ |
-| number | Offset of the last text boundary of the processed text.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Offset of the last text boundary of the processed text. |
**Example**
```
@@ -1232,14 +1232,14 @@ Moves the [BreakIterator](#breakiterator8) object backward by the specified numb
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | ---------------------------------------- |
-| index | number | No | Number of text boundaries by which the [BreakIterator](#breakiterator8) object is moved. A positive value indicates that the text boundary is moved backward, and a negative value indicates the opposite. If no index is specified, the index will be treated as **1**.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| index | number | No | Number of text boundaries by which the [BreakIterator](#breakiterator8) object is moved. A positive value indicates that the text boundary is moved backward, and a negative value indicates the opposite. If no index is specified, the index will be treated as **1**. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------ | ---------------------------------------- |
-| number | Position of the [BreakIterator](#breakiterator8) object in the text after it is moved by the specified number of text boundaries. The value **-1** is returned if the position of the [BreakIterator](#breakiterator8) object is outside of the processed text after it is moved by the specified number of text boundaries.|
+| number | Position of the [BreakIterator](#breakiterator8) object in the text after it is moved by the specified number of text boundaries. The value **-1** is returned if the position of the [BreakIterator](#breakiterator8) object is outside of the processed text after it is moved by the specified number of text boundaries. |
**Example**
```
@@ -1260,9 +1260,9 @@ Moves the [BreakIterator](#breakiterator8) object to the previous text boundary.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
+| Type | Description |
| ------ | ---------------------------------------- |
-| number | Position of the [BreakIterator](#breakiterator8) object in the text after it is moved to the previous text boundary. The value **-1** is returned if the position of the [BreakIterator](#breakiterator8) object is outside of the processed text after it is moved by the specified number of text boundaries.|
+| number | Position of the [BreakIterator](#breakiterator8) object in the text after it is moved to the previous text boundary. The value **-1** is returned if the position of the [BreakIterator](#breakiterator8) object is outside of the processed text after it is moved by the specified number of text boundaries. |
**Example**
```
@@ -1283,14 +1283,14 @@ Moves the [BreakIterator](#breakiterator8) object to the text boundary after the
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---------------------------------------- |
-| offset | number | Yes | Offset to the position before the text boundary to which the [BreakIterator](#breakiterator8) object is moved.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ---------------------------------------- |
+| offset | number | Yes | Offset to the position before the text boundary to which the [BreakIterator](#breakiterator8) object is moved. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------ | ---------------------------------------- |
-| number | The value **-1** is returned if the text boundary to which the [BreakIterator](#breakiterator8) object is moved is outside of the processed text.|
+| number | The value **-1** is returned if the text boundary to which the [BreakIterator](#breakiterator8) object is moved is outside of the processed text. |
**Example**
```
@@ -1311,14 +1311,14 @@ Checks whether the position specified by the offset is a text boundary. If **tru
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ----------- |
-| offset | number | Yes | Position to check.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ------------------ |
+| offset | number | Yes | Position to check. |
**Return Value**
-| Type | Description |
-| ------- | ------------------------------- |
-| boolean | Returns **true** if the position specified by the offset is a text boundary; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the position specified by the offset is a text boundary; returns **false** otherwise. |
**Example**
```
@@ -1338,9 +1338,9 @@ Checks whether the 24-hour clock is used.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the 24-hour clock is used; returns **false** otherwise.|
+| boolean | Returns **true** if the 24-hour clock is used; returns **false** otherwise. |
**Example**
```
@@ -1359,14 +1359,14 @@ Sets the 24-hour clock.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------- | ---- | ---------------------------------------- |
-| option | boolean | Yes | Whether to enable the 24-hour clock. The value **true** means to enable the 24-hour clock, and the value **false** means the opposite.|
+| Name | Type | Mandatory | Description |
+| ------ | ------- | --------- | ---------------------------------------- |
+| option | boolean | Yes | Whether to enable the 24-hour clock. The value **true** means to enable the 24-hour clock, and the value **false** means the opposite. |
**Return Value**
-| Type | Description |
-| ------- | ----------------------------- |
-| boolean | Returns **true** if the 24-hour clock is enabled; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the 24-hour clock is enabled; returns **false** otherwise. |
**Example**
```
@@ -1386,15 +1386,15 @@ Adds a preferred language to the specified position on the preferred language li
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| -------- | ------ | ---- | ---------- |
-| language | string | Yes | Preferred language to add. |
-| index | number | No | Position to which the preferred language is added.|
+| Name | Type | Mandatory | Description |
+| -------- | ------ | --------- | ---------------------------------------- |
+| language | string | Yes | Preferred language to add. |
+| index | number | No | Position to which the preferred language is added. |
**Return Value**
-| Type | Description |
-| ------- | ----------------------------- |
-| boolean | Returns **true** if the preferred language is successfully added; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the preferred language is successfully added; returns **false** otherwise. |
**Example**
```
@@ -1416,14 +1416,14 @@ Deletes a preferred language from the specified position on the preferred langua
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | --------------------- |
-| index | number | Yes | Position of the preferred language to delete.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| index | number | Yes | Position of the preferred language to delete. |
**Return Value**
-| Type | Description |
-| ------- | ----------------------------- |
-| boolean | Returns **true** if the preferred language is deleted; returns **false** otherwise.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Returns **true** if the preferred language is deleted; returns **false** otherwise. |
**Example**
```
@@ -1442,9 +1442,9 @@ Obtains the list of preferred languages.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------------------- | --------- |
-| Array<string> | List of preferred languages.|
+| Type | Description |
+| ------------------- | ---------------------------- |
+| Array<string> | List of preferred languages. |
**Example**
```
@@ -1461,9 +1461,9 @@ Obtains the first language in the preferred language list.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | -------------- |
-| string | First language in the preferred language list.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | First language in the preferred language list. |
**Example**
```
@@ -1480,14 +1480,14 @@ Obtains the **TimeZone** object corresponding to the specified time zone ID.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ----- |
-| zondID | string | No | Time zone ID.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ------------- |
+| zondID | string | No | Time zone ID. |
**Return Value**
-| Type | Description |
-| -------- | ------------ |
-| TimeZone | **TimeZone** object corresponding to the time zone ID.|
+| Type | Description |
+| -------- | ---------------------------------------- |
+| TimeZone | **TimeZone** object corresponding to the time zone ID. |
**Example**
```
@@ -1507,9 +1507,9 @@ Obtains the ID of the specified **TimeZone** object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------------ |
-| string | Time zone ID corresponding to the **TimeZone** object.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Time zone ID corresponding to the **TimeZone** object. |
**Example**
```
@@ -1527,15 +1527,15 @@ Obtains the representation of a **TimeZone** object in the specified locale.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------- | ---- | -------------------- |
-| locale | string | No | System locale ID. |
-| isDST | boolean | No | Whether to consider DST when obtaining the representation of the **TimeZone** object.|
+| Name | Type | Mandatory | Description |
+| ------ | ------- | --------- | ---------------------------------------- |
+| locale | string | No | System locale ID. |
+| isDST | boolean | No | Whether to consider DST when obtaining the representation of the **TimeZone** object. |
**Return Value**
-| Type | Description |
-| ------ | ------------- |
-| string | Representation of the **TimeZone** object in the specified locale.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Representation of the **TimeZone** object in the specified locale. |
**Example**
```
@@ -1553,9 +1553,9 @@ Obtains the offset between the time zone represented by a **TimeZone** object an
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ------------------- |
-| number | Offset between the time zone represented by the **TimeZone** object and the UTC time zone.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Offset between the time zone represented by the **TimeZone** object and the UTC time zone. |
**Example**
```
@@ -1573,9 +1573,9 @@ Obtains the offset between the time zone represented by a **TimeZone** object an
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ----------------------- |
-| number | Offset between the time zone represented by the **TimeZone** object and the UTC time zone at a certain time point.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| number | Offset between the time zone represented by the **TimeZone** object and the UTC time zone at a certain time point. |
**Example**
```
@@ -1592,9 +1592,9 @@ Obtains the list of time zone IDs supported by the system.
**System capability**: SystemCapability.Global.I18n
**Return value**
-| Type | Description |
-| ------------------- | ----------- |
-| Array<string> | List of time zone IDs supported by the system.|
+| Type | Description |
+| ------------------- | ---------------------------------------- |
+| Array<string> | List of time zone IDs supported by the system. |
**Example**
```ts
@@ -1611,9 +1611,9 @@ Obtains the list of time zone city IDs supported by the system.
**System capability**: SystemCapability.Global.I18n
**Return value**
-| Type | Description |
-| ------------------- | ------------- |
-| Array<string> | List of time zone city IDs supported by the system.|
+| Type | Description |
+| ------------------- | ---------------------------------------- |
+| Array<string> | List of time zone city IDs supported by the system. |
**Example**
```ts
@@ -1630,15 +1630,15 @@ Obtains the localized display of a time zone city in the specified locale.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ------ |
-| cityID | string | Yes | Time zone city ID.|
-| locale | string | Yes | Locale ID. |
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ------------------ |
+| cityID | string | Yes | Time zone city ID. |
+| locale | string | Yes | Locale ID. |
**Return value**
-| Type | Description |
-| ------ | ------------------ |
-| string | Localized display of the time zone city in the specified locale.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | Localized display of the time zone city in the specified locale. |
**Example**
```ts
@@ -1655,14 +1655,14 @@ Obtains the **TimeZone** object corresponding to the specified time zone city ID
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ------ |
-| cityID | string | Yes | Time zone city ID.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ------------------ |
+| cityID | string | Yes | Time zone city ID. |
**Return value**
-| Type | Description |
-| -------- | ----------- |
-| TimeZone | **TimeZone** object corresponding to the specified time zone city ID.|
+| Type | Description |
+| -------- | ---------------------------------------- |
+| TimeZone | **TimeZone** object corresponding to the specified time zone city ID. |
**Example**
```ts
@@ -1683,14 +1683,14 @@ This is a system API.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------- | ---- | ------------------------------- |
-| flag | boolean | Yes | Whether to turn on the local digit switch. The value **true** means to turn on the local digit switch, and the value **false** indicates the opposite.|
+| Name | Type | Mandatory | Description |
+| ---- | ------- | --------- | ---------------------------------------- |
+| flag | boolean | Yes | Whether to turn on the local digit switch. The value **true** means to turn on the local digit switch, and the value **false** indicates the opposite. |
**Return value**
-| Type | Description |
-| ------- | ----------------------------------- |
-| boolean | Result indicating whether the local digit switch is successfully set. The value **true** indicates that the local digit switch is successfully set, and the value **false** indicates the opposite.|
+| Type | Description |
+| ------- | ---------------------------------------- |
+| boolean | Result indicating whether the local digit switch is successfully set. The value **true** indicates that the local digit switch is successfully set, and the value **false** indicates the opposite. |
**Example**
```ts
@@ -1707,9 +1707,9 @@ Checks whether the local digit switch is turned on.
**System capability**: SystemCapability.Global.I18n
**Return value**
-| Type | Description |
+| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Result indicating whether the local digit switch is turned on. The value **true** indicates that the local digit switch is turned on, and the value **false** indicates the opposite.|
+| boolean | Result indicating whether the local digit switch is turned on. The value **true** indicates that the local digit switch is turned on, and the value **false** indicates the opposite. |
**Example**
```ts
@@ -1729,9 +1729,9 @@ Obtains a list of IDs supported by the **Transliterator** object.
**System capability**: SystemCapability.Global.I18n
**Return value**
-| Type | Description |
-| -------- | ---------- |
-| string[] | List of IDs supported by the **Transliterator** object.|
+| Type | Description |
+| -------- | ---------------------------------------- |
+| string[] | List of IDs supported by the **Transliterator** object. |
**Example**
```ts
@@ -1748,14 +1748,14 @@ Creates a **Transliterator** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | -------- |
-| id | string | Yes | ID supported by the **Transliterator** object.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------------------------------- |
+| id | string | Yes | ID supported by the **Transliterator** object. |
**Return value**
-| Type | Description |
-| ---------------------------------- | ----- |
-| [Transliterator](#transliterator9) | **Transliterator** object.|
+| Type | Description |
+| ---------------------------------- | -------------------------- |
+| [Transliterator](#transliterator9) | **Transliterator** object. |
**Example**
```ts
@@ -1772,14 +1772,14 @@ Converts the input string from the source format to the target format.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ------ |
-| text | string | Yes | Input string.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ------------- |
+| text | string | Yes | Input string. |
**Return value**
-| Type | Description |
-| ------ | -------- |
-| string | Target string.|
+| Type | Description |
+| ------ | -------------- |
+| string | Target string. |
**Example**
```ts
diff --git a/en/application-dev/reference/apis/js-apis-intl.md b/en/application-dev/reference/apis/js-apis-intl.md
index b335be1b5cf4826da51120cd2156a64a7cd55bff..f031c80ed8130305078ad3acb7d1801568b56199 100644
--- a/en/application-dev/reference/apis/js-apis-intl.md
+++ b/en/application-dev/reference/apis/js-apis-intl.md
@@ -2,10 +2,10 @@
This module provides basic I18N capabilities, such as time and date formatting, number formatting, and string sorting, through the standard I18N APIs defined in ECMA 402.
-The [I18N](i18n-guidelines.md) module provides enhanced I18N capabilities through supplementary APIs that are not defined in ECMA 402. It works with the Intl module to provide a complete suite of I18N capabilities.
+The [I18N](js-apis-i18n.md) module provides enhanced I18N capabilities through supplementary APIs that are not defined in ECMA 402. It works with the Intl module to provide a complete suite of I18N capabilities.
> **NOTE**
->
+>
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
@@ -23,18 +23,18 @@ import Intl from '@ohos.intl';
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| --------------- | ------- | ---- | ---- | ---------------------------------------- |
-| language | string | Yes | No | Language associated with the locale, for example, **zh**. |
-| script | string | Yes | No | Script type of the language, for example, **Hans**. |
-| region | string | Yes | No | Region associated with the locale, for example, **CN**. |
-| baseName | string | Yes | No | Basic key information about the locale, which consists of the language, script, and region, for example, **zh-Hans-CN**. |
-| caseFirst | string | Yes | No | Whether case is taken into account for the locale's collation rules. The value can be **upper**, **lower**, or **false**.|
-| calendar | string | Yes | No | Calendar for the locale. The value can be any of the following: **buddhist**, **chinese**, **coptic**, **dangi**, **ethioaa**, **ethiopic**, **gregory**, **hebrew**, **indian**, **islamic**, **islamic-umalqura**, **islamic-tbla**, **islamic-civil**, **islamic-rgsa**, **iso8601**, **japanese**, **persian**, **roc**, **islamicc**.|
-| collation | string | Yes | No | Rule for sorting regions. The value can be any of the following: **big5han**, **compat**, **dict**, **direct**, **ducet**, **eor**, **gb2312**, **phonebk**, **phonetic**, **pinyin**, **reformed**, **searchjl**, **stroke**, **trad**, **unihan**, **zhuyin**.|
-| hourCycle | string | Yes | No | Time system for the locale. The value can be any of the following: **h12**, **h23**, **h11**, **h24**.|
-| numberingSystem | string | Yes | No | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**.|
-| numeric | boolean | Yes | No | Whether to apply special collation rules for numeric characters. |
+| Name | Type | Readable | Writable | Description |
+| --------------- | ------- | -------- | -------- | ---------------------------------------- |
+| language | string | Yes | No | Language associated with the locale, for example, **zh**. |
+| script | string | Yes | No | Script type of the language, for example, **Hans**. |
+| region | string | Yes | No | Region associated with the locale, for example, **CN**. |
+| baseName | string | Yes | No | Basic key information about the locale, which consists of the language, script, and region, for example, **zh-Hans-CN**. |
+| caseFirst | string | Yes | No | Whether case is taken into account for the locale's collation rules. The value can be **upper**, **lower**, or **false**. |
+| calendar | string | Yes | No | Calendar for the locale. The value can be any of the following: **buddhist**, **chinese**, **coptic**, **dangi**, **ethioaa**, **ethiopic**, **gregory**, **hebrew**, **indian**, **islamic**, **islamic-umalqura**, **islamic-tbla**, **islamic-civil**, **islamic-rgsa**, **iso8601**, **japanese**, **persian**, **roc**, **islamicc**. |
+| collation | string | Yes | No | Rule for sorting regions. The value can be any of the following: **big5han**, **compat**, **dict**, **direct**, **ducet**, **eor**, **gb2312**, **phonebk**, **phonetic**, **pinyin**, **reformed**, **searchjl**, **stroke**, **trad**, **unihan**, **zhuyin**. |
+| hourCycle | string | Yes | No | Time system for the locale. The value can be any of the following: **h12**, **h23**, **h11**, **h24**. |
+| numberingSystem | string | Yes | No | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**. |
+| numeric | boolean | Yes | No | Whether to apply special collation rules for numeric characters. |
### constructor8+
@@ -60,10 +60,10 @@ Creates a Locale object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | ------------- | ---- | ---------------------------- |
-| locale | string | Yes | A string containing locale information, including the language, optional script, and region.|
-| options | LocaleOptions | No | Options for creating the **Locale** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ------------- | --------- | ---------------------------------------- |
+| locale | string | Yes | A string containing locale information, including the language, optional script, and region. |
+| options | LocaleOptions | No | Options for creating the **Locale** object. |
**Example**
```js
@@ -80,9 +80,9 @@ Converts locale information to a string.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------ | ----------- |
-| string | String containing locale information.|
+| Type | Description |
+| ------ | ------------------------------------- |
+| string | String containing locale information. |
**Example**
```js
@@ -100,9 +100,9 @@ Maximizes information of the **Locale** object. If the script and locale informa
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ----------------- | ---------- |
-| [Locale](#locale) | **Locale** object with the maximized information.|
+| Type | Description |
+| ----------------- | ---------------------------------------- |
+| [Locale](#locale) | **Locale** object with the maximized information. |
**Example**
```js
@@ -120,9 +120,9 @@ Minimizes information of the **Locale** object. If the script and locale informa
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ----------------- | ---------- |
-| [Locale](#locale) | **Locale** object with the minimized information.|
+| Type | Description |
+| ----------------- | ---------------------------------------- |
+| [Locale](#locale) | **Locale** object with the minimized information. |
**Example**
```js
@@ -137,14 +137,14 @@ Represents the locale options.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| --------------- | ------- | ---- | ---- | ---------------------------------------- |
-| calendar | string | Yes | Yes | Calendar for the locale. The calue can be any of the following: **buddhist**, **chinese**, **coptic**, **dangi**, **ethioaa**, **ethiopic**, **gregory**, **hebrew**, **indian**, **islamic**, **islamic-umalqura**, **islamic-tbla**, **islamic-civil**, **islamic-rgsa**, **iso8601**, **japanese**, **persian**, **roc**, **islamicc**.|
-| collation | string | Yes | Yes | Collation rule. The value can be any of the following: **big5han**, **compat**, **dict**, **direct**, **ducet**, **emoji**, **eor**, **gb2312**, **phonebk**, **phonetic**, **pinyin**, **reformed**,**search**, **searchjl**, **standard**, **stroke**, **trad**, **unihan**, **zhuyin**.|
-| hourCycle | string | Yes | Yes | Time system for the locale. The value can be any of the following: **h11**, **h12**, **h23**, **h24**.|
-| numberingSystem | string | Yes | Yes | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**.|
-| numeric | boolean | Yes | Yes | Whether to use the 12-hour clock. |
-| caseFirst | string | Yes | Yes | Whether upper case or lower case is sorted first. The value can be **upper**, **lower**, or **false**.|
+| Name | Type | Readable | Writable | Description |
+| --------------- | ------- | -------- | -------- | ---------------------------------------- |
+| calendar | string | Yes | Yes | Calendar for the locale. The calue can be any of the following: **buddhist**, **chinese**, **coptic**, **dangi**, **ethioaa**, **ethiopic**, **gregory**, **hebrew**, **indian**, **islamic**, **islamic-umalqura**, **islamic-tbla**, **islamic-civil**, **islamic-rgsa**, **iso8601**, **japanese**, **persian**, **roc**, **islamicc**. |
+| collation | string | Yes | Yes | Collation rule. The value can be any of the following: **big5han**, **compat**, **dict**, **direct**, **ducet**, **emoji**, **eor**, **gb2312**, **phonebk**, **phonetic**, **pinyin**, **reformed**,**search**, **searchjl**, **standard**, **stroke**, **trad**, **unihan**, **zhuyin**. |
+| hourCycle | string | Yes | Yes | Time system for the locale. The value can be any of the following: **h11**, **h12**, **h23**, **h24**. |
+| numberingSystem | string | Yes | Yes | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**. |
+| numeric | boolean | Yes | Yes | Whether to use the 12-hour clock. |
+| caseFirst | string | Yes | Yes | Whether upper case or lower case is sorted first. The value can be **upper**, **lower**, or **false**. |
## DateTimeFormat
@@ -173,10 +173,10 @@ Creates a **DateTimeOptions** object for the specified locale.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | ----------------------------------- | ---- | ---------------------------- |
-| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.|
-| options | [DateTimeOptions](#datetimeoptions) | No | Options for creating a **DateTimeFormat** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ----------------------------------- | --------- | ---------------------------------------- |
+| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region. |
+| options | [DateTimeOptions](#datetimeoptions) | No | Options for creating a **DateTimeFormat** object. |
**Example**
```js
@@ -199,14 +199,14 @@ Formats the specified date and time.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ---- | ---- | ------- |
-| date | Date | Yes | Date and time to be formatted.|
+| Name | Type | Mandatory | Description |
+| ---- | ---- | --------- | ------------------------------ |
+| date | Date | Yes | Date and time to be formatted. |
**Return Value**
-| Type | Description |
-| ------ | ------------ |
-| string | A string containing the formatted date and time.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | A string containing the formatted date and time. |
**Example**
```js
@@ -225,15 +225,15 @@ Formats the specified date range.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| --------- | ---- | ---- | -------- |
-| startDate | Date | Yes | Start date and time to be formatted.|
-| endDate | Date | Yes | End date and time to be formatted.|
+| Name | Type | Mandatory | Description |
+| --------- | ---- | --------- | ------------------------------------ |
+| startDate | Date | Yes | Start date and time to be formatted. |
+| endDate | Date | Yes | End date and time to be formatted. |
**Return Value**
-| Type | Description |
-| ------ | -------------- |
-| string | A string containing the formatted date and time range.|
+| Type | Description |
+| ------ | ---------------------------------------- |
+| string | A string containing the formatted date and time range. |
**Example**
```js
@@ -253,9 +253,9 @@ Obtains the formatting options for **DateTimeFormat** object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ----------------------------------- | ----------------------------- |
-| [DateTimeOptions](#datetimeoptions) | Formatting options for **DateTimeFormat** objects.|
+| Type | Description |
+| ----------------------------------- | ---------------------------------------- |
+| [DateTimeOptions](#datetimeoptions) | Formatting options for **DateTimeFormat** objects. |
**Example**
```js
@@ -270,27 +270,27 @@ Provides the options for the **DateTimeFormat** object.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| --------------- | ------- | ---- | ---- | ---------------------------------------- |
-| locale | string | Yes | No | Locale, for example, **zh-Hans-CN**. |
-| dateStyle | string | Yes | Yes | Date display format. The value can be **long**, **short**, **medium**, or **full**.|
-| timeStyle | string | Yes | Yes | Time display format. The value can be **long**, **short**, **medium**, or **full**.|
-| hourCycle | string | Yes | Yes | Time system for the locale. The value can be any of the following: **h11**, **h12**, **h23**, **h24**.|
-| timeZone | string | Yes | Yes | Time zone represented by a valid IANA time zone ID. |
-| numberingSystem | string | Yes | Yes | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**.|
-| hour12 | boolean | Yes | Yes | Whether to use the 12-hour clock. |
-| weekday | string | Yes | Yes | Workday display format. The value can be **long**, **short**, or **narrow**.|
-| era | string | Yes | Yes | Era display format. The value can be **long**, **short**, or **narrow**.|
-| year | string | Yes | Yes | Year display format. The value can be **numeric** or **2-digit**. |
-| month | string | Yes | Yes | Month display format. The value can be any of the following: **numeric**, **2-digit**, **long**, **short**, **narrow**.|
-| day | string | Yes | Yes | Day display format. The value can be **numeric** or **2-digit**. |
-| hour | string | Yes | Yes | Hour display format. The value can be **numeric** or **2-digit**. |
-| minute | string | Yes | Yes | Minute display format. The value can be **numeric** or **2-digit**. |
-| second | string | Yes | Yes | Seconds display format. The value can be **numeric** or **2-digit**. |
-| timeZoneName | string | Yes | Yes | Localized representation of a time zone name. |
-| dayPeriod | string | Yes | Yes | Time period display format. The value can be **long**, **short**, or **narrow**.|
-| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**.|
-| formatMatcher | string | Yes | Yes | Format matching algorithm. The value can be **basic** or **best fit**.|
+| Name | Type | Readable | Writable | Description |
+| --------------- | ------- | -------- | -------- | ---------------------------------------- |
+| locale | string | Yes | No | Locale, for example, **zh-Hans-CN**. |
+| dateStyle | string | Yes | Yes | Date display format. The value can be **long**, **short**, **medium**, or **full**. |
+| timeStyle | string | Yes | Yes | Time display format. The value can be **long**, **short**, **medium**, or **full**. |
+| hourCycle | string | Yes | Yes | Time system for the locale. The value can be any of the following: **h11**, **h12**, **h23**, **h24**. |
+| timeZone | string | Yes | Yes | Time zone represented by a valid IANA time zone ID. |
+| numberingSystem | string | Yes | Yes | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**. |
+| hour12 | boolean | Yes | Yes | Whether to use the 12-hour clock. |
+| weekday | string | Yes | Yes | Workday display format. The value can be **long**, **short**, or **narrow**. |
+| era | string | Yes | Yes | Era display format. The value can be **long**, **short**, or **narrow**. |
+| year | string | Yes | Yes | Year display format. The value can be **numeric** or **2-digit**. |
+| month | string | Yes | Yes | Month display format. The value can be any of the following: **numeric**, **2-digit**, **long**, **short**, **narrow**. |
+| day | string | Yes | Yes | Day display format. The value can be **numeric** or **2-digit**. |
+| hour | string | Yes | Yes | Hour display format. The value can be **numeric** or **2-digit**. |
+| minute | string | Yes | Yes | Minute display format. The value can be **numeric** or **2-digit**. |
+| second | string | Yes | Yes | Seconds display format. The value can be **numeric** or **2-digit**. |
+| timeZoneName | string | Yes | Yes | Localized representation of a time zone name. |
+| dayPeriod | string | Yes | Yes | Time period display format. The value can be **long**, **short**, or **narrow**. |
+| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**. |
+| formatMatcher | string | Yes | Yes | Format matching algorithm. The value can be **basic** or **best fit**. |
## NumberFormat
@@ -319,10 +319,10 @@ Creates a **NumberFormat** object for the specified locale.
**System capability**: SystemCapability.Global.I18n
Parameters
-| Name | Type | Mandatory | Description |
-| ------- | ------------------------------- | ---- | ---------------------------- |
-| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.|
-| options | [NumberOptions](#numberoptions) | No | Options for creating a **NumberFormat** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ------------------------------- | --------- | ---------------------------------------- |
+| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region. |
+| options | [NumberOptions](#numberoptions) | No | Options for creating a **NumberFormat** object. |
**Example**
```js
@@ -339,14 +339,14 @@ Formats a number.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ---- |
-| number | number | Yes | Number to be formatted.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ----------------------- |
+| number | number | Yes | Number to be formatted. |
**Return Value**
-| Type | Description |
-| ------ | ---------- |
-| string | Formatted number.|
+| Type | Description |
+| ------ | ----------------- |
+| string | Formatted number. |
**Example**
@@ -365,9 +365,9 @@ Obtains the options of the **NumberFormat** object.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ------------------------------- | --------------------------- |
-| [NumberOptions](#numberoptions) | Formatting options for **NumberFormat** objects.|
+| Type | Description |
+| ------------------------------- | ---------------------------------------- |
+| [NumberOptions](#numberoptions) | Formatting options for **NumberFormat** objects. |
**Example**
@@ -383,27 +383,27 @@ Provides the device capability.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| ------------------------ | ------- | ---- | ---- | ---------------------------------------- |
-| locale | string | Yes | No | Locale, for example, **zh-Hans-CN**. |
-| currency | string | Yes | Yes | Currency unit, for example, **EUR**, **CNY**, or **USD**. |
-| currencySign | string | Yes | Yes | Currency unit symbol. The value can be **symbol**, **narrowSymbol**, **code**, or **name**.|
-| currencyDisplay | string | Yes | Yes | Currency display mode. The value can be **symbol**, **narrowSymbol**, **code**, or **name**.|
-| unit | string | Yes | Yes | Unit name, for example, **meter**, **inch**, or **hectare**. |
-| unitDisplay | string | Yes | Yes | Unit display format. The value can be **long**, **short**, or **medium**.|
-| unitUsage8+ | string | Yes | Yes | Unit usage scenario. The value can be any of the following: **default**, **area-land-agricult**, **area-land-commercl**, **area-land-residntl**, **length-person**, **length-person-small**, **length-rainfall**, **length-road**, **length-road-small**, **length-snowfall**, **length-vehicle**, **length-visiblty**, **length-visiblty-small**, **length-person-informal**, **length-person-small-informal**, **length-road-informal**, **speed-road-travel**, **speed-wind**, **temperature-person**, **temperature-weather**, **volume-vehicle-fuel**.|
-| signDisplay | string | Yes | Yes | Number sign display format. The value can be **auto**, **never**, **always**, or **expectZero**.|
-| compactDisplay | string | Yes | Yes | Compact display format. The value can be **long** or **short**. |
-| notation | string | Yes | Yes | Number formatting specification. The value can be **standard**, **scientific**, **engineering**, or **compact**.|
-| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**.|
-| style | string | Yes | Yes | Number display format. The value can be **decimal**, **currency**, **percent**, or **unit**.|
-| numberingSystem | string | Yes | Yes | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**.|
-| useGrouping | boolean | Yes | Yes | Whether to use grouping for display. |
-| minimumIntegerDigits | number | Yes | Yes | Minimum number of digits allowed in the integer part of a number. The value ranges from **1** to **21**. |
-| minimumFractionDigits | number | Yes | Yes | Minimum number of digits in the fraction part of a number. The value ranges from **0** to **20**. |
-| maximumFractionDigits | number | Yes | Yes | Maximum number of digits in the fraction part of a number. The value ranges from **1** to **21**. |
-| minimumSignificantDigits | number | Yes | Yes | Minimum number of the least significant digits. The value ranges from **1** to **21**. |
-| maximumSignificantDigits | number | Yes | Yes | Maximum number of the least significant digits. The value ranges from **1** to **21**. |
+| Name | Type | Readable | Writable | Description |
+| ------------------------ | ------- | -------- | -------- | ---------------------------------------- |
+| locale | string | Yes | No | Locale, for example, **zh-Hans-CN**. |
+| currency | string | Yes | Yes | Currency unit, for example, **EUR**, **CNY**, or **USD**. |
+| currencySign | string | Yes | Yes | Currency unit symbol. The value can be **symbol**, **narrowSymbol**, **code**, or **name**. |
+| currencyDisplay | string | Yes | Yes | Currency display mode. The value can be **symbol**, **narrowSymbol**, **code**, or **name**. |
+| unit | string | Yes | Yes | Unit name, for example, **meter**, **inch**, or **hectare**. |
+| unitDisplay | string | Yes | Yes | Unit display format. The value can be **long**, **short**, or **medium**. |
+| unitUsage8+ | string | Yes | Yes | Unit usage scenario. The value can be any of the following: **default**, **area-land-agricult**, **area-land-commercl**, **area-land-residntl**, **length-person**, **length-person-small**, **length-rainfall**, **length-road**, **length-road-small**, **length-snowfall**, **length-vehicle**, **length-visiblty**, **length-visiblty-small**, **length-person-informal**, **length-person-small-informal**, **length-road-informal**, **speed-road-travel**, **speed-wind**, **temperature-person**, **temperature-weather**, **volume-vehicle-fuel**. |
+| signDisplay | string | Yes | Yes | Number sign display format. The value can be **auto**, **never**, **always**, or **expectZero**. |
+| compactDisplay | string | Yes | Yes | Compact display format. The value can be **long** or **short**. |
+| notation | string | Yes | Yes | Number formatting specification. The value can be **standard**, **scientific**, **engineering**, or **compact**. |
+| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**. |
+| style | string | Yes | Yes | Number display format. The value can be **decimal**, **currency**, **percent**, or **unit**. |
+| numberingSystem | string | Yes | Yes | Numbering system for the locale. The value can be any of the following: **adlm**, **ahom**, **arab**, **arabext**, **bali**, **beng**, **bhks**, **brah**, **cakm**, **cham**, **deva**, **diak**, **fullwide**, **gong**, **gonm**, **gujr**, **guru**, **hanidec**, **hmng**, **hmnp**, **java**, **kali**, **khmr**, **knda**, **lana**, **lanatham**, **laoo**, **latn**, **lepc**, **limb**, **mathbold**, **mathdbl**, **mathmono**, **mathsanb**, **mathsans**, **mlym**, **modi**, **mong**, **mroo**, **mtei**, **mymr**, **mymrshan**, **mymrtlng**, **newa**, **nkoo**, **olck**, **orya**, **osma**, **rohg**, **saur**, **segment**, **shrd**, **sind**, **sinh**, **sora**, **sund**, **takr**, **talu**, **tamldec**, **telu**, **thai**, **tibt**, **tirh**, **vaii**, **wara**, **wcho**. |
+| useGrouping | boolean | Yes | Yes | Whether to use grouping for display. |
+| minimumIntegerDigits | number | Yes | Yes | Minimum number of digits allowed in the integer part of a number. The value ranges from **1** to **21**. |
+| minimumFractionDigits | number | Yes | Yes | Minimum number of digits in the fraction part of a number. The value ranges from **0** to **20**. |
+| maximumFractionDigits | number | Yes | Yes | Maximum number of digits in the fraction part of a number. The value ranges from **1** to **21**. |
+| minimumSignificantDigits | number | Yes | Yes | Minimum number of the least significant digits. The value ranges from **1** to **21**. |
+| maximumSignificantDigits | number | Yes | Yes | Maximum number of the least significant digits. The value ranges from **1** to **21**. |
## Collator8+
@@ -433,10 +433,10 @@ Creates a Collator object.
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | ----------------------------------- | ---- | ---------------------------- |
-| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.|
-| options | [CollatorOptions](#collatoroptions) | No | Options for creating a **Collator** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ----------------------------------- | --------- | ---------------------------------------- |
+| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region. |
+| options | [CollatorOptions](#collatoroptions) | No | Options for creating a **Collator** object. |
**Example**
```js
@@ -453,15 +453,15 @@ Compares two strings based on the sorting policy of the **Collator** object.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ------ | ---- | ------------ |
-| first | string | Yes | First string to compare. |
-| second | string | Yes | Second string to compare.|
+| Name | Type | Mandatory | Description |
+| ------ | ------ | --------- | ------------------------- |
+| first | string | Yes | First string to compare. |
+| second | string | Yes | Second string to compare. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------ | ---------------------------------------- |
-| number | Comparison result. If the value is a negative number, the first string is before the second string. If the value of number is **0**, the first string is equal to the second string. If the value of number is a positive number, the first string is after the second string.|
+| number | Comparison result. If the value is a negative number, the first string is before the second string. If the value of number is **0**, the first string is equal to the second string. If the value of number is a positive number, the first string is after the second string. |
**Example**
```js
@@ -479,9 +479,9 @@ Returns properties reflecting the locale and collation options of a **Collator**
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ----------------------------------- | ----------------- |
-| [CollatorOptions](#collatoroptions) | Properties of the **Collator** object.|
+| Type | Description |
+| ----------------------------------- | -------------------------------------- |
+| [CollatorOptions](#collatoroptions) | Properties of the **Collator** object. |
**Example**
```js
@@ -496,15 +496,15 @@ Represents the properties of a **Collator** object.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| ----------------- | ------- | ---- | ---- | ---------------------------------------- |
-| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**.|
-| usage | string | Yes | Yes | Whether the comparison is for sorting or for searching. The value can be **sort** or **search**. |
-| sensitivity | string | Yes | Yes | Differences in the strings that lead to non-zero return values. The value can be **base**, **accent**, **case**, or **variant**.|
-| ignorePunctuation | boolean | Yes | Yes | Whether punctuation is ignored. The value can be **true** or **false**. |
-| collation | string | Yes | Yes | Rule for sorting regions. The value can be any of the following: **big5han**, **compat**, **dict**, **direct**, **ducet**, **eor**, **gb2312**, **phonebk**, **phonetic**, **pinyin**, **reformed**, **searchjl**, **stroke**, **trad**, **unihan**, **zhuyin**.|
-| numeric | boolean | Yes | Yes | Whether numeric collation is used. The value can be **true** or **false**. |
-| caseFirst | string | Yes | Yes | Whether upper case or lower case is sorted first. The value can be **upper**, **lower**, or **false**.|
+| Name | Type | Readable | Writable | Description |
+| ----------------- | ------- | -------- | -------- | ---------------------------------------- |
+| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**. |
+| usage | string | Yes | Yes | Whether the comparison is for sorting or for searching. The value can be **sort** or **search**. |
+| sensitivity | string | Yes | Yes | Differences in the strings that lead to non-zero return values. The value can be **base**, **accent**, **case**, or **variant**. |
+| ignorePunctuation | boolean | Yes | Yes | Whether punctuation is ignored. The value can be **true** or **false**. |
+| collation | string | Yes | Yes | Rule for sorting regions. The value can be any of the following: **big5han**, **compat**, **dict**, **direct**, **ducet**, **eor**, **gb2312**, **phonebk**, **phonetic**, **pinyin**, **reformed**, **searchjl**, **stroke**, **trad**, **unihan**, **zhuyin**. |
+| numeric | boolean | Yes | Yes | Whether numeric collation is used. The value can be **true** or **false**. |
+| caseFirst | string | Yes | Yes | Whether upper case or lower case is sorted first. The value can be **upper**, **lower**, or **false**. |
## PluralRules8+
@@ -533,10 +533,10 @@ Create a **PluralRules** object.
**System capability**: SystemCapability.Global.I18n
Parameters
-| Name | Type | Mandatory | Description |
-| ------- | ---------------------------------------- | ---- | ---------------------------- |
-| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.|
-| options | [PluralRulesOptions](#pluralrulesoptions) | No | Options for creating a **PluralRules** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ---------------------------------------- | --------- | ---------------------------------------- |
+| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region. |
+| options | [PluralRulesOptions](#pluralrulesoptions) | No | Options for creating a **PluralRules** object. |
**Example**
```js
@@ -553,14 +553,14 @@ Obtains a string that represents the singular-plural type of the specified numbe
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ---- | ------ | ---- | ------------ |
-| n | number | Yes | Number for which the singular-plural type is to be obtained.|
+| Name | Type | Mandatory | Description |
+| ---- | ------ | --------- | ---------------------------------------- |
+| n | number | Yes | Number for which the singular-plural type is to be obtained. |
**Return Value**
-| Type | Description |
+| Type | Description |
| ------ | ---------------------------------------- |
-| string | Singular-plural type. The value can be any of the following: **one**, **two**, **few**, **many**, **others**.|
+| string | Singular-plural type. The value can be any of the following: **one**, **two**, **few**, **many**, **others**. |
**Example**
```js
@@ -575,15 +575,15 @@ Represents the properties of a **PluralRules** object.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
-| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**.|
-| type | string | Yes | Yes | Sorting type. The value can be **cardinal** or **ordinal**. |
-| minimumIntegerDigits | number | Yes | Yes | Minimum number of digits allowed in the integer part of a number. The value ranges from **1** to **21**. |
-| minimumFractionDigits | number | Yes | Yes | Minimum number of digits in the fraction part of a number. The value ranges from **0** to **20**. |
-| maximumFractionDigits | number | Yes | Yes | Maximum number of digits in the fraction part of a number. The value ranges from **1** to **21**. |
-| minimumSignificantDigits | number | Yes | Yes | Minimum number of the least significant digits. The value ranges from **1** to **21**. |
-| maximumSignificantDigits | number | Yes | Yes | Maximum number of the least significant digits. The value ranges from **1** to **21**. |
+| Name | Type | Readable | Writable | Description |
+| ------------------------ | ------ | -------- | -------- | ---------------------------------------- |
+| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**. |
+| type | string | Yes | Yes | Sorting type. The value can be **cardinal** or **ordinal**. |
+| minimumIntegerDigits | number | Yes | Yes | Minimum number of digits allowed in the integer part of a number. The value ranges from **1** to **21**. |
+| minimumFractionDigits | number | Yes | Yes | Minimum number of digits in the fraction part of a number. The value ranges from **0** to **20**. |
+| maximumFractionDigits | number | Yes | Yes | Maximum number of digits in the fraction part of a number. The value ranges from **1** to **21**. |
+| minimumSignificantDigits | number | Yes | Yes | Minimum number of the least significant digits. The value ranges from **1** to **21**. |
+| maximumSignificantDigits | number | Yes | Yes | Maximum number of the least significant digits. The value ranges from **1** to **21**. |
## RelativeTimeFormat8+
@@ -612,10 +612,10 @@ Creates a **RelativeTimeFormat** object.
**System capability**: SystemCapability.Global.I18n
Parameters
-| Name | Type | Mandatory | Description |
-| ------- | ---------------------------------------- | ---- | ---------------------------- |
-| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.|
-| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | No | Options for creating a **RelativeTimeFormat** object. |
+| Name | Type | Mandatory | Description |
+| ------- | ---------------------------------------- | --------- | ---------------------------------------- |
+| locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region. |
+| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | No | Options for creating a **RelativeTimeFormat** object. |
**Example**
```js
@@ -632,15 +632,15 @@ Formats the value and unit based on the specified locale and formatting options.
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | ---------------------------------------- |
-| value | number | Yes | Value to format. |
-| unit | string | Yes | Unit to format. The value can be any of the following: **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, **second**.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| value | number | Yes | Value to format. |
+| unit | string | Yes | Unit to format. The value can be any of the following: **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, **second**. |
**Return Value**
-| Type | Description |
-| ------ | ---------- |
-| string | Relative time after formatting.|
+| Type | Description |
+| ------ | ------------------------------- |
+| string | Relative time after formatting. |
**Example**
```js
@@ -658,15 +658,15 @@ Returns an array of RelativeTimeFormat objects in parts for locale-aware formatt
**System capability**: SystemCapability.Global.I18n
**Parameters**
-| Name | Type | Mandatory | Description |
-| ----- | ------ | ---- | ---------------------------------------- |
-| value | number | Yes | Value to format. |
-| unit | string | Yes | Unit to format. The value can be any of the following: **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, **second**.|
+| Name | Type | Mandatory | Description |
+| ----- | ------ | --------- | ---------------------------------------- |
+| value | number | Yes | Value to format. |
+| unit | string | Yes | Unit to format. The value can be any of the following: **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, **second**. |
**Return Value**
-| Type | Description |
-| ------------------- | --------------------------- |
-| Array<object> | An array of **RelativeTimeFormat** objects in parts.|
+| Type | Description |
+| ------------------- | ---------------------------------------- |
+| Array<object> | An array of **RelativeTimeFormat** objects in parts. |
**Example**
```js
@@ -684,9 +684,9 @@ Obtains the formatting options for **RelativeTimeFormat** objects.
**System capability**: SystemCapability.Global.I18n
**Return Value**
-| Type | Description |
-| ---------------------------------------- | --------------------------------- |
-| [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | Formatting options for **RelativeTimeFormat** objects.|
+| Type | Description |
+| ---------------------------------------- | ---------------------------------------- |
+| [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | Formatting options for **RelativeTimeFormat** objects. |
**Example**
```js
@@ -701,11 +701,11 @@ Represents the properties of a **RelativeTimeFormat** object.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| ------------- | ------ | ---- | ---- | ---------------------------------------- |
-| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**.|
-| numeric | string | Yes | Yes | Format of the output message. The value can be **always** or **auto**. |
-| style | string | Yes | Yes | Length of an internationalized message. The value can be **long**, **short**, or **narrow**.|
+| Name | Type | Readable | Writable | Description |
+| ------------- | ------ | -------- | -------- | ---------------------------------------- |
+| localeMatcher | string | Yes | Yes | Locale matching algorithm. The value can be **lookup** or **best fit**. |
+| numeric | string | Yes | Yes | Format of the output message. The value can be **always** or **auto**. |
+| style | string | Yes | Yes | Length of an internationalized message. The value can be **long**, **short**, or **narrow**. |
## RelativeTimeFormatResolvedOptions8+
@@ -714,9 +714,9 @@ Represents the properties of a **RelativeTimeFormat** object.
**System capability**: SystemCapability.Global.I18n
-| Name | Type | Readable | Writable | Description |
-| --------------- | ------ | ---- | ---- | ---------------------------------------- |
-| locale | string | Yes | Yes | A string containing locale information, including the language, optional script, and region. |
-| numeric | string | Yes | Yes | Format of the output message. The value can be **always** or **auto**. |
-| style | string | Yes | Yes | Length of an internationalized message. The value can be **long**, **short**, or **narrow**.|
-| numberingSystem | string | Yes | Yes | Numbering system. |
+| Name | Type | Readable | Writable | Description |
+| --------------- | ------ | -------- | -------- | ---------------------------------------- |
+| locale | string | Yes | Yes | A string containing locale information, including the language, optional script, and region. |
+| numeric | string | Yes | Yes | Format of the output message. The value can be **always** or **auto**. |
+| style | string | Yes | Yes | Length of an internationalized message. The value can be **long**, **short**, or **narrow**. |
+| numberingSystem | string | Yes | Yes | Numbering system. |
diff --git a/en/application-dev/reference/apis/js-apis-settings.md b/en/application-dev/reference/apis/js-apis-settings.md
index 4026b305b254548a1b3ce815b4298cf6e858129f..58ebced38d920c204749c1829ddf12950b5acbfc 100644
--- a/en/application-dev/reference/apis/js-apis-settings.md
+++ b/en/application-dev/reference/apis/js-apis-settings.md
@@ -1,21 +1,481 @@
# Settings
-> **NOTE**
-> The initial APIs of this module are supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.
-
-
-This module provides APIs for setting data items.
+The **settings** module provides APIs for setting data items.
+> **NOTE**
+>
+> The initial APIs of this module are supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
## Modules to Import
-```typescript
+```js
import settings from '@ohos.settings';
```
+## date
+
+Provides data items for setting the time and date formats.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
+| DATE_FORMAT | string | Yes | Yes | Date format. The value can be **mm/dd/yyyy**, **dd/mm/yyyy**, or **yyyy/mm/dd**, where **mm** indicates the month, **dd** indicates the day, and **yyyy** indicates the year.|
+| TIME_FORMAT | string | Yes | Yes | Time format. **12**: 12-hour format. **24**: 24-hour format.|
+| AUTO_GAIN_TIME | string | Yes | Yes | Whether the date, time, and time zone are automatically obtained from the Network Identity and Time Zone (NITZ). The value **true** means that the date, time, and time zone are automatically obtained from NITZ; and **false** means the opposite.|
+| AUTO_GAIN_TIME_ZONE | string | Yes | Yes | Whether the time zone is automatically obtained from NITZ. The value **true** means that the time zone is automatically obtained from NITZ; and **false** means the opposite.|
+
+## display
+
+Provides data items for setting the display effects.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ----------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
+| FONT_SCALE | string | Yes | Yes | Scale factor of the font. The value is a floating point number. |
+| SCREEN_BRIGHTNESS_STATUS | string | Yes | Yes | Screen brightness. The value ranges from 0 to 255. |
+| AUTO_SCREEN_BRIGHTNESS | string | Yes | Yes | Whether automatic screen brightness adjustment is enabled. **AUTO_SCREEN_BRIGHTNESS_MODE**: Automatic screen brightness adjustment is enabled. **MANUAL_SCREEN_BRIGHTNESS_MODE**: Automatic screen brightness adjustment is disabled.|
+| AUTO_SCREEN_BRIGHTNESS_MODE | number | Yes | Yes | Value of **AUTO_SCREEN_BRIGHTNESS** when automatic screen brightness adjustment is enabled. |
+| MANUAL_SCREEN_BRIGHTNESS_MODE | number | Yes | Yes | Value of **AUTO_SCREEN_BRIGHTNESS** when automatic screen brightness adjustment is disabled. |
+| SCREEN_OFF_TIMEOUT | string | Yes | Yes | Waiting time for the device to enter the sleep state when not in use (unit: ms). |
+| DEFAULT_SCREEN_ROTATION | string | Yes | Yes | Rotation angle. This attribute is valid only when screen auto-rotation is disabled. **0**: The screen rotates by 0 degrees. **1**: The screen rotates by 90 degrees. **2**: The screen rotates by 180 degrees. **3**: The screen rotates by 270 degrees.|
+| ANIMATOR_DURATION_SCALE | string | Yes | Yes | Scale factor for the animation duration. This affects the start delay and duration of all such animations. If the value is **0**, the animation ends immediately. The default value is **1**.|
+| TRANSITION_ANIMATION_SCALE | string | Yes | Yes | Scale factor for transition animations. The value **0** indicates that the transition animations are disabled. |
+| WINDOW_ANIMATION_SCALE | string | Yes | Yes | Scale factor for normal window animations. The value **0** indicates that window animations are disabled. |
+| DISPLAY_INVERSION_STATUS | string | Yes | Yes | Whether display color inversion is enabled. **1**: Display color inversion is enabled. **0**: Display color inversion is disabled.|
+
+## general
+
+Provides data items for setting the general information about the device.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| -------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
+| SETUP_WIZARD_FINISHED | string | Yes | Yes | Whether the startup wizard is running. If the value is **0**, the startup wizard is not running. If the value is not **0**, the startup wizard is running.|
+| END_BUTTON_ACTION | string | Yes | Yes | Action after the call end button is pressed if the user is not in a call. **0**: Nothing happens. **1**: The home screen is displayed. **2**: The device enters sleep mode and the screen is locked. **3**: The home screen is displayed. If the focus is already on the home screen, the device will enter sleep mode.|
+| ACCELEROMETER_ROTATION_STATUS | string | Yes | Yes | Whether the accelerometer is used to change screen orientation, that is, whether to enable auto-rotation. **1**: The accelerometer is used. **0**: The accelerometer is not used.|
+| AIRPLANE_MODE_STATUS | string | Yes | Yes | Whether airplane mode is enabled. **1**: Airplane mode is enabled. **0**: Airplane mode is disabled.|
+| DEVICE_PROVISION_STATUS | string | Yes | Yes | Whether the device is preconfigured. On a multi-user device with a single system user, the screen may be locked when the value is **true**. In addition, other features cannot be started on the system user unless they are marked to display on the lock screen.|
+| HDC_STATUS | string | Yes | Yes | Whether the hard disk controller (HDC) on the USB device is enabled. **true**: HDC is enabled. **false**: HDC is disabled.|
+| BOOT_COUNTING | string | Yes | Yes | Number of boot operations after the device is powered on. |
+| CONTACT_METADATA_SYNC_STATUS | string | Yes | Yes | Whether contacts metadata synchronization is enabled. **true**: Contacts metadata synchronization is enabled. **false**: Contacts metadata synchronization is disabled.|
+| DEVELOPMENT_SETTINGS_STATUS | string | Yes | Yes | Whether developer options are enabled. **true**: Developer options are enabled. **false**: Developer options are disabled.|
+| DEVICE_NAME | string | Yes | Yes | Device name. |
+| USB_STORAGE_STATUS | string | Yes | Yes | Whether USB mass storage is enabled. **true**: USB mass storage is enabled. **false**: USB mass storage is disabled.|
+| DEBUGGER_WAITING | string | Yes | Yes | Whether the device waits for the debugger when starting an application to debug. **1**: The device waits for the debugger. **0**: The device does not wait for the debugger. In this case, the application runs normally.|
+| DEBUG_APP_PACKAGE | string | Yes | Yes | Bundle name of the application to be debugged. |
+| ACCESSIBILITY_STATUS | string | Yes | Yes | Whether accessibility is enabled. **1**: Accessibility is enabled. **0**: Accessibility is disabled.|
+| ACTIVATED_ACCESSIBILITY_SERVICES | string | Yes | Yes | List of activated accessibility features. |
+| GEOLOCATION_ORIGINS_ALLOWED | string | Yes | Yes | Default geographic location that can be used by the browser. Multiple geographic locations are separated by spaces. |
+| SKIP_USE_HINTS | string | Yes | Yes | Whether the application should attempt to skip all introductory hints at the first startup. This feature is intended for temporary or experienced users. **1**: The application attempts to skip all introductory hints at the first startup. **0**: The application does not skip all introductory hints at the first startup.|
+| TOUCH_EXPLORATION_STATUS | string | Yes | Yes | Whether touch exploration is enabled. **1**: Touch exploration is enabled. **0**: Touch exploration is disabled.|
+
+## input
+
+Provides data items for setting input methods.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ------------------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
+| DEFAULT_INPUT_METHOD | string | Yes | Yes | Default input method and its ID. |
+| ACTIVATED_INPUT_METHOD_SUB_MODE | string | Yes | Yes | Type and ID of the default input method keyboard. |
+| ACTIVATED_INPUT_METHODS | string | Yes | Yes | List of activated input methods. The list is a string that contains the IDs and keyboard types of activated input methods. The IDs are separated by colons (:), and keyboard types are separated by semicolons (;). An example format is **ima0:keyboardType0;keyboardType1;ima1:ima2:keyboardTypes0,** where **ima** indicates the ID of an input method, and **keyboardType** indicates the keyboard type.|
+| SELECTOR_VISIBILITY_FOR_INPUT_METHOD | string | Yes | Yes | Whether the input method selector is visible. **1**: The input method selector is visible. **0**: The input method selector is invisible.|
+| AUTO_CAPS_TEXT_INPUT | string | Yes | Yes | Whether automatic capitalization is enabled for the text editor. **0**: Automatic capitalization is disabled. **1**: Automatic capitalization is enabled.|
+| AUTO_PUNCTUATE_TEXT_INPUT | string | Yes | Yes | Whether automatic punctuation is enabled for the text editor. Automatic punctuation enables the text editor to convert two spaces into a period (.) and a space. **0**: Automatic punctuation is disabled. **1**: Automatic punctuation is enabled.|
+| AUTO_REPLACE_TEXT_INPUT | string | Yes | Yes | Whether autocorrect is enabled for the text editor. Autocorrect enables the text editor to correct typos. **0**: Autocorrect is disabled. **1**: Autocorrect is enabled |
+| SHOW_PASSWORD_TEXT_INPUT | string | Yes | Yes | Whether password presentation is enabled in the text editor. Password presentation enables the text editor to show password characters when the user types them. **0**: Password presentation is disabled. **1**: Password presentation is enabled.|
+
+## network
+
+Provides data items for setting network information.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ------------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
+| DATA_ROAMING_STATUS | string | Yes | Yes | Whether data roaming is enabled. **true**: Data roaming is enabled. **false**: Data roaming is disabled.|
+| HTTP_PROXY_CFG | string | Yes | Yes | Host name and port number of the global HTTP proxy. The host name and port number are separated by a colon (:).|
+| NETWORK_PREFERENCE_USAGE | string | Yes | Yes | User preferences for the network to use. |
+
+## phone
+
+Provides data items for setting the modes of answering incoming and outgoing calls.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ------------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
+| RTT_CALLING_STATUS | string | Yes | Yes | Whether the real-time text (RTT) feature is enabled. If this feature is enabled, incoming and outgoing calls are answered as RTT calls when supported by the device and carrier. **1**: RTT is enabled. **0**: RTT is disabled.|
+
+## sound
+
+Provides data items for setting the sound effects.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ---------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
+| VIBRATE_WHILE_RINGING | string | Yes | Yes | Whether the device vibrates when it is ringing for an incoming call. This attribute is applicable to the phone and settings applications and affects only the scenario where the device rings for an incoming call. It does not affect any other application or scenario.|
+| DEFAULT_ALARM_ALERT | string | Yes | Yes | Storage area of the system default alarms and alerts. |
+| DTMF_TONE_TYPE_WHILE_DIALING | string | Yes | Yes | Type of the dual tone multi-frequency (DTMF) tone played while dialing. **0**: normal short tone. **1**: long tone.|
+| DTMF_TONE_WHILE_DIALING | string | Yes | Yes | Whether the DTMF tone is played when dialing. **1**: DTMF tone is played when dialing. **0**: DTMF tone is not played when dialing.|
+| AFFECTED_MODE_RINGER_STREAMS | string | Yes | Yes | Which audio streams are affected by changes on the ringing mode and Do Not Disturb (DND) mode. If you want a specific audio stream to be affected by changes of the ringing mode and DDN mode, set the corresponding bit to **1**.|
+| AFFECTED_MUTE_STREAMS | string | Yes | Yes | Audio streams affected by the mute mode. If you want a specific audio stream to remain muted in mute mode, set the corresponding bit to **1**.|
+| DEFAULT_NOTIFICATION_SOUND | string | Yes | Yes | Storage area of the system default notification tone. |
+| DEFAULT_RINGTONE | string | Yes | Yes | Storage area of the system default ringtone. |
+| SOUND_EFFECTS_STATUS | string | Yes | Yes | Whether the sound feature is available. **0**: The feature is not available. **1**: The feature is available. |
+| VIBRATE_STATUS | string | Yes | Yes | Whether the device vibrates for an event. This attribute is used inside the system. **1**: The device vibrates for an event. **0**: The device does not vibrate for an event.|
+| HAPTIC_FEEDBACK_STATUS | string | Yes | Yes | Whether haptic feedback is enabled. **true**: Haptic feedback is enabled. **false**: Haptic feedback is disabled.|
+
+## TTS
+
+Provides data items for setting text-to-speech (TTS) information.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| ------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
+| DEFAULT_TTS_PITCH | string | Yes | Yes | Default pitch of the TTS engine. 100 = 1x. If the value is set to **200**, the frequency is twice the normal sound frequency.|
+| DEFAULT_TTS_RATE | string | Yes | Yes | Default voice rate of the TTS engine. 100 = 1x. |
+| DEFAULT_TTS_SYNTH | string | Yes | Yes | Default TTS engine. |
+| ENABLED_TTS_PLUGINS | string | Yes | Yes | List of activated plug-in packages used for TTS. Multiple plug-in packages are separated by spaces. |
+
+
+## wireless
+
+Provides data items for setting wireless network information.
+
+### Attributes
+
+**System capability**: SystemCapability.Applications.settings.Core
+
+| Name | Type | Readable| Writable| Description |
+| --------------------------------- | ------ | ---- | ---- | ------------------------------------------------------------ |
+| BLUETOOTH_DISCOVER_ABILITY_STATUS | string | Yes | Yes | Whether the device can be discovered or connected by other devices through Bluetooth. **0**: The device cannot be discovered or connected. **1**: The device can be connected but cannot be discovered. **2**: The device can be discovered and connected.|
+| BLUETOOTH_DISCOVER_TIMEOUT | string | Yes | Yes | Duration for discovering a device through Bluetooth, in seconds. After the duration expires, the device cannot be discovered through Bluetooth.|
+| AIRPLANE_MODE_RADIOS | string | Yes | Yes | List of radio signals to be disabled when airplane mode is enabled. Multiple radio signals are separated by commas (,). The list can include the following: **BLUETOOTH_RADIO**, **CELL_RADIO**, **NFC_RADIO**, and **WIFI_RADIO**.|
+| BLUETOOTH_RADIO | string | Yes | No | A value of **AIRPLANE_MODE_RADIOS** to indicate that Bluetooth is disabled in airplane mode.|
+| CELL_RADIO | string | Yes | No | A value of **AIRPLANE_MODE_RADIOS** to indicate that cellular radio is disabled in airplane mode.|
+| NFC_RADIO | string | Yes | No | A value of **AIRPLANE_MODE_RADIOS** to indicate that NFC is disabled in airplane mode.|
+| WIFI_RADIO | string | Yes | No | A value of **AIRPLANE_MODE_RADIOS** to indicate that Wi-Fi is disabled in airplane mode.|
+| BLUETOOTH_STATUS | string | Yes | Yes | Whether Bluetooth is available. **true**: Bluetooth is available. **false**: Bluetooth is unavailable.|
+| OWNER_LOCKDOWN_WIFI_CFG | string | Yes | Yes | Whether the Wi-Fi configuration created by the application of the device owner should be locked down. **true**: The Wi-Fi configuration should be locked down. **false**: The Wi-Fi configuration should not be locked down.|
+| WIFI_DHCP_MAX_RETRY_COUNT | string | Yes | Yes | Maximum number of attempts to obtain an IP address from the DHCP server. |
+| WIFI_TO_MOBILE_DATA_AWAKE_TIMEOUT | string | Yes | Yes | Maximum duration to hold a wake lock when waiting for the mobile data connection to establish after the Wi-Fi connection is disconnected. |
+| WIFI_STATUS | string | Yes | Yes | Whether Wi-Fi is available. **true**: Wi-Fi is available. **false**: Wi-Fi is unavailable.|
+| WIFI_WATCHDOG_STATUS | string | Yes | Yes | Whether Wi-Fi watchdog is available. **true**: Wi-Fi watchdog is available. **false**: Wi-Fi watchdog is unavailable.|
+
+## setting.getURI
+
+getURI(name: string, callback: AsyncCallback\