國際化-I18n

2024-01-23 15:50 更新

本模塊提供系統(tǒng)相關(guān)的或者增強的國際化能力,包括區(qū)域管理、電話號碼處理、日歷等,相關(guān)接口為ECMA 402標(biāo)準(zhǔn)中未定義的補充接口。

Intl模塊提供了ECMA 402標(biāo)準(zhǔn)定義的基礎(chǔ)國際化接口,與本模塊共同使用可提供完整地國際化支持能力。

說明
  • 本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨標(biāo)記接口的起始版本。

  • I18N模塊包含國際化能力增強接口(未在ECMA 402中定義),包括區(qū)域管理、電話號碼處理、日歷等,國際化基礎(chǔ)能力請參考Intl模塊。

導(dǎo)入模塊

  1. import I18n from '@ohos.i18n';

System9+

getDisplayCountry9+

static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string

獲取指定國家的本地化顯示文本。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

country

string

指定國家。

locale

string

顯示指定國家的區(qū)域ID。

sentenceCase

boolean

本地化顯示文本是否要首字母大寫。

返回值:

類型

說明

string

指定國家的本地化顯示文本。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let displayCountry = I18n.System.getDisplayCountry("zh-CN", "en-GB"); // displayCountry = "China"
  3. } catch(error) {
  4. console.error(`call System.getDisplayCountry failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getDisplayLanguage9+

static getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string

獲取指定語言的本地化顯示文本。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

language

string

指定語言。

locale

string

顯示指定語言的區(qū)域ID。

sentenceCase

boolean

本地化顯示文本是否要首字母大寫。

返回值:

類型

說明

string

指定語言的本地化顯示文本。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let displayLanguage = I18n.System.getDisplayLanguage("zh", "en-GB"); // displayLanguage = Chinese
  3. } catch(error) {
  4. console.error(`call System.getDisplayLanguage failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getSystemLanguages9+

static getSystemLanguages(): Array<string>

獲取系統(tǒng)支持的語言列表。語言的詳細(xì)說明參見實例化Locale對象。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

Array<string>

系統(tǒng)支持的語言ID列表。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let systemLanguages = I18n.System.getSystemLanguages(); // [ "en-Latn-US", "zh-Hans" ]
  3. } catch(error) {
  4. console.error(`call System.getSystemLanguages failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getSystemCountries9+

static getSystemCountries(language: string): Array<string>

獲取針對輸入語言系統(tǒng)支持的國家或地區(qū)列表。國家或地區(qū)的詳細(xì)說明參見實例化Locale對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

language

string

語言ID。

返回值:

類型

說明

Array<string>

系統(tǒng)支持的區(qū)域ID列表。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let systemCountries = I18n.System.getSystemCountries('zh'); // systemCountries = [ "ZW", "YT", "YE", ..., "ER", "CN", "DE" ],共計240個國家或地區(qū)
  3. } catch(error) {
  4. console.error(`call System.getSystemCountries failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

isSuggested9+

static isSuggested(language: string, region?: string): boolean

判斷當(dāng)前語言和地區(qū)是否匹配。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

language

string

合法的語言ID,例如zh。

region

string

合法的地區(qū)ID,例如CN

返回值:

類型

說明

boolean

返回true,表示當(dāng)前語言和地區(qū)匹配;返回false,表示當(dāng)前語言和地區(qū)不匹配。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let res = I18n.System.isSuggested('zh', 'CN'); // res = true
  3. } catch(error) {
  4. console.error(`call System.isSuggested failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getSystemLanguage9+

static getSystemLanguage(): string

獲取系統(tǒng)語言。語言的詳細(xì)說明參見實例化Locale對象

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

系統(tǒng)語言ID。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let systemLanguage = I18n.System.getSystemLanguage(); // systemLanguage為當(dāng)前系統(tǒng)語言
  3. } catch(error) {
  4. console.error(`call System.getSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getSystemRegion9+

static getSystemRegion(): string

獲取系統(tǒng)地區(qū)。地區(qū)的詳細(xì)說明參見實例化Locale對象。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

系統(tǒng)地區(qū)ID。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let systemRegion = I18n.System.getSystemRegion(); // 獲取系統(tǒng)當(dāng)前地區(qū)設(shè)置
  3. } catch(error) {
  4. console.error(`call System.getSystemRegion failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getSystemLocale9+

static getSystemLocale(): string

獲取系統(tǒng)區(qū)域。區(qū)域的詳細(xì)說明參見實例化Locale對象

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

系統(tǒng)區(qū)域ID。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let systemLocale = I18n.System.getSystemLocale(); // 獲取系統(tǒng)當(dāng)前Locale
  3. } catch(error) {
  4. console.error(`call System.getSystemLocale failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

is24HourClock9+

static is24HourClock(): boolean

判斷系統(tǒng)時間是否為24小時制。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

boolean

返回true,表示系統(tǒng)24小時開關(guān)開啟;返回false,表示系統(tǒng)24小時開關(guān)關(guān)閉。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let is24HourClock = I18n.System.is24HourClock(); // 系統(tǒng)24小時開關(guān)是否開啟
  3. } catch(error) {
  4. console.error(`call System.is24HourClock failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getPreferredLanguageList9+

static getPreferredLanguageList(): Array<string>

獲取系統(tǒng)偏好語言列表。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

Array<string>

系統(tǒng)偏好語言列表。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let preferredLanguageList = I18n.System.getPreferredLanguageList(); // 獲取系統(tǒng)當(dāng)前偏好語言列表
  3. } catch(error) {
  4. console.error(`call System.getPreferredLanguageList failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getFirstPreferredLanguage9+

static getFirstPreferredLanguage(): string

獲取偏好語言列表中的第一個偏好語言。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

偏好語言列表中的第一個語言。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let firstPreferredLanguage = I18n.System.getFirstPreferredLanguage(); // 獲取系統(tǒng)當(dāng)前偏好語言列表中的第一個偏好語言
  3. } catch(error) {
  4. console.error(`call System.getFirstPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getAppPreferredLanguage9+

static getAppPreferredLanguage(): string

獲取應(yīng)用的偏好語言。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

應(yīng)用的偏好語言。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let appPreferredLanguage = I18n.System.getAppPreferredLanguage(); // 獲取應(yīng)用偏好語言
  3. } catch(error) {
  4. console.error(`call System.getAppPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

getUsingLocalDigit9+

static getUsingLocalDigit(): boolean

判斷系統(tǒng)是否使用本地數(shù)字。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

boolean

true表示系統(tǒng)當(dāng)前已打開本地數(shù)字開關(guān),false表示系統(tǒng)當(dāng)前未打開本地數(shù)字開關(guān)。

錯誤碼:

以下錯誤碼的詳細(xì)介紹請參見ohos.i18n錯誤碼。

錯誤碼ID

錯誤信息

890001

param value not valid

示例:

  1. try {
  2. let status = I18n.System.getUsingLocalDigit(); // 判斷本地化數(shù)字開關(guān)是否打開
  3. } catch(error) {
  4. console.error(`call System.getUsingLocalDigit failed, error code: ${error.code}, message: ${error.message}.`);
  5. }

I18n.isRTL

isRTL(locale: string): boolean

獲取是否為從右至左顯示語言。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

指定區(qū)域ID。

返回值:

類型

說明

boolean

true表示該locale從右至左顯示語言;false表示該locale從左至右顯示語言。

示例:

  1. I18n.isRTL("zh-CN");// 中文不是RTL語言,返回false
  2. I18n.isRTL("ar-EG");// 阿語是RTL語言,返回true

I18n.getCalendar8+

getCalendar(locale: string, type? : string): Calendar

獲取日歷對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

合法的locale值,例如zh-Hans-CN。

type

string

合法的日歷類型,目前合法的類型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。當(dāng)type沒有給出時,采用區(qū)域默認(rèn)的日歷類型。

返回值:

類型

說明

Calendar

日歷對象。

示例:

  1. I18n.getCalendar("zh-Hans", "chinese"); // 獲取中國農(nóng)歷日歷對象

Calendar8+

setTime8+

setTime(date: Date): void

設(shè)置日歷對象內(nèi)部的時間日期。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

date

Date

將要設(shè)置的日歷對象的內(nèi)部時間日期。

示例:

  1. let calendar = I18n.getCalendar("en-US", "gregory");
  2. let date = new Date(2021, 10, 7, 8, 0, 0, 0);
  3. calendar.setTime(date);

setTime8+

setTime(time: number): void

設(shè)置日歷對象內(nèi)部的時間日期, time為從1970.1.1 00:00:00 GMT逝去的毫秒數(shù)。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

time

number

time為從1970.1.1 00:00:00 GMT逝去的毫秒數(shù)。

示例:

  1. let calendar = I18n.getCalendar("en-US", "gregory");
  2. calendar.setTime(10540800000);

set8+

set(year: number, month: number, date:number, hour?: number, minute?: number, second?: number): void

設(shè)置日歷對象的年、月、日、時、分、秒。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

year

number

設(shè)置的年。

month

number

設(shè)置的月。

date

number

設(shè)置的日。

hour

number

設(shè)置的小時。

minute

number

設(shè)置的分鐘。

second

number

設(shè)置的秒。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00

setTimeZone8+

setTimeZone(timezone: string): void

設(shè)置日歷對象的時區(qū)。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

timezone

string

設(shè)置的時區(qū)id,如“Asia/Shanghai”。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.setTimeZone("Asia/Shanghai");

getTimeZone8+

getTimeZone(): string

獲取日歷對象的時區(qū)。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

日歷對象的時區(qū)id。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.setTimeZone("Asia/Shanghai");
  3. let timezone = calendar.getTimeZone(); // timezone = "Asia/Shanghai"

getFirstDayOfWeek8+

getFirstDayOfWeek(): number

獲取日歷對象的一周起始日。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

獲取一周的起始日,1代表周日,7代表周六。

示例:

  1. let calendar = I18n.getCalendar("en-US", "gregory");
  2. let firstDayOfWeek = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 1

setFirstDayOfWeek8+

setFirstDayOfWeek(value: number): void

設(shè)置每一周的起始日。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

value

number

設(shè)置一周的起始日,1代表周日,7代表周六。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.setFirstDayOfWeek(3);
  3. let firstDayOfWeek = calendar.getFirstDayOfWeek(); // firstDayOfWeek = 3

getMinimalDaysInFirstWeek8+

getMinimalDaysInFirstWeek(): number

獲取一年中第一周的最小天數(shù)。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

一年中第一周的最小天數(shù)。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. let minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 1

setMinimalDaysInFirstWeek8+

setMinimalDaysInFirstWeek(value: number): void

設(shè)置一年中第一周的最小天數(shù)。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

value

number

一年中第一周的最小天數(shù)。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.setMinimalDaysInFirstWeek(3);
  3. let minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek(); // minimalDaysInFirstWeek = 3

get8+

get(field: string): number

獲取日歷對象中與field相關(guān)聯(lián)的值。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

field

string

通過field來獲取日歷對象相應(yīng)的值。目前支持的field值有 era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week, day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month。

返回值:

類型

說明

number

與field相關(guān)聯(lián)的值,如當(dāng)前Calendar對象的內(nèi)部日期的年份為1990,get("year")返回1990。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
  3. let hourOfDay = calendar.get("hour_of_day"); // hourOfDay = 8

getDisplayName8+

getDisplayName(locale: string): string

獲取日歷對象在locale所指定的區(qū)域的名字。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

locale指定獲取哪個區(qū)域下該calendar的名字,如buddhist在en-US上顯示的名稱為“Buddhist Calendar”。

返回值:

類型

說明

string

日歷在locale所指示的區(qū)域的名字。

示例:

  1. let calendar = I18n.getCalendar("en-US", "buddhist");
  2. let calendarName = calendar.getDisplayName("zh"); // calendarName = "佛歷"

isWeekend8+

isWeekend(date?: Date): boolean

判斷給定的日期是否在日歷中是周末。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

date

Date

判斷日期在日歷中是否是周末。如果不傳日期參數(shù),則判斷當(dāng)前日期是否為周末。

返回值:

類型

說明

boolean

當(dāng)所判斷的日期為周末時,返回 true,否則返回false。

示例:

  1. let calendar = I18n.getCalendar("zh-Hans");
  2. calendar.set(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
  3. calendar.isWeekend(); // false
  4. let date = new Date(2011, 11, 6, 9, 0, 0);
  5. calendar.isWeekend(date); // true

PhoneNumberFormat8+

constructor8+

constructor(country: string, options?: PhoneNumberFormatOptions)

創(chuàng)建電話號碼格式化對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

country

string

表示電話號碼所屬國家或地區(qū)代碼。

options

PhoneNumberFormatOptions

電話號碼格式化對象的相關(guān)選項。

示例:

  1. let phoneNumberFormat= new I18n.PhoneNumberFormat("CN", {"type": "E164"});

isValidNumber8+

isValidNumber(number: string): boolean

判斷傳入的電話號碼格式是否正確。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

number

string

待判斷的電話號碼。

返回值:

類型

說明

boolean

返回true表示電話號碼的格式正確,返回false表示電話號碼的格式錯誤。

示例:

  1. let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
  2. let isValidNumber = phonenumberfmt.isValidNumber("123****8911"); // isValidNumber = true

format8+

format(number: string): string

對電話號碼進行格式化。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

number

string

待格式化的電話號碼。

返回值:

類型

說明

string

格式化后的電話號碼。

示例:

  1. let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
  2. let formattedPhoneNumber = phonenumberfmt.format("123****8911"); // formattedPhoneNumber = "123 **** 8911"

getLocationName9+

getLocationName(number: string, locale: string): string

獲取電話號碼歸屬地。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

number

string

電話號碼

locale

string

區(qū)域ID

返回值:

類型

說明

string

電話號碼歸屬地。

示例:

  1. let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
  2. let locationName = phonenumberfmt.getLocationName("123****8911", "zh-CN");

PhoneNumberFormatOptions9+

表示電話號碼格式化對象可設(shè)置的屬性。

系統(tǒng)能力:SystemCapability.Global.I18n

名稱

類型

可讀

可寫

說明

type

string

表示對電話號碼格式化的類型,取值范圍:"E164", "INTERNATIONAL", "NATIONAL", "RFC3966"。

UnitInfo8+

度量衡單位信息。

系統(tǒng)能力:SystemCapability.Global.I18n

名稱

類型

可讀

可寫

說明

unit

string

單位的名稱,如:"meter", "inch", "cup"等。

measureSystem

string

單位的度量體系,取值包括:"SI", "US", "UK"。

getInstance8+

getInstance(locale?:string): IndexUtil

創(chuàng)建并返回IndexUtil對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

包含區(qū)域設(shè)置信息的字符串,包括語言以及可選的腳本和區(qū)域。

返回值:

類型

說明

IndexUtil

locale對應(yīng)的IndexUtil對象。

示例:

  1. let indexUtil = I18n.getInstance("zh-CN");

IndexUtil8+

getIndexList8+

getIndexList(): Array<string>

獲取當(dāng)前l(fā)ocale對應(yīng)的索引列表。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

Array<string>

返回當(dāng)前l(fā)ocale對應(yīng)的索引列表。

示例:

  1. let indexUtil = I18n.getInstance("zh-CN");
  2. // indexList = [ "...", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N",
  3. // "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "..." ]
  4. let indexList = indexUtil.getIndexList();

addLocale8+

addLocale(locale: string): void

將新的locale對應(yīng)的索引加入當(dāng)前索引列表。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

包含區(qū)域設(shè)置信息的字符串,包括語言以及可選的腳本和區(qū)域。

示例:

  1. let indexUtil = I18n.getInstance("zh-CN");
  2. indexUtil.addLocale("en-US");

getIndex8+

getIndex(text: string): string

獲取text對應(yīng)的索引。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

text

string

待計算索引值的輸入文本。

返回值:

類型

說明

string

輸入文本對應(yīng)的索引值。

示例:

  1. let indexUtil = I18n.getInstance("zh-CN");
  2. let index = indexUtil.getIndex("hi"); // index = "H"

I18n.getLineInstance8+

getLineInstance(locale: string): BreakIterator

獲取一個用于斷句的BreakIterator對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

合法的locale值,例如zh-Hans-CN。生成的BreakIterator將按照locale所指定的區(qū)域的規(guī)則來進行斷句。

返回值:

類型

說明

BreakIterator

用于進行斷句的處理器。

示例:

  1. let iterator = I18n.getLineInstance("en");

BreakIterator8+

setLineBreakText8+

setLineBreakText(text: string): void

設(shè)置BreakIterator要處理的文本。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

text

string

指定BreakIterator進行斷句的文本。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit."); // 設(shè)置短句文本

getLineBreakText8+

getLineBreakText(): string

獲取BreakIterator當(dāng)前處理的文本。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

BreakIterator對象正在處理的文本

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let breakText = iterator.getLineBreakText(); // breakText = "Apple is my favorite fruit."

current8+

current(): number

獲取BreakIterator對象在當(dāng)前處理的文本中的位置。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

BreakIterator在當(dāng)前所處理的文本中的位置。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let currentPos = iterator.current(); // currentPos = 0

first8+

first(): number

BreakIterator對象設(shè)置到第一個可斷句的分割點。第一個分割點總是被處理的文本的起始位置。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

被處理文本的第一個分割點的偏移量。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let firstPos = iterator.first(); // firstPos = 0

last8+

last(): number

BreakIterator對象的位置設(shè)置到最后一個可斷句的分割點。最后一個分割點總是被處理文本末尾的下一個位置。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

被處理的文本的最后一個分割點的偏移量

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let lastPos = iterator.last(); // lastPos = 27

next8+

next(index?: number): number

如果index給出,并且index是一個正數(shù)將BreakIterator向后移動number個可斷句的分割點,如果n是一個負(fù)數(shù),向前移動相應(yīng)個分割點。若index沒有給出,則相當(dāng)于index = 1。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

index

number

BreakIterator將要移動的分割點數(shù),正數(shù)代表向后移動,負(fù)數(shù)代表向前移動。若index沒有給出,則按照index=1處理。

返回值:

類型

說明

number

返回移動了index個分割點后,當(dāng)前BreakIterator在文本中的位置。若移動index個分割點后超出了所處理的文本的長度范圍,返回-1。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let pos = iterator.first(); // pos = 0
  4. pos = iterator.next(); // pos = 6
  5. pos = iterator.next(10); // pos = -1

previous8+

previous(): number

BreakIterator移動到前一個分割點處。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

返回移動到前一個分割點后,當(dāng)前BreakIterator在文本中的位置。若移動index個分割點后超出了所處理的文本的長度范圍,返回-1。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let pos = iterator.first(); // pos = 0
  4. pos = iterator.next(3); // pos = 12
  5. pos = iterator.previous(); // pos = 9

following8+

following(offset: number): number

BreakIterator設(shè)置到由offset指定的位置的后面一個分割點。返回移動后BreakIterator的位置。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

offset

number

BreakIterator對象的位置設(shè)置到由offset所指定的位置的下一個分割點。

返回值:

類型

說明

number

返回BreakIterator移動后的位置,如果由offset所指定的位置的下一個分割點超出了文本的范圍則返回-1。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let pos = iterator.following(0); // pos = 6
  4. pos = iterator.following(100); // pos = -1
  5. pos = iterator.current(); // pos = 27

isBoundary8+

isBoundary(offset: number): boolean

如果offset所指定的文本位置是一個分割點,那么返回true,否則返回false。如果返回true, 將BreakIterator對象設(shè)置到offset所指定的位置, 否則相當(dāng)于調(diào)用following(offset)。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

offset

number

指定需要進行判斷的位置

返回值:

類型

說明

boolean

如果是一個分割點返回true, 否則返回false。

示例:

  1. let iterator = I18n.getLineInstance("en");
  2. iterator.setLineBreakText("Apple is my favorite fruit.");
  3. let isBoundary = iterator.isBoundary(0); // isBoundary = true;
  4. isBoundary = iterator.isBoundary(5); // isBoundary = false;

I18n.getTimeZone

getTimeZone(zoneID?: string): TimeZone

獲取時區(qū)ID對應(yīng)的時區(qū)對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

zondID

string

時區(qū)ID。

返回值:

類型

說明

TimeZone

時區(qū)ID對應(yīng)的時區(qū)對象。

示例:

  1. let timezone = I18n.getTimeZone();

TimeZone

getID

getID(): string

獲取時區(qū)對象的ID。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

時區(qū)對象對應(yīng)的時區(qū)ID。

示例:

  1. let timezone = I18n.getTimeZone();
  2. let timezoneID = timezone.getID(); // timezoneID = "Asia/Shanghai"

getDisplayName

getDisplayName(locale?: string, isDST?: boolean): string

獲取時區(qū)的本地化表示。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

區(qū)域ID。

isDST

boolean

表示獲取時區(qū)對象的表示時是否考慮夏令時。

返回值:

類型

說明

string

時區(qū)對象在指定區(qū)域的表示。

示例:

  1. let timezone = I18n.getTimeZone();
  2. let timezoneName = timezone.getDisplayName("zh-CN", false); // timezoneName = "中國標(biāo)準(zhǔn)時間"

getRawOffset

getRawOffset(): number

獲取時區(qū)對象表示的時區(qū)與UTC時區(qū)的偏差。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

number

時區(qū)對象表示的時區(qū)與UTC時區(qū)的偏差,單位是毫秒。

示例:

  1. let timezone = I18n.getTimeZone();
  2. let offset = timezone.getRawOffset(); // offset = 28800000

getOffset

getOffset(date?: number): number

獲取某一時刻時區(qū)對象表示的時區(qū)與UTC時區(qū)的偏差。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

date

number

待計算偏差的時刻,單位是毫秒。

默認(rèn)值:系統(tǒng)時間。

返回值:

類型

說明

number

某一時刻時區(qū)對象表示的時區(qū)與UTC時區(qū)的偏差。

示例:

  1. let timezone = I18n.getTimeZone();
  2. let offset = timezone.getOffset(1234567890); // offset = 28800000

getAvailableIDs9+

static getAvailableIDs(): Array<string>

獲取系統(tǒng)支持的時區(qū)ID。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

Array<string>

系統(tǒng)支持的時區(qū)ID列表。

示例:

  1. // ids = ["America/Adak", "America/Anchorage", "America/Bogota", "America/Denver", "America/Los_Angeles", "America/Montevideo", "America/Santiago", "America/Sao_Paulo", "Asia/Ashgabat", "Asia/Hovd", "Asia/Jerusalem", "Asia/Magadan", "Asia/Omsk", "Asia/Shanghai", "Asia/Tokyo", "Asia/Yerevan", "Atlantic/Cape_Verde", "Australia/Lord_Howe", "Europe/Dublin", "Europe/London", "Europe/Moscow", "Pacific/Auckland", "Pacific/Easter", "Pacific/Pago-Pago"], 當(dāng)前共支持24個時區(qū)
  2. let ids = I18n.TimeZone.getAvailableIDs();

getAvailableZoneCityIDs9+

static getAvailableZoneCityIDs(): Array<string>

獲取系統(tǒng)支持的時區(qū)城市ID。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

Array<string>

系統(tǒng)支持的時區(qū)城市ID列表。

示例:

  1. // cityIDs = ["Auckland", "Magadan", "Lord Howe Island", "Tokyo", "Shanghai", "Hovd", "Omsk", "Ashgabat", "Yerevan", "Moscow", "Tel Aviv", "Dublin", "London", "Praia", "Montevideo", "Brasília", "Santiago", "Bogotá", "Easter Island", "Salt Lake City", "Los Angeles", "Anchorage", "Adak", "Pago Pago"],當(dāng)前共支持24個時區(qū)城市
  2. let cityIDs = I18n.TimeZone.getAvailableZoneCityIDs();

getCityDisplayName9+

static getCityDisplayName(cityID: string, locale: string): string

獲取某時區(qū)城市在locale下的本地化顯示。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

cityID

string

時區(qū)城市ID。

locale

string

區(qū)域ID。

返回值:

類型

說明

string

時區(qū)城市在locale下的本地化顯示。

示例:

  1. let displayName = I18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN"); // displayName = "上海(中國)"

getTimezoneFromCity9+

static getTimezoneFromCity(cityID: string): TimeZone

創(chuàng)建某時區(qū)城市對應(yīng)的時區(qū)對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

cityID

string

時區(qū)城市ID。

返回值:

類型

說明

TimeZone

時區(qū)城市對應(yīng)的時區(qū)對象。

示例:

  1. let timezone = I18n.TimeZone.getTimezoneFromCity("Shanghai");

Transliterator9+

getAvailableIDs9+

static getAvailableIDs(): string[]

獲取音譯支持的ID列表。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string[]

音譯支持的ID列表。

示例:

  1. // ids共支持671個。每一個id由使用中劃線分割的兩部分組成,格式為 source-destination。例如ids = ["Han-Latin","Latin-ASCII", "Amharic-Latin/BGN","Accents-Any", ...],Han-Latin表示漢語轉(zhuǎn)為譯拉丁文,Amharic-Latin表示阿姆哈拉語轉(zhuǎn)為拉丁文。
  2. // 更多使用信息可以參考ISO-15924。
  3. let ids = I18n.Transliterator.getAvailableIDs();

getInstance9+

static getInstance(id: string): Transliterator

創(chuàng)建音譯對象。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

id

string

音譯支持的ID。

返回值:

類型

說明

Transliterator

音譯對象。

示例:

  1. let transliterator = I18n.Transliterator.getInstance("Any-Latn");

transform9+

transform(text: string): string

將輸入字符串從源格式轉(zhuǎn)換為目標(biāo)格式。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

text

string

輸入字符串。

返回值:

類型

說明

string

轉(zhuǎn)換后的字符串。

示例:

  1. let transliterator = I18n.Transliterator.getInstance("Any-Latn");
  2. let res = transliterator.transform("中國"); // res = "zhōng guó"

Unicode9+

isDigit9+

static isDigit(char: string): boolean

判斷字符串char是否是數(shù)字。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是數(shù)字,返回false表示輸入的字符不是數(shù)字。

示例:

  1. let isdigit = I18n.Unicode.isDigit("1"); // isdigit = true

isSpaceChar9+

static isSpaceChar(char: string): boolean

判斷字符串char是否是空格符。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是空格符,返回false表示輸入的字符不是空格符。

示例:

  1. let isspacechar = I18n.Unicode.isSpaceChar("a"); // isspacechar = false

isWhitespace9+

static isWhitespace(char: string): boolean

判斷字符串char是否是空白符。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是空白符,返回false表示輸入的字符不是空白符。

示例:

  1. let iswhitespace = I18n.Unicode.isWhitespace("a"); // iswhitespace = false

isRTL9+

static isRTL(char: string): boolean

判斷字符串char是否是從右到左語言的字符。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是從右到左語言的字符,返回false表示輸入的字符不是從右到左語言的字符。

示例:

  1. let isrtl = I18n.Unicode.isRTL("a"); // isrtl = false

isIdeograph9+

static isIdeograph(char: string): boolean

判斷字符串char是否是表意文字。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是表意文字,返回false表示輸入的字符不是表意文字。

示例:

  1. let isideograph = I18n.Unicode.isIdeograph("a"); // isideograph = false

isLetter9+

static isLetter(char: string): boolean

判斷字符串char是否是字母。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是字母,返回false表示輸入的字符不是字母。

示例:

  1. let isletter = I18n.Unicode.isLetter("a"); // isletter = true

isLowerCase9+

static isLowerCase(char: string): boolean

判斷字符串char是否是小寫字母。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是小寫字母,返回false表示輸入的字符不是小寫字母。

示例:

  1. let islowercase = I18n.Unicode.isLowerCase("a"); // islowercase = true

isUpperCase9+

static isUpperCase(char: string): boolean

判斷字符串char是否是大寫字母。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是大寫字母,返回false表示輸入的字符不是大寫字母。

示例:

  1. let isuppercase = I18n.Unicode.isUpperCase("a"); // isuppercase = false

getType9+

static getType(char: string): string

獲取輸入字符串的一般類別值。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

string

輸入字符的一般類別值。

示例:

  1. let type = I18n.Unicode.getType("a"); // type = "U_LOWERCASE_LETTER"

I18NUtil9+

unitConvert9+

static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string

將fromUnit的單位轉(zhuǎn)換為toUnit的單位,并根據(jù)區(qū)域與風(fēng)格進行格式化。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

fromUnit

UnitInfo

要被轉(zhuǎn)換的單位。

toUnit

UnitInfo

要轉(zhuǎn)換為的單位。

value

number

要被轉(zhuǎn)換的單位的數(shù)量值。

locale

string

格式化時使用的區(qū)域參數(shù),如:zh-Hans-CN。

style

string

格式化使用的風(fēng)格,取值包括:"long", "short", "narrow"。

返回值:

類型

說明

string

按照toUnit的單位格式化后,得到的字符串。

示例:

  1. let res = I18n.I18NUtil.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); // res = 236.588 liters

getDateOrder9+

static getDateOrder(locale: string): string

獲取某一區(qū)域的日期的年、月、日排列順序。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

locale

string

格式化時使用的區(qū)域參數(shù),如:zh-Hans-CN。

返回值:

類型

說明

string

返回某一區(qū)域的日期的年、月、日排列順序

示例:

  1. let order = I18n.I18NUtil.getDateOrder("zh-CN"); // order = "y-L-d"

I18n.getDisplayCountry(deprecated)

getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string

獲取指定國家的本地化顯示文本。

從API version 9開始不再維護,建議使用System.getDisplayCountry代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

country

string

指定國家。

locale

string

顯示指定國家的區(qū)域ID。

sentenceCase

boolean

本地化顯示文本是否要首字母大寫。

返回值:

類型

說明

string

指定國家的本地化顯示文本。

示例:

  1. let countryName = I18n.getDisplayCountry("zh-CN", "en-GB", true); // countryName = true
  2. countryName = I18n.getDisplayCountry("zh-CN", "en-GB"); // countryName = true

I18n.getDisplayLanguage(deprecated)

getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string

獲取指定語言的本地化顯示文本。

從API version 9開始不再維護,建議使用System.getDisplayLanguage代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

language

string

指定語言。

locale

string

顯示指定語言的區(qū)域ID。

sentenceCase

boolean

本地化顯示文本是否要首字母大寫。

返回值:

類型

說明

string

指定語言的本地化顯示文本。

示例:

  1. let languageName = I18n.getDisplayLanguage("zh", "en-GB", true); // languageName = "Chinese"
  2. languageName = I18n.getDisplayLanguage("zh", "en-GB"); // languageName = "Chinese"

I18n.getSystemLanguage(deprecated)

getSystemLanguage(): string

獲取系統(tǒng)語言。

從API version 9開始不再維護,建議使用System.getSystemLanguage代替。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

系統(tǒng)語言ID。

示例:

  1. let systemLanguage = I18n.getSystemLanguage(); // 返回當(dāng)前系統(tǒng)語言

I18n.getSystemRegion(deprecated)

getSystemRegion(): string

獲取系統(tǒng)地區(qū)。

從API version 9開始不再維護,建議使用System.getSystemRegion代替。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

系統(tǒng)地區(qū)ID。

示例:

  1. let region = I18n.getSystemRegion(); // 返回當(dāng)前系統(tǒng)地區(qū)

I18n.getSystemLocale(deprecated)

getSystemLocale(): string

獲取系統(tǒng)區(qū)域。

從API version 9開始不再維護,建議使用System.getSystemLocale代替。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

系統(tǒng)區(qū)域ID。

示例:

  1. let locale = I18n.getSystemLocale(); // 返回系統(tǒng)Locale

I18n.is24HourClock(deprecated)

is24HourClock(): boolean

判斷系統(tǒng)時間是否為24小時制。

從API version 9開始不再維護,建議使用System.is24HourClock代替。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

boolean

返回true,表示系統(tǒng)24小時開關(guān)開啟;返回false,表示系統(tǒng)24小時開關(guān)關(guān)閉。

示例:

  1. let is24HourClock = I18n.is24HourClock();

I18n.set24HourClock(deprecated)

set24HourClock(option: boolean): boolean

修改系統(tǒng)時間的24小時制設(shè)置。

從API version 9開始不再維護,建議使用System.set24HourClock代替。

需要權(quán)限:ohos.permission.UPDATE_CONFIGURATION

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

option

boolean

option為true,表示開啟系統(tǒng)24小時制開關(guān);返回false,表示關(guān)閉系統(tǒng)24小時開關(guān)。

返回值:

類型

說明

boolean

返回true,表示修改成功;返回false,表示修改失敗。

示例:

  1. // 將系統(tǒng)時間設(shè)置為24小時制
  2. let success = I18n.set24HourClock(true);

I18n.addPreferredLanguage(deprecated)

addPreferredLanguage(language: string, index?: number): boolean

在系統(tǒng)偏好語言列表中的指定位置添加偏好語言。

從API version 8開始支持,從API version 9開始不再維護,建議使用System.addPreferredLanguage代替。

需要權(quán)限:ohos.permission.UPDATE_CONFIGURATION

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

language

string

待添加的偏好語言。

index

number

偏好語言的添加位置。

返回值:

類型

說明

boolean

返回true,表示添加成功;返回false,表示添加失敗。

示例:

  1. // 將語言zh-CN添加到系統(tǒng)偏好語言列表中
  2. let language = 'zh-CN';
  3. let index = 0;
  4. let success = I18n.addPreferredLanguage(language, index);

I18n.removePreferredLanguage(deprecated)

removePreferredLanguage(index: number): boolean

刪除系統(tǒng)偏好語言列表中指定位置的偏好語言。

從API version 8開始支持,從API version 9開始不再維護,建議使用System.removePreferredLanguage代替。

需要權(quán)限:ohos.permission.UPDATE_CONFIGURATION

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

index

number

待刪除偏好語言在系統(tǒng)偏好語言列表中的位置。

返回值:

類型

說明

boolean

返回true,表示刪除成功;返回false,表示刪除失敗。

示例:

  1. // 刪除系統(tǒng)偏好語言列表中的第一個偏好語言
  2. let index = 0;
  3. let success = I18n.removePreferredLanguage(index);

I18n.getPreferredLanguageList(deprecated)

getPreferredLanguageList(): Array<string>

獲取系統(tǒng)偏好語言列表。

從API version 8開始支持,從API version 9開始不再維護,建議使用System.getPreferredLanguageList代替。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

Array<string>

系統(tǒng)偏好語言列表。

示例:

  1. let preferredLanguageList = I18n.getPreferredLanguageList(); // 獲取系統(tǒng)偏好語言列表

I18n.getFirstPreferredLanguage(deprecated)

getFirstPreferredLanguage(): string

獲取偏好語言列表中的第一個偏好語言。

從API version 8開始支持,從API version 9開始不再維護,建議使用System.getFirstPreferredLanguage代替。

系統(tǒng)能力:SystemCapability.Global.I18n

返回值:

類型

說明

string

偏好語言列表中的第一個語言。

示例:

  1. let firstPreferredLanguage = I18n.getFirstPreferredLanguage();

Util(deprecated)

unitConvert(deprecated)

static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string

將fromUnit的單位轉(zhuǎn)換為toUnit的單位,并根據(jù)區(qū)域與風(fēng)格進行格式化。

從API version 8開始支持,從API version 9開始不再維護,建議使用unitConvert代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

fromUnit

UnitInfo

要被轉(zhuǎn)換的單位。

toUnit

UnitInfo

要轉(zhuǎn)換為的單位。

value

number

要被轉(zhuǎn)換的單位的數(shù)量值。

locale

string

格式化時使用的區(qū)域參數(shù),如:zh-Hans-CN。

style

string

格式化使用的風(fēng)格,取值包括:"long", "short", "narrow"。

返回值:

類型

說明

string

按照toUnit的單位格式化后,得到的字符串。

Character(deprecated)

isDigit(deprecated)

static isDigit(char: string): boolean

判斷字符串char是否是數(shù)字。

從API version 8開始支持,從API version 9開始不再維護,建議使用isDigit代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是數(shù)字,返回false表示輸入的字符不是數(shù)字。

isSpaceChar(deprecated)

static isSpaceChar(char: string): boolean

判斷字符串char是否是空格符。

從API version 8開始支持,從API version 9開始不再維護,建議使用isSpaceChar代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是空格符,返回false表示輸入的字符不是空格符。

isWhitespace(deprecated)

static isWhitespace(char: string): boolean

判斷字符串char是否是空白符。

從API version 8開始支持,從API version 9開始不再維護,建議使用isWhitespace代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是空白符,返回false表示輸入的字符不是空白符。

isRTL(deprecated)

static isRTL(char: string): boolean

判斷字符串char是否是從右到左語言的字符。

從API version 8開始支持,從API version 9開始不再維護,建議使用isRTL代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是從右到左語言的字符,返回false表示輸入的字符不是從右到左語言的字符。

isIdeograph(deprecated)

static isIdeograph(char: string): boolean

判斷字符串char是否是表意文字。

從API version 8開始支持,從API version 9開始不再維護,建議使用isIdeograph代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是表意文字,返回false表示輸入的字符不是表意文字。

isLetter(deprecated)

static isLetter(char: string): boolean

判斷字符串char是否是字母。

從API version 8開始支持,從API version 9開始不再維護,建議使用isLetter代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是字母,返回false表示輸入的字符不是字母。

isLowerCase(deprecated)

static isLowerCase(char: string): boolean

判斷字符串char是否是小寫字母。

從API version 8開始支持,從API version 9開始不再維護,建議使用isLowerCase代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是小寫字母,返回false表示輸入的字符不是小寫字母。

isUpperCase(deprecated)

static isUpperCase(char: string): boolean

判斷字符串char是否是大寫字母。

從API version 8開始支持,從API version 9開始不再維護,建議使用isUpperCase代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

boolean

返回true表示輸入的字符是大寫字母,返回false表示輸入的字符不是大寫字母。

getType(deprecated)

static getType(char: string): string

獲取輸入字符串的一般類別值。

從API version 8開始支持,從API version 9開始不再維護,建議使用getType代替。

系統(tǒng)能力:SystemCapability.Global.I18n

參數(shù):

參數(shù)名

類型

必填

說明

char

string

輸入字符。

返回值:

類型

說明

string

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號