Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“7ad906d81734df1a1fe56a7ab2cf0cb97ddaa20e”上不存在“make/git@gitcode.net:openanolis/dragonwell8_hotspot.git”
未验证 提交 be97c0c1 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10408 update interface description of i18n 

Merge pull request !10408 from sunyaozu/master
上级 bd6f963f 826d93b0
显示空白变更内容
内联 并排
Showing with 1159 addition and 690 deletion
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @ be97c0c1
...@@ -16,11 +16,13 @@ import i18n from '@ohos.i18n'; ...@@ -16,11 +16,13 @@ import i18n from '@ohos.i18n';
``` ```
## i18n.getDisplayLanguage ## System<sup>9+</sup>
getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string ### getDisplayCountry<sup>9+</sup>
获取指定语言的本地化显示文本。 static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string
获取指定国家的本地化显示文本。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
...@@ -28,28 +30,38 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st ...@@ -28,28 +30,38 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------- | ---- | ---------------- | | ------------ | ------- | ---- | ---------------- |
| language | string | 是 | 指定语言。 | | country | string | 是 | 指定国家。 |
| locale | string | 是 | 显示指定语言的区域ID。 | | locale | string | 是 | 显示指定国家的区域ID。 |
| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------- | | ------ | ------------- |
| string | 指定语言的本地化显示文本。 | | string | 指定国家的本地化显示文本。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getDisplayLanguage("zh", "en-GB", true); try {
i18n.getDisplayLanguage("zh", "en-GB"); var displayCountry = i18n.System.getDisplayCountry("zh-CN", "en-GB");
} catch(error) {
console.error(`call System.getDisplayCountry failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getDisplayLanguage<sup>9+</sup>
## i18n.getDisplayCountry static getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string
getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string
获取指定国家的本地化显示文本。 获取指定语言的本地化显示文本。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
...@@ -57,130 +69,180 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri ...@@ -57,130 +69,180 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------- | ---- | ---------------- | | ------------ | ------- | ---- | ---------------- |
| country | string | 是 | 指定国家。 | | language | string | 是 | 指定语言。 |
| locale | string | 是 | 显示指定国家的区域ID。 | | locale | string | 是 | 显示指定语言的区域ID。 |
| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------- | | ------ | ------------- |
| string | 指定国家的本地化显示文本。 | | string | 指定语言的本地化显示文本。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getDisplayCountry("zh-CN", "en-GB", true); try {
i18n.getDisplayCountry("zh-CN", "en-GB"); var displayLanguage = i18n.System.getDisplayLanguage("zh", "en-GB");
} catch(error) {
console.error(`call System.getDisplayLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getSystemLanguages<sup>9+</sup>
## i18n.isRTL<sup>7+</sup> static getSystemLanguages(): Array&lt;string&gt;
isRTL(locale: string): boolean
获取是否为从右至左显示语言。 获取系统支持的语言列表。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------- |
| locale | string | 指定区域ID。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------------- | | ------------------- | ------------ |
| boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 | | Array&lt;string&gt; | 系统支持的语言ID列表。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.isRTL("zh-CN");// 中文不是RTL语言，返回false try {
i18n.isRTL("ar-EG");// 阿语是RTL语言，返回true var systemLanguages = i18n.System.getSystemLanguages();
} catch(error) {
console.error(`call System.getSystemLanguages failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getSystemCountries<sup>9+</sup>
## i18n.getSystemLanguage static getSystemCountries(language: string): Array&lt;string&gt;
getSystemLanguage(): string
获取系统语言。 获取针对输入语言系统支持的区域列表。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 说明 |
| -------- | ------ | ----- |
| language | string | 语言ID。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------- | | ------------------- | ------------ |
| string | 系统语言ID。 | | Array&lt;string&gt; | 系统支持的区域ID列表。 |
**示例：** **错误码：**
```js
i18n.getSystemLanguage();
```
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
## i18n.setSystemLanguage | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
setSystemLanguage(language: string): boolean **示例：**
```js
try {
var systemCountries = i18n.System.getSystemCountries('zh');
} catch(error) {
console.error(`call System.getSystemCountries failed, error code: ${error.code}, message: ${error.message}.`)
}
```
设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。 ### isSuggested<sup>9+</sup>
此接口为系统接口。 static isSuggested(language: string, region?: string): boolean
**需要权限**：ohos.permission.UPDATE_CONFIGURATION 判断当前语言和区域是否匹配。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ----- | | -------- | ------ | ---- | ------------- |
| language | string | 语言ID。 | | language | string | 是 | 合法的语言ID，例如zh。 |
| region | string | 否 | 合法的地区ID，例如CN |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true，表示系统语言设置成功；返回false，表示系统语言设置失败。 | | boolean | 返回true，表示当前语言和地区匹配；返回false，表示当前语言和地区不匹配。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.setSystemLanguage('zh'); try {
var res = i18n.System.isSuggested('zh', 'CN');
} catch(error) {
console.error(`call System.isSuggested failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getSystemLanguage<sup>9+</sup>
## i18n.getSystemLanguages<sup>9+</sup> static getSystemLanguage(): string
getSystemLanguages(): Array&lt;string&gt; 获取系统语言。
获取系统支持的语言列表。
此接口为系统接口。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------ | | ------ | ------- |
| Array&lt;string&gt; | 系统支持的语言ID列表。 | | string | 系统语言ID。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getSystemLanguages(); try {
var systemLanguage = i18n.System.getSystemLanguage();
} catch(error) {
console.error(`call System.getSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### setSystemLanguage<sup>9+</sup>
## i18n.getSystemCountries<sup>9+</sup> static setSystemLanguage(language: string): void
getSystemCountries(language: string): Array&lt;string&gt; 设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。
获取针对输入语言系统支持的区域列表。
此接口为系统接口。 此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -189,21 +251,26 @@ getSystemCountries(language: string): Array&lt;string&gt; ...@@ -189,21 +251,26 @@ getSystemCountries(language: string): Array&lt;string&gt;
| -------- | ------ | ----- | | -------- | ------ | ----- |
| language | string | 语言ID。 | | language | string | 语言ID。 |
**返回值：** **错误码：**
| 类型 | 说明 | 以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| ------------------- | ------------ |
| Array&lt;string&gt; | 系统支持的区域ID列表。 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getSystemCountries('zh'); try {
i18n.System.setSystemLanguage('zh');
} catch(error) {
console.error(`call System.setSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getSystemRegion<sup>9+</sup>
## i18n.getSystemRegion static getSystemRegion(): string
getSystemRegion(): string
获取系统地区。 获取系统地区。
...@@ -215,15 +282,26 @@ getSystemRegion(): string ...@@ -215,15 +282,26 @@ getSystemRegion(): string
| ------ | ------- | | ------ | ------- |
| string | 系统地区ID。 | | string | 系统地区ID。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getSystemRegion(); try {
var systemRegion = i18n.System.getSystemRegion();
} catch(error) {
console.error(`call System.getSystemRegion failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### setSystemRegion<sup>9+</sup>
## i18n.setSystemRegion static setSystemRegion(region: string): void
setSystemRegion(region: string): boolean
设置系统区域。 设置系统区域。
...@@ -239,21 +317,26 @@ setSystemRegion(region: string): boolean ...@@ -239,21 +317,26 @@ setSystemRegion(region: string): boolean
| ------ | ------ | ----- | | ------ | ------ | ----- |
| region | string | 地区ID。 | | region | string | 地区ID。 |
**返回值：** **错误码：**
| 类型 | 说明 | 以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| ------- | ------------------------------------- |
| boolean | 返回true，表示系统区域设置成功；返回false，表示系统区域设置失败。 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.setSystemRegion('CN'); try {
i18n.System.setSystemRegion('CN');
} catch(error) {
console.error(`call System.setSystemRegion failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getSystemLocale<sup>9+</sup>
## i18n.getSystemLocale static getSystemLocale(): string
getSystemLocale(): string
获取系统区域。 获取系统区域。
...@@ -265,15 +348,26 @@ getSystemLocale(): string ...@@ -265,15 +348,26 @@ getSystemLocale(): string
| ------ | ------- | | ------ | ------- |
| string | 系统区域ID。 | | string | 系统区域ID。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getSystemLocale(); try {
var systemLocale = i18n.System.getSystemLocale();
} catch(error) {
console.error(`call System.getSystemLocale failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### setSystemLocale<sup>9+</sup>
## i18n.setSystemLocale static setSystemLocale(locale: string): void
setSystemLocale(locale: string): boolean
设置系统Locale。 设置系统Locale。
...@@ -289,180 +383,486 @@ setSystemLocale(locale: string): boolean ...@@ -289,180 +383,486 @@ setSystemLocale(locale: string): boolean
| ------ | ------ | --------------- | | ------ | ------ | --------------- |
| locale | string | 指定区域ID，例如zh-CN。 | | locale | string | 指定区域ID，例如zh-CN。 |
**返回值：** **错误码：**
| 类型 | 说明 | 以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| ------- | ---------------------------------------- |
| boolean | 返回true，表示系统Locale设置成功；返回false，表示系统Locale设置失败。 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.setSystemLocale('zh-CN'); try {
i18n.System.setSystemLocale('zh-CN');
} catch(error) {
console.error(`call System.setSystemLocale failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### is24HourClock<sup>9+</sup>
## i18n.isSuggested<sup>9+</sup> static is24HourClock(): boolean
isSuggested(language: string, region?: string): boolean 判断系统时间是否为24小时制。
判断当前语言和区域是否匹配。
此接口为系统接口。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------- |
| language | string | 是 | 合法的语言ID，例如zh。 |
| region | string | 否 | 合法的地区ID，例如CN |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true，表示当前语言和地区匹配；返回false，表示当前语言和地区不匹配。 | | boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.isSuggested('zh', 'CN'); try {
var is24HourClock = i18n.System.is24HourClock();
} catch(error) {
console.error(`call System.is24HourClock failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### set24HourClock<sup>9+</sup>
## i18n.getCalendar<sup>8+</sup> static set24HourClock(option: boolean): void
getCalendar(locale: string, type? : string): Calendar 修改系统时间的24小时制设置。
获取日历对象。 此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------------------- | | ------ | ------- | ---- | ---------------------------------------- |
| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。 | | option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 |
| type | string | 否 | 合法的日历类型，目前合法的类型有buddhist,&nbsp;chinese,&nbsp;coptic,&nbsp;ethiopic,&nbsp;hebrew,&nbsp;gregory,&nbsp;indian,&nbsp;islamic_civil,&nbsp;islamic_tbla,&nbsp;islamic_umalqura,&nbsp;japanese,&nbsp;persian。当type没有给出时，采用区域默认的日历类型。 |
**返回值：** **错误码：**
| 类型 | 说明 | 以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| ---------------------- | ----- |
| [Calendar](#calendar8) | 日历对象。 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
i18n.getCalendar("zh-Hans", "gregory"); // 将系统时间设置为24小时制
try {
i18n.System.set24HourClock(true);
} catch(error) {
console.error(`call System.set24HourClock failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### addPreferredLanguage<sup>9+</sup>
## Calendar<sup>8+</sup> static addPreferredLanguage(language: string, index?: number): void
### setTime<sup>8+</sup> 在系统偏好语言列表中的指定位置添加偏好语言。
setTime(date: Date): void 此接口为系统接口。
设置日历对象内部的时间日期。 **需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | ----------------- | | -------- | ------ | ---- | ---------- |
| date | Date | 是 | 将要设置的日历对象的内部时间日期。 | | language | string | 是 | 待添加的偏好语言。 |
| index | number | 否 | 偏好语言的添加位置。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
var calendar = i18n.getCalendar("en-US", "gregory"); // 将语言zh-CN添加到系统偏好语言列表中
var date = new Date(2021, 10, 7, 8, 0, 0, 0); var language = 'zh-CN';
calendar.setTime(date); var index = 0;
try {
i18n.System.addPreferredLanguage(language, index);
} catch(error) {
console.error(`call System.addPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### removePreferredLanguage<sup>9+</sup>
### setTime<sup>8+</sup> static removePreferredLanguage(index: number): void
setTime(time: number): void 删除系统偏好语言列表中指定位置的偏好语言。
设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- | | ----- | ------ | ---- | --------------------- |
| time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 | | index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
var calendar = i18n.getCalendar("en-US", "gregory"); // 删除系统偏好语言列表中的第一个偏好语言
calendar.setTime(10540800000); var index = 0;
try {
i18n.System.removePreferredLanguage(index);
} catch(error) {
console.error(`call System.removePreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getPreferredLanguageList<sup>9+</sup>
### set<sup>8+</sup> static getPreferredLanguageList(): Array&lt;string&gt;
set(year: number, month: number, date:number, hour?: number, minute?: number, second?: number): void
设置日历对象的年、月、日、时、分、秒。 获取系统偏好语言列表。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| ------ | ------ | ---- | ------ | | ------------------- | --------- |
| year | number | 是 | 设置的年。 | | Array&lt;string&gt; | 系统偏好语言列表。 |
| month | number | 是 | 设置的月。 |
| date | number | 是 | 设置的日。 | **错误码：**
| hour | number | 否 | 设置的小时。 |
| minute | number | 否 | 设置的分钟。 | 以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| second | number | 否 | 设置的秒。 |
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
var calendar = i18n.getCalendar("zh-Hans"); try {
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 var preferredLanguageList = i18n.System.getPreferredLanguageList();
} catch(error) {
console.error(`call System.getPreferredLanguageList failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getFirstPreferredLanguage<sup>9+</sup>
### setTimeZone<sup>8+</sup> static getFirstPreferredLanguage(): string
setTimeZone(timezone: string): void
设置日历对象的时区。 获取偏好语言列表中的第一个偏好语言。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 | | 类型 | 说明 |
| -------- | ------ | ---- | ------------------------- | | ------ | -------------- |
| timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 | | string | 偏好语言列表中的第一个语言。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：** **示例：**
```js ```js
var calendar = i18n.getCalendar("zh-Hans"); try {
calendar.setTimeZone("Asia/Shanghai"); var firstPreferredLanguage = i18n.System.getFirstPreferredLanguage();
} catch(error) {
console.error(`call System.getFirstPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
``` ```
### getAppPreferredLanguage<sup>9+</sup>
### getTimeZone<sup>8+</sup> static getAppPreferredLanguage(): string
getTimeZone(): string
获取日历对象的时区。 获取应用的偏好语言。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------- | | ------ | -------- |
| string | 日历对象的时区id。 | | string | 应用的偏好语言。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：**
```js
try {
var appPreferredLanguage = i18n.System.getAppPreferredLanguage();
} catch(error) {
console.error(`call System.getAppPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`)
}
```
### setUsingLocalDigit<sup>9+</sup>
static setUsingLocalDigit(flag: boolean): void
设置是否打开本地数字开关。
此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------- | ---- | ------------------------------- |
| flag | boolean | 是 | true表示打开本地数字开关，false表示关闭本地数字开关。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：**
```ts
try {
i18n.System.setUsingLocalDigit(true);
} catch(error) {
console.error(`call System.setUsingLocalDigit failed, error code: ${error.code}, message: ${error.message}.`)
}
```
### getUsingLocalDigit<sup>9+</sup>
static getUsingLocalDigit(): boolean
获取系统当前是否打开本地数字开关。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | true表示系统当前已打开本地数字开关，false表示系统当前未打开本地数字开关。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
**示例：**
```ts
try {
var status = i18n.System.getUsingLocalDigit();
} catch(error) {
console.error(`call System.getUsingLocalDigit failed, error code: ${error.code}, message: ${error.message}.`)
}
```
## i18n.isRTL<sup>7+</sup>
isRTL(locale: string): boolean
获取是否为从右至左显示语言。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------- |
| locale | string | 指定区域ID。 |
**返回值：**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 |
**示例：**
```js
i18n.isRTL("zh-CN");// 中文不是RTL语言，返回false
i18n.isRTL("ar-EG");// 阿语是RTL语言，返回true
```
## i18n.getCalendar<sup>8+</sup>
getCalendar(locale: string, type? : string): Calendar
获取日历对象。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------------------- |
| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。 |
| type | string | 否 | 合法的日历类型，目前合法的类型有buddhist,&nbsp;chinese,&nbsp;coptic,&nbsp;ethiopic,&nbsp;hebrew,&nbsp;gregory,&nbsp;indian,&nbsp;islamic_civil,&nbsp;islamic_tbla,&nbsp;islamic_umalqura,&nbsp;japanese,&nbsp;persian。当type没有给出时，采用区域默认的日历类型。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | ----- |
| [Calendar](#calendar8) | 日历对象。 |
**示例：**
```js
i18n.getCalendar("zh-Hans", "gregory");
```
## Calendar<sup>8+</sup>
### setTime<sup>8+</sup>
setTime(date: Date): void
设置日历对象内部的时间日期。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ---- | ---- | ----------------- |
| date | Date | 是 | 将要设置的日历对象的内部时间日期。 |
**示例：**
```js
var calendar = i18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0);
calendar.setTime(date);
```
### setTime<sup>8+</sup>
setTime(time: number): void
设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 |
**示例：**
```js
var calendar = i18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000);
```
### set<sup>8+</sup>
set(year: number, month: number, date:number, hour?: number, minute?: number, second?: number): void
设置日历对象的年、月、日、时、分、秒。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------ |
| year | number | 是 | 设置的年。 |
| month | number | 是 | 设置的月。 |
| date | number | 是 | 设置的日。 |
| hour | number | 否 | 设置的小时。 |
| minute | number | 否 | 设置的分钟。 |
| second | number | 否 | 设置的秒。 |
**示例：**
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
```
### setTimeZone<sup>8+</sup>
setTimeZone(timezone: string): void
设置日历对象的时区。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------- |
| timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 |
**示例：**
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
```
### getTimeZone<sup>8+</sup>
getTimeZone(): string
获取日历对象的时区。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| ------ | ---------- |
| string | 日历对象的时区id。 |
**示例：** **示例：**
```js ```js
...@@ -770,39 +1170,6 @@ getLocationName(number: string, locale: string): string ...@@ -770,39 +1170,6 @@ getLocationName(number: string, locale: string): string
| measureSystem | string | 是 | 是 | 单位的度量体系，取值包括："SI",&nbsp;"US",&nbsp;"UK"。 | | measureSystem | string | 是 | 是 | 单位的度量体系，取值包括："SI",&nbsp;"US",&nbsp;"UK"。 |
## Util<sup>(deprecated)</sup>
### unitConvert<sup>(deprecated)</sup>
static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string
将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。
> **说明：**
> 从API version 9开始废弃。建议使用[unitConvert](#unitconvert9)代替。
>
> 从 API version 8开始支持。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------- |
| fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
| value | number | 是 | 要被转换的单位的数量值。 |
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
| style | string | 否 | 格式化使用的风格，取值包括："long",&nbsp;"short",&nbsp;"narrow"。 |
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| string | 按照toUnit的单位格式化后，得到的字符串。 |
## getInstance<sup>8+</sup> ## getInstance<sup>8+</sup>
getInstance(locale?:string): IndexUtil getInstance(locale?:string): IndexUtil
...@@ -901,248 +1268,11 @@ getIndex(text: string): string ...@@ -901,248 +1268,11 @@ getIndex(text: string): string
``` ```
## Character<sup>(deprecated)</sup> ## i18n.getLineInstance<sup>8+</sup>
### isDigit<sup>(deprecated)</sup>
static isDigit(char: string): boolean
判断字符串char是否是数字。 getLineInstance(locale: string): BreakIterator
> **说明：** 获取一个用于断句的[BreakIterator](#breakiterator8)对象。
> 从API version 9开始废弃。建议使用[isDigit](#isdigit9)代替。
>
> 从 API version 8开始支持。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 |
### isSpaceChar<sup>(deprecated)</sup>
static isSpaceChar(char: string): boolean
判断字符串char是否是空格符。
> **说明：**
> 从API version 9开始废弃。建议使用[isSpaceChar](#isspacechar9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 |
### isWhitespace<sup>(deprecated)</sup>
static isWhitespace(char: string): boolean
判断字符串char是否是空白符。
> **说明：**
> 从API version 9开始废弃。建议使用[isWhitespace](#iswhitespace9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 |
### isRTL<sup>(deprecated)</sup>
static isRTL(char: string): boolean
判断字符串char是否是从右到左语言的字符。
> **说明：**
> 从API version 9开始废弃。建议使用[isRTL](#isrtl9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 |
### isIdeograph<sup>(deprecated)</sup>
static isIdeograph(char: string): boolean
判断字符串char是否是表意文字。
> **说明：**
> 从API version 9开始废弃。建议使用[isIdeograph](#isideograph9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 |
### isLetter<sup>(deprecated)</sup>
static isLetter(char: string): boolean
判断字符串char是否是字母。
> **说明：**
> 从API version 9开始废弃。建议使用[isLetter](#isletter9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 |
### isLowerCase<sup>(deprecated)</sup>
static isLowerCase(char: string): boolean
判断字符串char是否是小写字母。
> **说明：**
> 从API version 9开始废弃。建议使用[isLowerCase](#islowercase9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 |
### isUpperCase<sup>(deprecated)</sup>
static isUpperCase(char: string): boolean
判断字符串char是否是大写字母。
> **说明：**
> 从API version 9开始废弃。建议使用[isUpperCase](#isuppercase9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 |
### getType<sup>(deprecated)</sup>
static getType(char: string): string
获取输入字符串的一般类别值。
> **说明：**
> 从API version 9开始废弃。建议使用[getType](#gettype9)代替。
>
> 从 API version 8开始支持
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------ | ----------- |
| string | 输入字符的一般类别值。 |
## i18n.getLineInstance<sup>8+</sup>
getLineInstance(locale: string): BreakIterator
获取一个用于断句的[BreakIterator](#breakiterator8)对象。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
...@@ -1389,397 +1519,779 @@ isBoundary(offset: number): boolean ...@@ -1389,397 +1519,779 @@ isBoundary(offset: number): boolean
``` ```
## i18n.is24HourClock<sup>7+</sup> ## i18n.getTimeZone<sup>7+</sup>
is24HourClock(): boolean getTimeZone(zoneID?: string): TimeZone
判断系统时间是否为24小时制。 获取时区ID对应的时区对象。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| zondID | string | 否 | 时区ID。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------------- | | -------- | ------------ |
| boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 | | TimeZone | 时区ID对应的时区对象。 |
**示例：** **示例：**
```js ```js
var is24HourClock = i18n.is24HourClock(); var timezone = i18n.getTimeZone();
``` ```
## i18n.set24HourClock<sup>7+</sup> ## TimeZone
set24HourClock(option: boolean): boolean
修改系统时间的24小时制设置。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION ### getID
**系统能力**：SystemCapability.Global.I18n getID(): string
**参数：** 获取时区对象的ID。
| 参数名 | 类型 | 必填 | 说明 | **系统能力**：SystemCapability.Global.I18n
| ------ | ------- | ---- | ---------------------------------------- |
| option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------- | | ------ | ------------ |
| boolean | 返回true，表示修改成功；返回false，表示修改失败。 | | string | 时区对象对应的时区ID。 |
**示例：** **示例：**
```js ```js
// 将系统时间设置为24小时制 var timezone = i18n.getTimeZone();
var success = i18n.set24HourClock(true); timezone.getID();
``` ```
## i18n.addPreferredLanguage<sup>8+</sup> ### getDisplayName
addPreferredLanguage(language: string, index?: number): boolean getDisplayName(locale?: string, isDST?: boolean): string
获取时区对象在指定区域的表示。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | -------------------- |
| locale | string | 否 | 区域ID。 |
| isDST | boolean | 否 | 表示获取时区对象的表示时是否考虑夏令时。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------- |
| string | 时区对象在指定区域的表示。 |
**示例：**
```js
var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false);
```
### getRawOffset
getRawOffset(): number
获取时区对象表示的时区与UTC时区的偏差。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| ------ | ------------------- |
| number | 时区对象表示的时区与UTC时区的偏差。 |
**示例：**
```js
var timezone = i18n.getTimeZone();
timezone.getRawOffset();
```
### getOffset
getOffset(date?: number): number
获取某一时刻时区对象表示的时区与UTC时区的偏差。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
**示例：**
```js
var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890);
```
### getAvailableIDs<sup>9+</sup>
static getAvailableIDs(): Array&lt;string&gt;
获取系统支持的时区ID。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| ------------------- | ----------- |
| Array&lt;string&gt; | 系统支持的时区ID列表 |
**示例：**
```ts
var ids = i18n.TimeZone.getAvailableIDs();
```
### getAvailableZoneCityIDs<sup>9+</sup>
static getAvailableZoneCityIDs(): Array&lt;string&gt;
获取系统支持的时区城市ID。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------- |
| Array&lt;string&gt; | 系统支持的时区城市ID列表 |
**示例：**
```ts
var cityIDs = i18n.TimeZone.getAvailableZoneCityIDs();
```
### getCityDisplayName<sup>9+</sup>
static getCityDisplayName(cityID: string, locale: string): string
获取某时区城市在locale下的本地化显示。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------ |
| cityID | string | 是 | 时区城市ID |
| locale | string | 是 | 区域ID |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------ |
| string | 时区城市在locale下的本地化显示 |
**示例：**
```ts
var displayName = i18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN");
```
### getTimezoneFromCity<sup>9+</sup>
static getTimezoneFromCity(cityID: string): TimeZone
创建某时区城市对应的时区对象。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------ |
| cityID | string | 是 | 时区城市ID |
**返回值：**
| 类型 | 说明 |
| -------- | ----------- |
| TimeZone | 时区城市对应的时区对象 |
**示例：**
```ts
var timezone = i18n.TimeZone.getTimezoneFromCity("Shanghai");
```
## Transliterator<sup>9+</sup>
### getAvailableIDs<sup>9+</sup>
static getAvailableIDs(): string[]
获取音译支持的ID列表。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
| -------- | ---------- |
| string[] | 音译支持的ID列表。 |
**示例：**
```ts
i18n.Transliterator.getAvailableIDs();
```
### getInstance<sup>9+</sup>
static getInstance(id: string): Transliterator
创建音译对象。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------- |
| id | string | 是 | 音译支持的ID。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ----- |
| [Transliterator](#transliterator9) | 音译对象。 |
**示例：**
```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
```
### transform<sup>9+</sup>
transform(text: string): string
将输入字符串从源格式转换为目标格式。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ |
| text | string | 是 | 输入字符串。 |
**返回值：**
| 类型 | 说明 |
| ------ | -------- |
| string | 转换后的字符串。 |
**示例：**
```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
transliterator.transform("中国");
```
## Unicode<sup>9+</sup>
### isDigit<sup>9+</sup>
static isDigit(char: string): boolean
判断字符串char是否是数字。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 |
**示例：**
```js
var isdigit = i18n.Unicode.isDigit("1"); // 返回true
```
### isSpaceChar<sup>9+</sup>
static isSpaceChar(char: string): boolean
判断字符串char是否是空格符。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 |
**示例：**
```js
var isspacechar = i18n.Unicode.isSpaceChar("a"); // 返回false
```
### isWhitespace<sup>9+</sup>
static isWhitespace(char: string): boolean
判断字符串char是否是空白符。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 |
**示例：**
```js
var iswhitespace = i18n.Unicode.isWhitespace("a"); // 返回false
```
在系统偏好语言列表中的指定位置添加偏好语言。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION ### isRTL<sup>9+</sup>
static isRTL(char: string): boolean
判断字符串char是否是从右到左语言的字符。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- | | ---- | ------ | ---- | ----- |
| language | string | 是 | 待添加的偏好语言。 | | char | string | 是 | 输入字符。 |
| index | number | 否 | 偏好语言的添加位置。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true，表示添加成功；返回false，表示添加失败。 | | boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 |
**示例：** **示例：**
```js ```js
// 将语言zh-CN添加到系统偏好语言列表中 var isrtl = i18n.Unicode.isRTL("a"); // 返回false
var language = 'zh-CN';
var index = 0;
var success = i18n.addPreferredLanguage(language, index);
``` ```
## i18n.removePreferredLanguage<sup>8+</sup> ### isIdeograph<sup>9+</sup>
removePreferredLanguage(index: number): boolean
删除系统偏好语言列表中指定位置的偏好语言。 static isIdeograph(char: string): boolean
**需要权限**：ohos.permission.UPDATE_CONFIGURATION 判断字符串char是否是表意文字。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | --------------------- | | ---- | ------ | ---- | ----- |
| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 | | char | string | 是 | 输入字符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true，表示删除成功；返回false，表示删除失败。 | | boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 |
**示例：** **示例：**
```js ```js
// 删除系统偏好语言列表中的第一个偏好语言 var isideograph = i18n.Unicode.isIdeograph("a"); // 返回false
var index = 0;
var success = i18n.removePreferredLanguage(index);
``` ```
## i18n.getPreferredLanguageList<sup>8+</sup> ### isLetter<sup>9+</sup>
getPreferredLanguageList(): Array&lt;string&gt; static isLetter(char: string): boolean
获取系统偏好语言列表。 判断字符串char是否是字母。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | --------- | | ------- | ------------------------------------ |
| Array&lt;string&gt; | 系统偏好语言列表。 | | boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 |
**示例：** **示例：**
```js ```js
var preferredLanguageList = i18n.getPreferredLanguageList(); var isletter = i18n.Unicode.isLetter("a"); // 返回true
``` ```
## i18n.getFirstPreferredLanguage<sup>8+</sup> ### isLowerCase<sup>9+</sup>
getFirstPreferredLanguage(): string static isLowerCase(char: string): boolean
获取偏好语言列表中的第一个偏好语言。 判断字符串char是否是小写字母。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------------- | | ------- | ---------------------------------------- |
| string | 偏好语言列表中的第一个语言。 | | boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 |
**示例：** **示例：**
```js ```js
var firstPreferredLanguage = i18n.getFirstPreferredLanguage(); var islowercase = i18n.Unicode.isLowerCase("a"); // 返回true
``` ```
## i18n.getAppPreferredLanguage<sup>9+</sup> ### isUpperCase<sup>9+</sup>
getAppPreferredLanguage(): string static isUpperCase(char: string): boolean
获取应用的偏好语言。 判断字符串char是否是大写字母。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------- | ---------------------------------------- |
| string | 应用的偏好语言。 | | boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 |
**示例：** **示例：**
```js ```js
var appPreferredLanguage = i18n.getAppPreferredLanguage(); var isuppercase = i18n.Unicode.isUpperCase("a"); // 返回false
``` ```
## i18n.getTimeZone<sup>7+</sup> ### getType<sup>9+</sup>
getTimeZone(zoneID?: string): TimeZone static getType(char: string): string
获取时区ID对应的时区对象。 获取输入字符串的一般类别值。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- | | ---- | ------ | ---- | ----- |
| zondID | string | 否 | 时区ID。 | | char | string | 是 | 输入字符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------ | | ------ | ----------- |
| TimeZone | 时区ID对应的时区对象。 | | string | 输入字符的一般类别值。 |
**示例：** **示例：**
```js ```js
var timezone = i18n.getTimeZone(); var type = i18n.Unicode.getType("a");
``` ```
## TimeZone ## I18NUtil<sup>9+</sup>
### getID ### unitConvert<sup>9+</sup>
getID(): string static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string
获取时区对象的ID。 将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------- |
| fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
| value | number | 是 | 要被转换的单位的数量值。 |
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
| style | string | 否 | 格式化使用的风格，取值包括："long",&nbsp;"short",&nbsp;"narrow"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------ | | ------ | ----------------------- |
| string | 时区对象对应的时区ID。 | | string | 按照toUnit的单位格式化后，得到的字符串。 |
**示例：** **示例：**
```js ```js
var timezone = i18n.getTimeZone(); i18n.I18NUtil.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
timezone.getID();
``` ```
### getDisplayName ### getDateOrder<sup>9+</sup>
getDisplayName(locale?: string, isDST?: boolean): string static getDateOrder(locale: string): string
获取时区对象在指定区域的表示。 获取某一区域的日期的年、月、日排列顺序。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | -------------------- | | ------ | ------ | ---- | ------------------------- |
| locale | string | 否 | 区域ID。 | | locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
| isDST | boolean | 否 | 表示获取时区对象的表示时是否考虑夏令时。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------- | | ------ | ------------------- |
| string | 时区对象在指定区域的表示。 | | string | 返回某一区域的日期的年、月、日排列顺序 |
**示例：** **示例：**
```js ```js
var timezone = i18n.getTimeZone(); i18n.I18NUtil.getDateOrder("zh-CN");
timezone.getDisplayName("zh-CN", false);
``` ```
### getRawOffset ## i18n.getDisplayCountry<sup>(deprecated)</sup>
getRawOffset(): number getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string
获取时区对象表示的时区与UTC时区的偏差。 获取指定国家的本地化显示文本。
从API version 9开始不再维护，建议使用[System.getDisplayCountry](#getdisplaycountry9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------- | ---- | ---------------- |
| country | string | 是 | 指定国家。 |
| locale | string | 是 | 显示指定国家的区域ID。 |
| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------- | | ------ | ------------- |
| number | 时区对象表示的时区与UTC时区的偏差。 | | string | 指定国家的本地化显示文本。 |
**示例：** **示例：**
```js ```js
var timezone = i18n.getTimeZone(); i18n.getDisplayCountry("zh-CN", "en-GB", true);
timezone.getRawOffset(); i18n.getDisplayCountry("zh-CN", "en-GB");
``` ```
### getOffset ## i18n.getDisplayLanguage<sup>(deprecated)</sup>
getOffset(date?: number): number getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string
获取某一时刻时区对象表示的时区与UTC时区的偏差。 获取指定语言的本地化显示文本。
从API version 9开始不再维护，建议使用[System.getDisplayLanguage](#getdisplaylanguage9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------- | ---- | ---------------- |
| language | string | 是 | 指定语言。 |
| locale | string | 是 | 显示指定语言的区域ID。 |
| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | ------ | ------------- |
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 | | string | 指定语言的本地化显示文本。 |
**示例：** **示例：**
```js ```js
var timezone = i18n.getTimeZone(); i18n.getDisplayLanguage("zh", "en-GB", true);
timezone.getOffset(1234567890); i18n.getDisplayLanguage("zh", "en-GB");
``` ```
### getAvailableIDs<sup>9+</sup> ## i18n.getSystemLanguage<sup>(deprecated)</sup>
static getAvailableIDs(): Array&lt;string&gt; getSystemLanguage(): string
获取系统支持的时区ID。 获取系统语言。
从API version 9开始不再维护，建议使用[System.getSystemLanguage](#getsystemlanguage9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------- | | ------ | ------- |
| Array&lt;string&gt; | 系统支持的时区ID列表 | | string | 系统语言ID。 |
**示例：** **示例：**
```ts ```js
var ids = i18n.TimeZone.getAvailableIDs(); i18n.getSystemLanguage();
``` ```
### getAvailableZoneCityIDs<sup>9+</sup> ## i18n.getSystemRegion<sup>(deprecated)</sup>
static getAvailableZoneCityIDs(): Array&lt;string&gt; getSystemRegion(): string
获取系统支持的时区城市ID。 获取系统地区。
从API version 9开始不再维护，建议使用[System.getSystemRegion](#getsystemregion9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------- | | ------ | ------- |
| Array&lt;string&gt; | 系统支持的时区城市ID列表 | | string | 系统地区ID。 |
**示例：** **示例：**
```ts ```js
var cityIDs = i18n.TimeZone.getAvailableZoneCityIDs(); i18n.getSystemRegion();
``` ```
### getCityDisplayName<sup>9+</sup> ## i18n.getSystemLocale<sup>(deprecated)</sup>
static getCityDisplayName(cityID: string, locale: string): string getSystemLocale(): string
获取某时区城市在locale下的本地化显示。 获取系统区域。
从API version 9开始不再维护，建议使用[System.getSystemLocale](#getsystemlocale9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **返回值：**
| 类型 | 说明 |
| ------ | ------- |
| string | 系统区域ID。 |
**示例：**
```js
i18n.getSystemLocale();
```
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------ | ## i18n.is24HourClock<sup>(deprecated)</sup>
| cityID | string | 是 | 时区城市ID |
| locale | string | 是 | 区域ID | is24HourClock(): boolean
判断系统时间是否为24小时制。
从API version 9开始不再维护，建议使用[System.is24HourClock](#is24hourclock9)代替。
**系统能力**：SystemCapability.Global.I18n
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------------ | | ------- | ---------------------------------------- |
| string | 时区城市在locale下的本地化显示 | | boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 |
**示例：** **示例：**
```ts ```js
var displayName = i18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN"); var is24HourClock = i18n.is24HourClock();
``` ```
### getTimezoneFromCity<sup>9+</sup> ## i18n.set24HourClock<sup>(deprecated)</sup>
static getTimezoneFromCity(cityID: string): TimeZone set24HourClock(option: boolean): boolean
创建某时区城市对应的时区对象。 修改系统时间的24小时制设置。
从API version 9开始不再维护，建议使用[System.set24HourClock](#set24hourclock9)代替。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------ | | ------ | ------- | ---- | ---------------------------------------- |
| cityID | string | 是 | 时区城市ID | | option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ----------- | | ------- | ----------------------------- |
| TimeZone | 时区城市对应的时区对象 | | boolean | 返回true，表示修改成功；返回false，表示修改失败。 |
**示例：** **示例：**
```ts ```js
var timezone = i18n.TimeZone.getTimezoneFromCity("Shanghai"); // 将系统时间设置为24小时制
var success = i18n.set24HourClock(true);
``` ```
## i18n.setUsingLocalDigit<sup>9+</sup> ## i18n.addPreferredLanguage<sup>(deprecated)</sup>
setUsingLocalDigit(flag: boolean): boolean addPreferredLanguage(language: string, index?: number): boolean
设置是否打开本地数字开关。 在系统偏好语言列表中的指定位置添加偏好语言。
此接口为系统接口。 从API version 8开始支持，从API version 9开始不再维护，建议使用[System.addPreferredLanguage](#addpreferredlanguage9)代替。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION **需要权限**：ohos.permission.UPDATE_CONFIGURATION
...@@ -1788,126 +2300,142 @@ setUsingLocalDigit(flag: boolean): boolean ...@@ -1788,126 +2300,142 @@ setUsingLocalDigit(flag: boolean): boolean
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------- | ---- | ------------------------------- | | -------- | ------ | ---- | ---------- |
| flag | boolean | 是 | true表示打开本地数字开关，false表示关闭本地数字开关。 | | language | string | 是 | 待添加的偏好语言。 |
| index | number | 否 | 偏好语言的添加位置。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------------------------- | | ------- | ----------------------------- |
| boolean | true表示本地数字开关设置成功，false表示本地数字开关设置失败。 | | boolean | 返回true，表示添加成功；返回false，表示添加失败。 |
**示例：** **示例：**
```ts ```js
var status = i18n.setUsingLocalDigit(true); // 将语言zh-CN添加到系统偏好语言列表中
var language = 'zh-CN';
var index = 0;
var success = i18n.addPreferredLanguage(language, index);
``` ```
## i18n.getUsingLocalDigit<sup>9+</sup> ## i18n.removePreferredLanguage<sup>(deprecated)</sup>
removePreferredLanguage(index: number): boolean
删除系统偏好语言列表中指定位置的偏好语言。
getUsingLocalDigit(): boolean 从API version 8开始支持，从API version 9开始不再维护，建议使用[System.removePreferredLanguage](#removepreferredlanguage9)代替。
获取系统当前是否打开本地数字开关。 **需要权限**：ohos.permission.UPDATE_CONFIGURATION
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | --------------------- |
| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------------- | | ------- | ----------------------------- |
| boolean | true表示系统当前已打开本地数字开关，false表示系统当前未打开本地数字开关。 | | boolean | 返回true，表示删除成功；返回false，表示删除失败。 |
**示例：** **示例：**
```ts ```js
var status = i18n.getUsingLocalDigit(); // 删除系统偏好语言列表中的第一个偏好语言
var index = 0;
var success = i18n.removePreferredLanguage(index);
``` ```
## Transliterator<sup>9+</sup> ## i18n.getPreferredLanguageList<sup>(deprecated)</sup>
### getAvailableIDs<sup>9+</sup> getPreferredLanguageList(): Array&lt;string&gt;
static getAvailableIDs(): string[] 获取系统偏好语言列表。
获取音译支持的ID列表。 从API version 8开始支持，从API version 9开始不再维护，建议使用[System.getPreferredLanguageList](#getpreferredlanguagelist9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ---------- | | ------------------- | --------- |
| string[] | 音译支持的ID列表。 | | Array&lt;string&gt; | 系统偏好语言列表。 |
**示例：** **示例：**
```ts ```js
i18n.Transliterator.getAvailableIDs(); var preferredLanguageList = i18n.getPreferredLanguageList();
``` ```
### getInstance<sup>9+</sup> ## i18n.getFirstPreferredLanguage<sup>(deprecated)</sup>
static getInstance(id: string): Transliterator
创建音译对象。 getFirstPreferredLanguage(): string
**系统能力**：SystemCapability.Global.I18n 获取偏好语言列表中的第一个偏好语言。
**参数：** 从API version 8开始支持，从API version 9开始不再维护，建议使用[System.getFirstPreferredLanguage](#getfirstpreferredlanguage9)代替。
| 参数名 | 类型 | 必填 | 说明 | **系统能力**：SystemCapability.Global.I18n
| ---- | ------ | ---- | -------- |
| id | string | 是 | 音译支持的ID。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ----- | | ------ | -------------- |
| [Transliterator](#transliterator9) | 音译对象。 | | string | 偏好语言列表中的第一个语言。 |
**示例：** **示例：**
```ts ```js
var transliterator = i18n.Transliterator.getInstance("Any-Latn"); var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
``` ```
### transform<sup>9+</sup> ## Util<sup>(deprecated)</sup>
transform(text: string): string
将输入字符串从源格式转换为目标格式。 ### unitConvert<sup>(deprecated)</sup>
static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string
将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。
从API version 8开始支持，从API version 9开始不再维护，建议使用[unitConvert](#unitconvert9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------ | | -------- | ---------------------- | ---- | ---------------------------------------- |
| text | string | 是 | 输入字符串。 | | fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
| value | number | 是 | 要被转换的单位的数量值。 |
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
| style | string | 否 | 格式化使用的风格，取值包括："long",&nbsp;"short",&nbsp;"narrow"。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | ----------------------- |
| string | 转换后的字符串。 | | string | 按照toUnit的单位格式化后，得到的字符串。 |
**示例：**
```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
transliterator.transform("中国");
```
## Unicode<sup>9+</sup> ## Character<sup>(deprecated)</sup>
### isDigit<sup>9+</sup> ### isDigit<sup>(deprecated)</sup>
static isDigit(char: string): boolean static isDigit(char: string): boolean
判断字符串char是否是数字。 判断字符串char是否是数字。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isDigit](#isdigit9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -1922,18 +2450,15 @@ static isDigit(char: string): boolean ...@@ -1922,18 +2450,15 @@ static isDigit(char: string): boolean
| ------- | ------------------------------------ | | ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 | | boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 |
**示例：**
```js
var isdigit = i18n.Unicode.isDigit("1"); // 返回true
```
### isSpaceChar<sup>(deprecated)</sup>
### isSpaceChar<sup>9+</sup>
static isSpaceChar(char: string): boolean static isSpaceChar(char: string): boolean
判断字符串char是否是空格符。 判断字符串char是否是空格符。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isSpaceChar](#isspacechar9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -1948,18 +2473,15 @@ static isSpaceChar(char: string): boolean ...@@ -1948,18 +2473,15 @@ static isSpaceChar(char: string): boolean
| ------- | -------------------------------------- | | ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 | | boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 |
**示例：**
```js
var isspacechar = i18n.Unicode.isSpaceChar("a"); // 返回false
```
### isWhitespace<sup>(deprecated)</sup>
### isWhitespace<sup>9+</sup>
static isWhitespace(char: string): boolean static isWhitespace(char: string): boolean
判断字符串char是否是空白符。 判断字符串char是否是空白符。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isWhitespace](#iswhitespace9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -1974,18 +2496,15 @@ static isWhitespace(char: string): boolean ...@@ -1974,18 +2496,15 @@ static isWhitespace(char: string): boolean
| ------- | -------------------------------------- | | ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 | | boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 |
**示例：**
```js
var iswhitespace = i18n.Unicode.isWhitespace("a"); // 返回false
```
### isRTL<sup>(deprecated)</sup>
### isRTL<sup>9+</sup>
static isRTL(char: string): boolean static isRTL(char: string): boolean
判断字符串char是否是从右到左语言的字符。 判断字符串char是否是从右到左语言的字符。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isRTL](#isrtl9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -2000,18 +2519,15 @@ static isRTL(char: string): boolean ...@@ -2000,18 +2519,15 @@ static isRTL(char: string): boolean
| ------- | ---------------------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 | | boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 |
**示例：**
```js
var isrtl = i18n.Unicode.isRTL("a"); // 返回false
```
### isIdeograph<sup>(deprecated)</sup>
### isIdeograph<sup>9+</sup>
static isIdeograph(char: string): boolean static isIdeograph(char: string): boolean
判断字符串char是否是表意文字。 判断字符串char是否是表意文字。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isIdeograph](#isideograph9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -2026,18 +2542,15 @@ static isIdeograph(char: string): boolean ...@@ -2026,18 +2542,15 @@ static isIdeograph(char: string): boolean
| ------- | ---------------------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 | | boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 |
**示例：**
```js
var isideograph = i18n.Unicode.isIdeograph("a"); // 返回false
```
### isLetter<sup>(deprecated)</sup>
### isLetter<sup>9+</sup>
static isLetter(char: string): boolean static isLetter(char: string): boolean
判断字符串char是否是字母。 判断字符串char是否是字母。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isLetter](#isletter9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -2052,18 +2565,15 @@ static isLetter(char: string): boolean ...@@ -2052,18 +2565,15 @@ static isLetter(char: string): boolean
| ------- | ------------------------------------ | | ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 | | boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 |
**示例：**
```js
var isletter = i18n.Unicode.isLetter("a"); // 返回true
```
### isLowerCase<sup>(deprecated)</sup>
### isLowerCase<sup>9+</sup>
static isLowerCase(char: string): boolean static isLowerCase(char: string): boolean
判断字符串char是否是小写字母。 判断字符串char是否是小写字母。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isLowerCase](#islowercase9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -2078,18 +2588,15 @@ static isLowerCase(char: string): boolean ...@@ -2078,18 +2588,15 @@ static isLowerCase(char: string): boolean
| ------- | ---------------------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 | | boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 |
**示例：**
```js
var islowercase = i18n.Unicode.isLowerCase("a"); // 返回true
```
### isUpperCase<sup>(deprecated)</sup>
### isUpperCase<sup>9+</sup>
static isUpperCase(char: string): boolean static isUpperCase(char: string): boolean
判断字符串char是否是大写字母。 判断字符串char是否是大写字母。
从API version 8开始支持，从API version 9开始不再维护，建议使用[isUpperCase](#isuppercase9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -2104,18 +2611,15 @@ static isUpperCase(char: string): boolean ...@@ -2104,18 +2611,15 @@ static isUpperCase(char: string): boolean
| ------- | ---------------------------------------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 | | boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 |
**示例：**
```js
var isuppercase = i18n.Unicode.isUpperCase("a"); // 返回false
```
### getType<sup>(deprecated)</sup>
### getType<sup>9+</sup>
static getType(char: string): string static getType(char: string): string
获取输入字符串的一般类别值。 获取输入字符串的一般类别值。
从API version 8开始支持，从API version 9开始不再维护，建议使用[getType](#gettype9)代替。
**系统能力**：SystemCapability.Global.I18n **系统能力**：SystemCapability.Global.I18n
**参数：** **参数：**
...@@ -2129,67 +2633,3 @@ static getType(char: string): string ...@@ -2129,67 +2633,3 @@ static getType(char: string): string
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------- | | ------ | ----------- |
| string | 输入字符的一般类别值。 | | string | 输入字符的一般类别值。 |
**示例：**
```js
var type = i18n.Unicode.getType("a");
```
## I18NUtil<sup>9+</sup>
### unitConvert<sup>9+</sup>
static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string
将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------- |
| fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
| value | number | 是 | 要被转换的单位的数量值。 |
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
| style | string | 否 | 格式化使用的风格，取值包括："long",&nbsp;"short",&nbsp;"narrow"。 |
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| string | 按照toUnit的单位格式化后，得到的字符串。 |
**示例：**
```js
i18n.I18NUtil.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
```
### getDateOrder<sup>9+</sup>
static getDateOrder(locale: string): string
获取某一区域的日期的年、月、日排列顺序。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------- |
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------- |
| string | 返回某一区域的日期的年、月、日排列顺序 |
**示例：**
```js
i18n.I18NUtil.getDateOrder("zh-CN");
```
\ No newline at end of file
zh-cn/application-dev/reference/errorcodes/errorcode-i18n.md 0 → 100644
浏览文件 @ be97c0c1
# I18n错误码
## 890001 参数类型错误
### 错误信息
Unspported para value.
### 错误描述
当接口传入错误的参数类型时，系统会产生此错误码。
### 可能原因
该错误码表示参数错误，可能原因是传入参数的类型错误。
### 处理步骤
检查参数的类型是否正确。
## 890002 配置项参数错误
### 错误信息
Unspported option value.
### 错误描述
当接口的option配置参数中包含不合法的配置项时，系统会产生此错误码。
### 可能原因
该错误码表示配置项参数错误，可能原因是option参数中使用了不支持的配置项。
### 处理步骤
检查option参数中是否使用了不合法的配置项。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或