From 826d93b0ffc4ee42b627dde95d09818856f290dc Mon Sep 17 00:00:00 2001 From: sunyaozu Date: Mon, 10 Oct 2022 10:25:00 +0800 Subject: [PATCH] update interface description of i18n Signed-off-by: sunyaozu --- .../reference/apis/js-apis-i18n.md | 1820 ++++++++++------- .../reference/errorcodes/errorcode-i18n.md | 29 + 2 files changed, 1159 insertions(+), 690 deletions(-) create mode 100644 zh-cn/application-dev/reference/errorcodes/errorcode-i18n.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-i18n.md b/zh-cn/application-dev/reference/apis/js-apis-i18n.md index 910e24c94f..b484641bef 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-i18n.md +++ b/zh-cn/application-dev/reference/apis/js-apis-i18n.md @@ -16,11 +16,13 @@ import i18n from '@ohos.i18n'; ``` -## i18n.getDisplayLanguage +## System9+ -getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string +### getDisplayCountry9+ -获取指定语言的本地化显示文本。 +static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string + +获取指定国家的本地化显示文本。 **系统能力**：SystemCapability.Global.I18n @@ -28,28 +30,38 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------- | ---- | ---------------- | -| language | string | 是 | 指定语言。 | -| locale | string | 是 | 显示指定语言的区域ID。 | +| country | string | 是 | 指定国家。 | +| locale | string | 是 | 显示指定国家的区域ID。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | **返回值：** | 类型 | 说明 | | ------ | ------------- | -| string | 指定语言的本地化显示文本。 | +| string | 指定国家的本地化显示文本。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - i18n.getDisplayLanguage("zh", "en-GB", true); - i18n.getDisplayLanguage("zh", "en-GB"); + try { + var displayCountry = i18n.System.getDisplayCountry("zh-CN", "en-GB"); + } catch(error) { + console.error(`call System.getDisplayCountry failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### getDisplayLanguage9+ -## i18n.getDisplayCountry - -getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string +static getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string -获取指定国家的本地化显示文本。 +获取指定语言的本地化显示文本。 **系统能力**：SystemCapability.Global.I18n @@ -57,130 +69,180 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri | 参数名 | 类型 | 必填 | 说明 | | ------------ | ------- | ---- | ---------------- | -| country | string | 是 | 指定国家。 | -| locale | string | 是 | 显示指定国家的区域ID。 | +| language | string | 是 | 指定语言。 | +| locale | string | 是 | 显示指定语言的区域ID。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | **返回值：** | 类型 | 说明 | | ------ | ------------- | -| string | 指定国家的本地化显示文本。 | +| string | 指定语言的本地化显示文本。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - i18n.getDisplayCountry("zh-CN", "en-GB", true); - i18n.getDisplayCountry("zh-CN", "en-GB"); + try { + var displayLanguage = i18n.System.getDisplayLanguage("zh", "en-GB"); + } catch(error) { + console.error(`call System.getDisplayLanguage failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### getSystemLanguages9+ -## i18n.isRTL7+ - -isRTL(locale: string): boolean +static getSystemLanguages(): Array<string> -获取是否为从右至左显示语言。 +获取系统支持的语言列表。 **系统能力**：SystemCapability.Global.I18n -**参数：** +**返回值：** -| 参数名 | 类型 | 说明 | -| ------ | ------ | ------- | -| locale | string | 指定区域ID。 | +| 类型 | 说明 | +| ------------------- | ------------ | +| Array<string> | 系统支持的语言ID列表。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 | +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - i18n.isRTL("zh-CN");// 中文不是RTL语言，返回false - i18n.isRTL("ar-EG");// 阿语是RTL语言，返回true + try { + var systemLanguages = i18n.System.getSystemLanguages(); + } catch(error) { + console.error(`call System.getSystemLanguages failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### getSystemCountries9+ -## i18n.getSystemLanguage - -getSystemLanguage(): string +static getSystemCountries(language: string): Array<string> -获取系统语言。 +获取针对输入语言系统支持的区域列表。 **系统能力**：SystemCapability.Global.I18n +**参数：** + +| 参数名 | 类型 | 说明 | +| -------- | ------ | ----- | +| language | string | 语言ID。 | + **返回值：** -| 类型 | 说明 | -| ------ | ------- | -| string | 系统语言ID。 | +| 类型 | 说明 | +| ------------------- | ------------ | +| Array<string> | 系统支持的区域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}.`) + } + ``` -设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。 +### isSuggested9+ -此接口为系统接口。 +static isSuggested(language: string, region?: string): boolean -**需要权限**：ohos.permission.UPDATE_CONFIGURATION +判断当前语言和区域是否匹配。 **系统能力**：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 - 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}.`) + } ``` +### getSystemLanguage9+ -## i18n.getSystemLanguages9+ +static getSystemLanguage(): string -getSystemLanguages(): Array<string> - -获取系统支持的语言列表。 - -此接口为系统接口。 +获取系统语言。 **系统能力**：SystemCapability.Global.I18n **返回值：** -| 类型 | 说明 | -| ------------------- | ------------ | -| Array<string> | 系统支持的语言ID列表。 | +| 类型 | 说明 | +| ------ | ------- | +| string | 系统语言ID。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - i18n.getSystemLanguages(); + try { + var systemLanguage = i18n.System.getSystemLanguage(); + } catch(error) { + console.error(`call System.getSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### setSystemLanguage9+ -## i18n.getSystemCountries9+ +static setSystemLanguage(language: string): void -getSystemCountries(language: string): Array<string> - -获取针对输入语言系统支持的区域列表。 +设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。 此接口为系统接口。 +**需要权限**：ohos.permission.UPDATE_CONFIGURATION + **系统能力**：SystemCapability.Global.I18n **参数：** @@ -189,21 +251,26 @@ getSystemCountries(language: string): Array<string> | -------- | ------ | ----- | | language | string | 语言ID。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ------------------- | ------------ | -| Array<string> | 系统支持的区域ID列表。 | +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - i18n.getSystemCountries('zh'); + try { + i18n.System.setSystemLanguage('zh'); + } catch(error) { + console.error(`call System.setSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### getSystemRegion9+ -## i18n.getSystemRegion - -getSystemRegion(): string +static getSystemRegion(): string 获取系统地区。 @@ -215,15 +282,26 @@ getSystemRegion(): string | ------ | ------- | | string | 系统地区ID。 | +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | + **示例：** ```js - i18n.getSystemRegion(); + try { + var systemRegion = i18n.System.getSystemRegion(); + } catch(error) { + console.error(`call System.getSystemRegion failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### setSystemRegion9+ -## i18n.setSystemRegion - -setSystemRegion(region: string): boolean +static setSystemRegion(region: string): void 设置系统区域。 @@ -239,21 +317,26 @@ setSystemRegion(region: string): boolean | ------ | ------ | ----- | | region | string | 地区ID。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ------- | ------------------------------------- | -| boolean | 返回true，表示系统区域设置成功；返回false，表示系统区域设置失败。 | +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - i18n.setSystemRegion('CN'); + try { + i18n.System.setSystemRegion('CN'); + } catch(error) { + console.error(`call System.setSystemRegion failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### getSystemLocale9+ -## i18n.getSystemLocale - -getSystemLocale(): string +static getSystemLocale(): string 获取系统区域。 @@ -265,15 +348,26 @@ getSystemLocale(): string | ------ | ------- | | string | 系统区域ID。 | +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | + **示例：** ```js - i18n.getSystemLocale(); + try { + var systemLocale = i18n.System.getSystemLocale(); + } catch(error) { + console.error(`call System.getSystemLocale failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### setSystemLocale9+ -## i18n.setSystemLocale - -setSystemLocale(locale: string): boolean +static setSystemLocale(locale: string): void 设置系统Locale。 @@ -289,159 +383,465 @@ setSystemLocale(locale: string): boolean | ------ | ------ | --------------- | | locale | string | 指定区域ID，例如zh-CN。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | 返回true，表示系统Locale设置成功；返回false，表示系统Locale设置失败。 | +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```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}.`) + } ``` +### is24HourClock9+ -## i18n.isSuggested9+ - -isSuggested(language: string, region?: string): boolean - -判断当前语言和区域是否匹配。 +static is24HourClock(): boolean -此接口为系统接口。 +判断系统时间是否为24小时制。 **系统能力**：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 - 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}.`) + } ``` +### set24HourClock9+ -## i18n.getCalendar8+ +static set24HourClock(option: boolean): void -getCalendar(locale: string, type? : string): Calendar +修改系统时间的24小时制设置。 -获取日历对象。 +此接口为系统接口。 + +**需要权限**：ohos.permission.UPDATE_CONFIGURATION **系统能力**：SystemCapability.Global.I18n **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------------------------------- | -| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。 | -| type | string | 否 | 合法的日历类型，目前合法的类型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。当type没有给出时，采用区域默认的日历类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ---------------------------------------- | +| option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ---------------------- | ----- | -| [Calendar](#calendar8) | 日历对象。 | +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```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}.`) + } ``` +### addPreferredLanguage9+ -## Calendar8+ - +static addPreferredLanguage(language: string, index?: number): void -### setTime8+ +在系统偏好语言列表中的指定位置添加偏好语言。 -setTime(date: Date): void +此接口为系统接口。 -设置日历对象内部的时间日期。 +**需要权限**：ohos.permission.UPDATE_CONFIGURATION **系统能力**：SystemCapability.Global.I18n **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ---- | ---- | ----------------- | -| date | Date | 是 | 将要设置的日历对象的内部时间日期。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ---------- | +| language | string | 是 | 待添加的偏好语言。 | +| index | number | 否 | 偏好语言的添加位置。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - var calendar = i18n.getCalendar("en-US", "gregory"); - var date = new Date(2021, 10, 7, 8, 0, 0, 0); - calendar.setTime(date); + // 将语言zh-CN添加到系统偏好语言列表中 + var language = 'zh-CN'; + var index = 0; + try { + i18n.System.addPreferredLanguage(language, index); + } catch(error) { + console.error(`call System.addPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### removePreferredLanguage9+ -### setTime8+ +static removePreferredLanguage(index: number): void -setTime(time: number): void +删除系统偏好语言列表中指定位置的偏好语言。 -设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 +此接口为系统接口。 + +**需要权限**：ohos.permission.UPDATE_CONFIGURATION **系统能力**：SystemCapability.Global.I18n **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ---------------------------------------- | -| time | number | 是 | time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | --------------------- | +| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```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}.`) + } ``` +### getPreferredLanguageList9+ -### set8+ - -set(year: number, month: number, date:number, hour?: number, minute?: number, second?: number): void +static getPreferredLanguageList(): Array<string> -设置日历对象的年、月、日、时、分、秒。 +获取系统偏好语言列表。 **系统能力**：SystemCapability.Global.I18n -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------ | -| year | number | 是 | 设置的年。 | -| month | number | 是 | 设置的月。 | -| date | number | 是 | 设置的日。 | -| hour | number | 否 | 设置的小时。 | -| minute | number | 否 | 设置的分钟。 | -| second | number | 否 | 设置的秒。 | +| 类型 | 说明 | +| ------------------- | --------- | +| Array<string> | 系统偏好语言列表。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | **示例：** ```js - var calendar = i18n.getCalendar("zh-Hans"); - calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 + try { + var preferredLanguageList = i18n.System.getPreferredLanguageList(); + } catch(error) { + console.error(`call System.getPreferredLanguageList failed, error code: ${error.code}, message: ${error.message}.`) + } ``` +### getFirstPreferredLanguage9+ -### setTimeZone8+ - -setTimeZone(timezone: string): void +static getFirstPreferredLanguage(): string -设置日历对象的时区。 +获取偏好语言列表中的第一个偏好语言。 **系统能力**：SystemCapability.Global.I18n -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ------------------------- | -| timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 | +| 类型 | 说明 | +| ------ | -------------- | +| string | 偏好语言列表中的第一个语言。 | + +**错误码：** + +以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 890001 | Unspported para value. | + +**示例：** + ```js + try { + var firstPreferredLanguage = i18n.System.getFirstPreferredLanguage(); + } catch(error) { + console.error(`call System.getFirstPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + +### getAppPreferredLanguage9+ + +static getAppPreferredLanguage(): string + +获取应用的偏好语言。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------ | -------- | +| 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}.`) + } + ``` + +### setUsingLocalDigit9+ + +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}.`) + } + ``` + +### getUsingLocalDigit9+ + +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.isRTL7+ + +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.getCalendar8+ + +getCalendar(locale: string, type? : string): Calendar + +获取日历对象。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------------------------------- | +| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。 | +| type | string | 否 | 合法的日历类型，目前合法的类型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。当type没有给出时，采用区域默认的日历类型。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------- | ----- | +| [Calendar](#calendar8) | 日历对象。 | + +**示例：** + ```js + i18n.getCalendar("zh-Hans", "gregory"); + ``` + + +## Calendar8+ + + +### setTime8+ + +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); + ``` + + +### setTime8+ + +setTime(time: number): void + +设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------------------------------- | +| time | number | 是 | time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 | + +**示例：** + ```js + var calendar = i18n.getCalendar("en-US", "gregory"); + calendar.setTime(10540800000); + ``` + + +### set8+ + +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 + ``` + + +### setTimeZone8+ + +setTimeZone(timezone: string): void + +设置日历对象的时区。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------- | +| timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 | **示例：** ```js @@ -770,39 +1170,6 @@ getLocationName(number: string, locale: string): string | measureSystem | string | 是 | 是 | 单位的度量体系，取值包括："SI", "US", "UK"。 | -## Util(deprecated) - - -### unitConvert(deprecated) - -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", "short", "narrow"。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ----------------------- | -| string | 按照toUnit的单位格式化后，得到的字符串。 | - - ## getInstance8+ getInstance(locale?:string): IndexUtil @@ -901,256 +1268,19 @@ getIndex(text: string): string ``` -## Character(deprecated) - - -### isDigit(deprecated) - -static isDigit(char: string): boolean +## i18n.getLineInstance8+ -判断字符串char是否是数字。 +getLineInstance(locale: string): BreakIterator -> **说明：** -> 从API version 9开始废弃。建议使用[isDigit](#isdigit9)代替。 -> -> 从 API version 8开始支持。 +获取一个用于断句的[BreakIterator](#breakiterator8)对象。 **系统能力**：SystemCapability.Global.I18n **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ------------------------------------ | -| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 | - - -### isSpaceChar(deprecated) - -static isSpaceChar(char: string): boolean - -判断字符串char是否是空格符。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isSpaceChar](#isspacechar9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | -------------------------------------- | -| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 | - - -### isWhitespace(deprecated) - -static isWhitespace(char: string): boolean - -判断字符串char是否是空白符。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isWhitespace](#iswhitespace9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | -------------------------------------- | -| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 | - - -### isRTL(deprecated) - -static isRTL(char: string): boolean - -判断字符串char是否是从右到左语言的字符。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isRTL](#isrtl9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 | - - -### isIdeograph(deprecated) - -static isIdeograph(char: string): boolean - -判断字符串char是否是表意文字。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isIdeograph](#isideograph9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 | - - -### isLetter(deprecated) - -static isLetter(char: string): boolean - -判断字符串char是否是字母。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isLetter](#isletter9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ------------------------------------ | -| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 | - - -### isLowerCase(deprecated) - -static isLowerCase(char: string): boolean - -判断字符串char是否是小写字母。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isLowerCase](#islowercase9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 | - - -### isUpperCase(deprecated) - -static isUpperCase(char: string): boolean - -判断字符串char是否是大写字母。 - -> **说明：** -> 从API version 9开始废弃。建议使用[isUpperCase](#isuppercase9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 | - - -### getType(deprecated) - -static getType(char: string): string - -获取输入字符串的一般类别值。 - -> **说明：** -> 从API version 9开始废弃。建议使用[getType](#gettype9)代替。 -> -> 从 API version 8开始支持 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----- | -| char | string | 是 | 输入字符。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ----------- | -| string | 输入字符的一般类别值。 | - - -## i18n.getLineInstance8+ - -getLineInstance(locale: string): BreakIterator - -获取一个用于断句的[BreakIterator](#breakiterator8)对象。 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------------------------------- | -| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。生成的[BreakIterator](#breakiterator8)将按照locale所指定的区域的规则来进行断句。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------------------------------- | +| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。生成的[BreakIterator](#breakiterator8)将按照locale所指定的区域的规则来进行断句。 | **返回值：** @@ -1389,232 +1519,61 @@ isBoundary(offset: number): boolean ``` -## i18n.is24HourClock7+ +## i18n.getTimeZone7+ -is24HourClock(): boolean +getTimeZone(zoneID?: string): TimeZone -判断系统时间是否为24小时制。 +获取时区ID对应的时区对象。 **系统能力**：SystemCapability.Global.I18n +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ----- | +| zondID | string | 否 | 时区ID。 | + **返回值：** -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 | +| 类型 | 说明 | +| -------- | ------------ | +| TimeZone | 时区ID对应的时区对象。 | **示例：** ```js - var is24HourClock = i18n.is24HourClock(); + var timezone = i18n.getTimeZone(); ``` -## i18n.set24HourClock7+ - -set24HourClock(option: boolean): boolean +## TimeZone -修改系统时间的24小时制设置。 -**需要权限**：ohos.permission.UPDATE_CONFIGURATION +### getID -**系统能力**：SystemCapability.Global.I18n +getID(): string -**参数：** +获取时区对象的ID。 -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------- | ---- | ---------------------------------------- | -| option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 | +**系统能力**：SystemCapability.Global.I18n **返回值：** -| 类型 | 说明 | -| ------- | ----------------------------- | -| boolean | 返回true，表示修改成功；返回false，表示修改失败。 | +| 类型 | 说明 | +| ------ | ------------ | +| string | 时区对象对应的时区ID。 | **示例：** ```js - // 将系统时间设置为24小时制 - var success = i18n.set24HourClock(true); + var timezone = i18n.getTimeZone(); + timezone.getID(); ``` -## i18n.addPreferredLanguage8+ - -addPreferredLanguage(language: string, index?: number): boolean +### getDisplayName -在系统偏好语言列表中的指定位置添加偏好语言。 +getDisplayName(locale?: string, isDST?: boolean): string -**需要权限**：ohos.permission.UPDATE_CONFIGURATION - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ---------- | -| language | string | 是 | 待添加的偏好语言。 | -| index | number | 否 | 偏好语言的添加位置。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ----------------------------- | -| boolean | 返回true，表示添加成功；返回false，表示添加失败。 | - -**示例：** - ```js - // 将语言zh-CN添加到系统偏好语言列表中 - var language = 'zh-CN'; - var index = 0; - var success = i18n.addPreferredLanguage(language, index); - ``` - - -## i18n.removePreferredLanguage8+ - -removePreferredLanguage(index: number): boolean - -删除系统偏好语言列表中指定位置的偏好语言。 - -**需要权限**：ohos.permission.UPDATE_CONFIGURATION - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | --------------------- | -| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ----------------------------- | -| boolean | 返回true，表示删除成功；返回false，表示删除失败。 | - -**示例：** - ```js - // 删除系统偏好语言列表中的第一个偏好语言 - var index = 0; - var success = i18n.removePreferredLanguage(index); - ``` - - -## i18n.getPreferredLanguageList8+ - -getPreferredLanguageList(): Array<string> - -获取系统偏好语言列表。 - -**系统能力**：SystemCapability.Global.I18n - -**返回值：** - -| 类型 | 说明 | -| ------------------- | --------- | -| Array<string> | 系统偏好语言列表。 | - -**示例：** - ```js - var preferredLanguageList = i18n.getPreferredLanguageList(); - ``` - - -## i18n.getFirstPreferredLanguage8+ - -getFirstPreferredLanguage(): string - -获取偏好语言列表中的第一个偏好语言。 - -**系统能力**：SystemCapability.Global.I18n - -**返回值：** - -| 类型 | 说明 | -| ------ | -------------- | -| string | 偏好语言列表中的第一个语言。 | - -**示例：** - ```js - var firstPreferredLanguage = i18n.getFirstPreferredLanguage(); - ``` - - -## i18n.getAppPreferredLanguage9+ - -getAppPreferredLanguage(): string - -获取应用的偏好语言。 - -**系统能力**：SystemCapability.Global.I18n - -**返回值：** - -| 类型 | 说明 | -| ------ | -------- | -| string | 应用的偏好语言。 | - -**示例：** - ```js - var appPreferredLanguage = i18n.getAppPreferredLanguage(); - ``` - - -## i18n.getTimeZone7+ - -getTimeZone(zoneID?: string): TimeZone - -获取时区ID对应的时区对象。 - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ----- | -| zondID | string | 否 | 时区ID。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | ------------ | -| TimeZone | 时区ID对应的时区对象。 | - -**示例：** - ```js - var timezone = i18n.getTimeZone(); - ``` - - -## TimeZone - - -### getID - -getID(): string - -获取时区对象的ID。 - -**系统能力**：SystemCapability.Global.I18n - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------ | -| string | 时区对象对应的时区ID。 | - -**示例：** - ```js - var timezone = i18n.getTimeZone(); - timezone.getID(); - ``` - - -### getDisplayName - -getDisplayName(locale?: string, isDST?: boolean): string - -获取时区对象在指定区域的表示。 +获取时区对象在指定区域的表示。 **系统能力**：SystemCapability.Global.I18n @@ -1773,56 +1732,6 @@ static getTimezoneFromCity(cityID: string): TimeZone ``` -## i18n.setUsingLocalDigit9+ - -setUsingLocalDigit(flag: boolean): boolean - -设置是否打开本地数字开关。 - -此接口为系统接口。 - -**需要权限**：ohos.permission.UPDATE_CONFIGURATION - -**系统能力**：SystemCapability.Global.I18n - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------- | ---- | ------------------------------- | -| flag | boolean | 是 | true表示打开本地数字开关，false表示关闭本地数字开关。 | - -**返回值：** - -| 类型 | 说明 | -| ------- | ----------------------------------- | -| boolean | true表示本地数字开关设置成功，false表示本地数字开关设置失败。 | - -**示例：** - ```ts - var status = i18n.setUsingLocalDigit(true); - ``` - - -## i18n.getUsingLocalDigit9+ - -getUsingLocalDigit(): boolean - -获取系统当前是否打开本地数字开关。 - -**系统能力**：SystemCapability.Global.I18n - -**返回值：** - -| 类型 | 说明 | -| ------- | ---------------------------------------- | -| boolean | true表示系统当前已打开本地数字开关，false表示系统当前未打开本地数字开关。 | - -**示例：** - ```ts - var status = i18n.getUsingLocalDigit(); - ``` - - ## Transliterator9+ @@ -2192,4 +2101,535 @@ static getDateOrder(locale: string): string **示例：** ```js i18n.I18NUtil.getDateOrder("zh-CN"); - ``` \ No newline at end of file + ``` + + +## i18n.getDisplayCountry(deprecated) + +getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string + +获取指定国家的本地化显示文本。 + +从API version 9开始不再维护，建议使用[System.getDisplayCountry](#getdisplaycountry9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ------- | ---- | ---------------- | +| country | string | 是 | 指定国家。 | +| locale | string | 是 | 显示指定国家的区域ID。 | +| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------- | +| string | 指定国家的本地化显示文本。 | + +**示例：** + ```js + i18n.getDisplayCountry("zh-CN", "en-GB", true); + i18n.getDisplayCountry("zh-CN", "en-GB"); + ``` + + +## i18n.getDisplayLanguage(deprecated) + +getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string + +获取指定语言的本地化显示文本。 + +从API version 9开始不再维护，建议使用[System.getDisplayLanguage](#getdisplaylanguage9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ------- | ---- | ---------------- | +| language | string | 是 | 指定语言。 | +| locale | string | 是 | 显示指定语言的区域ID。 | +| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------- | +| string | 指定语言的本地化显示文本。 | + +**示例：** + ```js + i18n.getDisplayLanguage("zh", "en-GB", true); + i18n.getDisplayLanguage("zh", "en-GB"); + ``` + + +## i18n.getSystemLanguage(deprecated) + +getSystemLanguage(): string + +获取系统语言。 + +从API version 9开始不再维护，建议使用[System.getSystemLanguage](#getsystemlanguage9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------ | ------- | +| string | 系统语言ID。 | + +**示例：** + ```js + i18n.getSystemLanguage(); + ``` + + +## i18n.getSystemRegion(deprecated) + +getSystemRegion(): string + +获取系统地区。 + +从API version 9开始不再维护，建议使用[System.getSystemRegion](#getsystemregion9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------ | ------- | +| string | 系统地区ID。 | + +**示例：** + ```js + i18n.getSystemRegion(); + ``` + + +## i18n.getSystemLocale(deprecated) + +getSystemLocale(): string + +获取系统区域。 + +从API version 9开始不再维护，建议使用[System.getSystemLocale](#getsystemlocale9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------ | ------- | +| string | 系统区域ID。 | + +**示例：** + ```js + i18n.getSystemLocale(); + ``` + + +## i18n.is24HourClock(deprecated) + +is24HourClock(): boolean + +判断系统时间是否为24小时制。 + +从API version 9开始不再维护，建议使用[System.is24HourClock](#is24hourclock9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------- | ---------------------------------------- | +| boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 | + +**示例：** + ```js + var is24HourClock = i18n.is24HourClock(); + ``` + + +## i18n.set24HourClock(deprecated) + +set24HourClock(option: boolean): boolean + +修改系统时间的24小时制设置。 + +从API version 9开始不再维护，建议使用[System.set24HourClock](#set24hourclock9)代替。 + +**需要权限**：ohos.permission.UPDATE_CONFIGURATION + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ---------------------------------------- | +| option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ----------------------------- | +| boolean | 返回true，表示修改成功；返回false，表示修改失败。 | + +**示例：** + ```js + // 将系统时间设置为24小时制 + var success = i18n.set24HourClock(true); + ``` + + +## i18n.addPreferredLanguage(deprecated) + +addPreferredLanguage(language: string, index?: number): boolean + +在系统偏好语言列表中的指定位置添加偏好语言。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[System.addPreferredLanguage](#addpreferredlanguage9)代替。 + +**需要权限**：ohos.permission.UPDATE_CONFIGURATION + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ---------- | +| language | string | 是 | 待添加的偏好语言。 | +| index | number | 否 | 偏好语言的添加位置。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ----------------------------- | +| boolean | 返回true，表示添加成功；返回false，表示添加失败。 | + +**示例：** + ```js + // 将语言zh-CN添加到系统偏好语言列表中 + var language = 'zh-CN'; + var index = 0; + var success = i18n.addPreferredLanguage(language, index); + ``` + + +## i18n.removePreferredLanguage(deprecated) + +removePreferredLanguage(index: number): boolean + +删除系统偏好语言列表中指定位置的偏好语言。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[System.removePreferredLanguage](#removepreferredlanguage9)代替。 + +**需要权限**：ohos.permission.UPDATE_CONFIGURATION + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | --------------------- | +| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ----------------------------- | +| boolean | 返回true，表示删除成功；返回false，表示删除失败。 | + +**示例：** + ```js + // 删除系统偏好语言列表中的第一个偏好语言 + var index = 0; + var success = i18n.removePreferredLanguage(index); + ``` + + +## i18n.getPreferredLanguageList(deprecated) + +getPreferredLanguageList(): Array<string> + +获取系统偏好语言列表。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[System.getPreferredLanguageList](#getpreferredlanguagelist9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------------------- | --------- | +| Array<string> | 系统偏好语言列表。 | + +**示例：** + ```js + var preferredLanguageList = i18n.getPreferredLanguageList(); + ``` + + +## i18n.getFirstPreferredLanguage(deprecated) + +getFirstPreferredLanguage(): string + +获取偏好语言列表中的第一个偏好语言。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[System.getFirstPreferredLanguage](#getfirstpreferredlanguage9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**返回值：** + +| 类型 | 说明 | +| ------ | -------------- | +| string | 偏好语言列表中的第一个语言。 | + +**示例：** + ```js + var firstPreferredLanguage = i18n.getFirstPreferredLanguage(); + ``` + + +## Util(deprecated) + + +### unitConvert(deprecated) + +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 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ---------------------------------------- | +| fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 | +| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 | +| value | number | 是 | 要被转换的单位的数量值。 | +| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 | +| style | string | 否 | 格式化使用的风格，取值包括："long", "short", "narrow"。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ----------------------- | +| string | 按照toUnit的单位格式化后，得到的字符串。 | + + +## Character(deprecated) + + +### isDigit(deprecated) + +static isDigit(char: string): boolean + +判断字符串char是否是数字。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isDigit](#isdigit9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ------------------------------------ | +| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 | + + +### isSpaceChar(deprecated) + +static isSpaceChar(char: string): boolean + +判断字符串char是否是空格符。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isSpaceChar](#isspacechar9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | -------------------------------------- | +| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 | + + +### isWhitespace(deprecated) + +static isWhitespace(char: string): boolean + +判断字符串char是否是空白符。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isWhitespace](#iswhitespace9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | -------------------------------------- | +| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 | + + +### isRTL(deprecated) + +static isRTL(char: string): boolean + +判断字符串char是否是从右到左语言的字符。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isRTL](#isrtl9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ---------------------------------------- | +| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 | + + +### isIdeograph(deprecated) + +static isIdeograph(char: string): boolean + +判断字符串char是否是表意文字。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isIdeograph](#isideograph9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ---------------------------------------- | +| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 | + + +### isLetter(deprecated) + +static isLetter(char: string): boolean + +判断字符串char是否是字母。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isLetter](#isletter9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ------------------------------------ | +| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 | + + +### isLowerCase(deprecated) + +static isLowerCase(char: string): boolean + +判断字符串char是否是小写字母。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isLowerCase](#islowercase9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ---------------------------------------- | +| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 | + + +### isUpperCase(deprecated) + +static isUpperCase(char: string): boolean + +判断字符串char是否是大写字母。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[isUpperCase](#isuppercase9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ---------------------------------------- | +| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 | + + +### getType(deprecated) + +static getType(char: string): string + +获取输入字符串的一般类别值。 + +从API version 8开始支持，从API version 9开始不再维护，建议使用[getType](#gettype9)代替。 + +**系统能力**：SystemCapability.Global.I18n + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----- | +| char | string | 是 | 输入字符。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ----------- | +| string | 输入字符的一般类别值。 | diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-i18n.md b/zh-cn/application-dev/reference/errorcodes/errorcode-i18n.md new file mode 100644 index 0000000000..90b123f479 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-i18n.md @@ -0,0 +1,29 @@ +# I18n错误码 + +## 890001 参数类型错误 + +### 错误信息 +Unspported para value. + +### 错误描述 +当接口传入错误的参数类型时，系统会产生此错误码。 + +### 可能原因 +该错误码表示参数错误，可能原因是传入参数的类型错误。 + +### 处理步骤 +检查参数的类型是否正确。 + +## 890002 配置项参数错误 + +### 错误信息 +Unspported option value. + +### 错误描述 +当接口的option配置参数中包含不合法的配置项时，系统会产生此错误码。 + +### 可能原因 +该错误码表示配置项参数错误，可能原因是option参数中使用了不支持的配置项。 + +### 处理步骤 +检查option参数中是否使用了不合法的配置项。 \ No newline at end of file -- GitLab