@ohos.i18n (国际化-I18n)

本模块提供系统相关的或者增强的国际化能力，包括区域管理、电话号码处理、日历等，相关接口为ECMA 402标准中未定义的补充接口。 Intl模块提供了ECMA 402标准定义的基础国际化接口，与本模块共同使用可提供完整地国际化支持能力。

说明：

• 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• I18N模块包含国际化能力增强接口（未在ECMA 402中定义），包括区域管理、电话号码处理、日历等，国际化基础能力请参考Intl模块。

导入模块

import I18n from '@ohos.i18n';

System⁹⁺

getDisplayCountry⁹⁺

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

获取指定国家的本地化显示文本。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

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

getDisplayLanguage⁹⁺

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

获取指定语言的本地化显示文本。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

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

getSystemLanguages⁹⁺

static getSystemLanguages(): Array<string>

获取系统支持的语言列表。语言的详细说明参见实例化Locale对象。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

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

getSystemCountries⁹⁺

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

获取针对输入语言系统支持的国家或地区列表。国家或地区的详细说明参见实例化Locale对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let systemCountries = I18n.System.getSystemCountries('zh'); // systemCountries = [ "ZW", "YT", "YE", ..., "ER", "CN", "DE" ]，共计240个国家或地区
} catch(error) {
  console.error(`call System.getSystemCountries failed, error code: ${error.code}, message: ${error.message}.`);
}

isSuggested⁹⁺

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

判断当前语言和地区是否匹配。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

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

getSystemLanguage⁹⁺

static getSystemLanguage(): string

获取系统语言。语言的详细说明参见实例化Locale对象。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let systemLanguage = I18n.System.getSystemLanguage();  // systemLanguage为当前系统语言
} catch(error) {
  console.error(`call System.getSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`);
}

setSystemLanguage⁹⁺

static setSystemLanguage(language: string): void

设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  I18n.System.setSystemLanguage('zh'); // 设置系统当前语言为 "zh"
} catch(error) {
  console.error(`call System.setSystemLanguage failed, error code: ${error.code}, message: ${error.message}.`);
}

getSystemRegion⁹⁺

static getSystemRegion(): string

获取系统地区。地区的详细说明参见实例化Locale对象。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let systemRegion = I18n.System.getSystemRegion(); // 获取系统当前地区设置
} catch(error) {
  console.error(`call System.getSystemRegion failed, error code: ${error.code}, message: ${error.message}.`);
}

setSystemRegion⁹⁺

static setSystemRegion(region: string): void

设置系统区域。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  I18n.System.setSystemRegion('CN');  // 设置系统当前地区为 "CN"
} catch(error) {
  console.error(`call System.setSystemRegion failed, error code: ${error.code}, message: ${error.message}.`);
}

getSystemLocale⁹⁺

static getSystemLocale(): string

获取系统区域。区域的详细说明参见实例化Locale对象。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let systemLocale = I18n.System.getSystemLocale();  // 获取系统当前Locale
} catch(error) {
  console.error(`call System.getSystemLocale failed, error code: ${error.code}, message: ${error.message}.`);
}

setSystemLocale⁹⁺

static setSystemLocale(locale: string): void

设置系统Locale。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  I18n.System.setSystemLocale('zh-CN');  // 设置系统当前Locale为 "zh-CN"
} catch(error) {
  console.error(`call System.setSystemLocale failed, error code: ${error.code}, message: ${error.message}.`);
}

is24HourClock⁹⁺

static is24HourClock(): boolean

判断系统时间是否为24小时制。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let is24HourClock = I18n.System.is24HourClock();  // 系统24小时开关是否开启
} catch(error) {
  console.error(`call System.is24HourClock failed, error code: ${error.code}, message: ${error.message}.`);
}

set24HourClock⁹⁺

static set24HourClock(option: boolean): void

修改系统时间的24小时制设置。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

// 将系统时间设置为24小时制
try {
  I18n.System.set24HourClock(true);
} catch(error) {
  console.error(`call System.set24HourClock failed, error code: ${error.code}, message: ${error.message}.`);
}

addPreferredLanguage⁹⁺

static addPreferredLanguage(language: string, index?: number): void

在系统偏好语言列表中的指定位置添加偏好语言。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

// 将语言zh-CN添加到系统偏好语言列表中
let language = 'zh-CN';
let index = 0;
try {
  I18n.System.addPreferredLanguage(language, index); // 将zh-CN添加到系统偏好语言列表的第1位
} catch(error) {
  console.error(`call System.addPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`);
}

removePreferredLanguage⁹⁺

static removePreferredLanguage(index: number): void

删除系统偏好语言列表中指定位置的偏好语言。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

// 删除系统偏好语言列表中的第一个偏好语言
let index = 0;
try {
  I18n.System.removePreferredLanguage(index);
} catch(error) {
  console.error(`call System.removePreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`);
}

getPreferredLanguageList⁹⁺

static getPreferredLanguageList(): Array<string>

获取系统偏好语言列表。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let preferredLanguageList = I18n.System.getPreferredLanguageList(); // 获取系统当前偏好语言列表
} catch(error) {
  console.error(`call System.getPreferredLanguageList failed, error code: ${error.code}, message: ${error.message}.`);
}

getFirstPreferredLanguage⁹⁺

static getFirstPreferredLanguage(): string

获取偏好语言列表中的第一个偏好语言。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let firstPreferredLanguage = I18n.System.getFirstPreferredLanguage();  // 获取系统当前偏好语言列表中的第一个偏好语言
} catch(error) {
  console.error(`call System.getFirstPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`);
}

getAppPreferredLanguage⁹⁺

static getAppPreferredLanguage(): string

获取应用的偏好语言。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let appPreferredLanguage = I18n.System.getAppPreferredLanguage(); // 获取应用偏好语言
} catch(error) {
  console.error(`call System.getAppPreferredLanguage failed, error code: ${error.code}, message: ${error.message}.`);
}

setUsingLocalDigit⁹⁺

static setUsingLocalDigit(flag: boolean): void

设置系统是否使用本地数字。

此接口为系统接口。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  I18n.System.setUsingLocalDigit(true); // 打开本地化数字开关
} catch(error) {
  console.error(`call System.setUsingLocalDigit failed, error code: ${error.code}, message: ${error.message}.`);
}

getUsingLocalDigit⁹⁺

static getUsingLocalDigit(): boolean

判断系统是否使用本地数字。

系统能力：SystemCapability.Global.I18n

返回值：

错误码：

以下错误码的详细介绍请参见ohos.i18n错误码。

示例：

try {
  let status = I18n.System.getUsingLocalDigit();  // 判断本地化数字开关是否打开
} catch(error) {
  console.error(`call System.getUsingLocalDigit failed, error code: ${error.code}, message: ${error.message}.`);
}

I18n.isRTL⁷⁺

isRTL(locale: string): boolean

获取是否为从右至左显示语言。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

I18n.getCalendar⁸⁺

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

获取日历对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

I18n.getCalendar("zh-Hans", "chinese"); // 获取中国农历日历对象

Calendar⁸⁺

setTime⁸⁺

setTime(date: Date): void

设置日历对象内部的时间日期。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

setTime⁸⁺

setTime(time: number): void

设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

set⁸⁺

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

设置日历对象的年、月、日、时、分、秒。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

setTimeZone⁸⁺

setTimeZone(timezone: string): void

设置日历对象的时区。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

getTimeZone⁸⁺

getTimeZone(): string

获取日历对象的时区。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

getFirstDayOfWeek⁸⁺

getFirstDayOfWeek(): number

获取日历对象的一周起始日。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

setFirstDayOfWeek⁸⁺

setFirstDayOfWeek(value: number): void

设置每一周的起始日。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

getMinimalDaysInFirstWeek⁸⁺

getMinimalDaysInFirstWeek(): number

获取一年中第一周的最小天数。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

setMinimalDaysInFirstWeek⁸⁺

setMinimalDaysInFirstWeek(value: number): void

设置一年中第一周的最小天数。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

get⁸⁺

get(field: string): number

获取日历对象中与field相关联的值。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

getDisplayName⁸⁺

getDisplayName(locale: string): string

获取日历对象在locale所指定的区域的名字。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isWeekend⁸⁺

isWeekend(date?: Date): boolean

判断给定的日期是否在日历中是周末。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

PhoneNumberFormat⁸⁺

constructor⁸⁺

constructor(country: string, options?: PhoneNumberFormatOptions)

创建电话号码格式化对象。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

isValidNumber⁸⁺

isValidNumber(number: string): boolean

判断传入的电话号码格式是否正确。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
let isValidNumber = phonenumberfmt.isValidNumber("15812312312"); // isValidNumber = true

format⁸⁺

format(number: string): string

对电话号码进行格式化。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
let formattedPhoneNumber = phonenumberfmt.format("15812312312"); // formattedPhoneNumber = "158 1231 2312"

getLocationName⁹⁺

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

获取电话号码归属地。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

let phonenumberfmt = new I18n.PhoneNumberFormat("CN");
let locationName = phonenumberfmt.getLocationName("15812312345", "zh-CN"); // locationName = "广东省湛江市"

PhoneNumberFormatOptions⁹⁺

表示电话号码格式化对象可设置的属性。

系统能力：SystemCapability.Global.I18n

UnitInfo⁸⁺

度量衡单位信息。

系统能力：SystemCapability.Global.I18n

getInstance⁸⁺

getInstance(locale?:string): IndexUtil

创建并返回IndexUtil对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

IndexUtil⁸⁺

getIndexList⁸⁺

getIndexList(): Array<string>

获取当前locale对应的索引列表。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

addLocale⁸⁺

addLocale(locale: string): void

将新的locale对应的索引加入当前索引列表。

系统能力：SystemCapability.Global.I18n

参数：

示例：

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

getIndex⁸⁺

getIndex(text: string): string

获取text对应的索引。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

I18n.getLineInstance⁸⁺

getLineInstance(locale: string): BreakIterator

获取一个用于断句的BreakIterator对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

BreakIterator⁸⁺

setLineBreakText⁸⁺

setLineBreakText(text: string): void

设置BreakIterator要处理的文本。

系统能力：SystemCapability.Global.I18n

参数：

示例：

let iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); // 设置短句文本

getLineBreakText⁸⁺

getLineBreakText(): string

获取BreakIterator当前处理的文本。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

current⁸⁺

current(): number

获取BreakIterator对象在当前处理的文本中的位置。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

first⁸⁺

first(): number

将BreakIterator对象设置到第一个可断句的分割点。第一个分割点总是被处理的文本的起始位置。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

last⁸⁺

last(): number

将BreakIterator对象的位置设置到最后一个可断句的分割点。最后一个分割点总是被处理文本末尾的下一个位置。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

next⁸⁺

next(index?: number): number

如果index给出，并且index是一个正数将BreakIterator向后移动number个可断句的分割点，如果n是一个负数，向前移动相应个分割点。若index没有给出，则相当于index = 1。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

previous⁸⁺

previous(): number

将BreakIterator移动到前一个分割点处。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

following⁸⁺

following(offset: number): number

将BreakIterator设置到由offset指定的位置的后面一个分割点。返回移动后BreakIterator的位置。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isBoundary⁸⁺

isBoundary(offset: number): boolean

如果offset所指定的文本位置是一个分割点，那么返回true，否则返回false。如果返回true, 将BreakIterator对象设置到offset所指定的位置, 否则相当于调用following(offset)。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

I18n.getTimeZone⁷⁺

getTimeZone(zoneID?: string): TimeZone

获取时区ID对应的时区对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

let timezone = I18n.getTimeZone();

TimeZone

getID

getID(): string

获取时区对象的ID。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

getDisplayName

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

获取时区的本地化表示。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

let timezone = I18n.getTimeZone();
let timezoneName = timezone.getDisplayName("zh-CN", false); // timezoneName = "中国标准时间"

getRawOffset

getRawOffset(): number

获取时区对象表示的时区与UTC时区的偏差。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

getOffset

getOffset(date?: number): number

获取某一时刻时区对象表示的时区与UTC时区的偏差。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

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

getAvailableIDs⁹⁺

static getAvailableIDs(): Array<string>

获取系统支持的时区ID。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

// 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"], 当前共支持24个时区
let ids = I18n.TimeZone.getAvailableIDs();

getAvailableZoneCityIDs⁹⁺

static getAvailableZoneCityIDs(): Array<string>

获取系统支持的时区城市ID。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

// 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"]，当前共支持24个时区城市
let cityIDs = I18n.TimeZone.getAvailableZoneCityIDs();

getCityDisplayName⁹⁺

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

获取某时区城市在locale下的本地化显示。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

getTimezoneFromCity⁹⁺

static getTimezoneFromCity(cityID: string): TimeZone

创建某时区城市对应的时区对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

Transliterator⁹⁺

getAvailableIDs⁹⁺

static getAvailableIDs(): string[]

获取音译支持的ID列表。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

// ids = ["ASCII-Latin", "Accents-Any", "Amharic-Latin/BGN", ...]，共支持671个id
// 每一个id由使用中划线分割的两部分组成，格式为 source-destination
let ids = I18n.Transliterator.getAvailableIDs();

getInstance⁹⁺

static getInstance(id: string): Transliterator

创建音译对象。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

transform⁹⁺

transform(text: string): string

将输入字符串从源格式转换为目标格式。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

Unicode⁹⁺

isDigit⁹⁺

static isDigit(char: string): boolean

判断字符串char是否是数字。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isSpaceChar⁹⁺

static isSpaceChar(char: string): boolean

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

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isWhitespace⁹⁺

static isWhitespace(char: string): boolean

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

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isRTL⁹⁺

static isRTL(char: string): boolean

判断字符串char是否是从右到左语言的字符。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isIdeograph⁹⁺

static isIdeograph(char: string): boolean

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

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isLetter⁹⁺

static isLetter(char: string): boolean

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

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isLowerCase⁹⁺

static isLowerCase(char: string): boolean

判断字符串char是否是小写字母。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

isUpperCase⁹⁺

static isUpperCase(char: string): boolean

判断字符串char是否是大写字母。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

getType⁹⁺

static getType(char: string): string

获取输入字符串的一般类别值。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

I18NUtil⁹⁺

unitConvert⁹⁺

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

将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

getDateOrder⁹⁺

static getDateOrder(locale: string): string

获取某一区域的日期的年、月、日排列顺序。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

let countryName = I18n.getDisplayCountry("zh-CN", "en-GB", true); // countryName = true
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代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

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

I18n.getSystemLanguage^(deprecated)

getSystemLanguage(): string

获取系统语言。

从API version 9开始不再维护，建议使用System.getSystemLanguage代替。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

let systemLanguage = I18n.getSystemLanguage(); // 返回当前系统语言

I18n.getSystemRegion^(deprecated)

getSystemRegion(): string

获取系统地区。

从API version 9开始不再维护，建议使用System.getSystemRegion代替。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

let region = I18n.getSystemRegion(); // 返回当前系统地区

I18n.getSystemLocale^(deprecated)

getSystemLocale(): string

获取系统区域。

从API version 9开始不再维护，建议使用System.getSystemLocale代替。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

let locale = I18n.getSystemLocale(); // 返回系统Locale

I18n.is24HourClock^(deprecated)

is24HourClock(): boolean

判断系统时间是否为24小时制。

从API version 9开始不再维护，建议使用System.is24HourClock代替。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

let is24HourClock = I18n.is24HourClock();

I18n.set24HourClock^(deprecated)

set24HourClock(option: boolean): boolean

修改系统时间的24小时制设置。

从API version 9开始不再维护，建议使用System.set24HourClock代替。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

// 将系统时间设置为24小时制
let success = I18n.set24HourClock(true);

I18n.addPreferredLanguage^(deprecated)

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

在系统偏好语言列表中的指定位置添加偏好语言。

从API version 8开始支持，从API version 9开始不再维护，建议使用System.addPreferredLanguage代替。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

// 将语言zh-CN添加到系统偏好语言列表中
let language = 'zh-CN';
let index = 0;
let success = I18n.addPreferredLanguage(language, index);

I18n.removePreferredLanguage^(deprecated)

removePreferredLanguage(index: number): boolean

删除系统偏好语言列表中指定位置的偏好语言。

从API version 8开始支持，从API version 9开始不再维护，建议使用System.removePreferredLanguage代替。

需要权限：ohos.permission.UPDATE_CONFIGURATION

系统能力：SystemCapability.Global.I18n

参数：

返回值：

示例：

// 删除系统偏好语言列表中的第一个偏好语言
let index = 0;
let success = I18n.removePreferredLanguage(index);

I18n.getPreferredLanguageList^(deprecated)

getPreferredLanguageList(): Array<string>

获取系统偏好语言列表。

从API version 8开始支持，从API version 9开始不再维护，建议使用System.getPreferredLanguageList代替。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

let preferredLanguageList = I18n.getPreferredLanguageList(); // 获取系统偏好语言列表

I18n.getFirstPreferredLanguage^(deprecated)

getFirstPreferredLanguage(): string

获取偏好语言列表中的第一个偏好语言。

从API version 8开始支持，从API version 9开始不再维护，建议使用System.getFirstPreferredLanguage代替。

系统能力：SystemCapability.Global.I18n

返回值：

示例：

let 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代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

Character^(deprecated)

isDigit^(deprecated)

static isDigit(char: string): boolean

判断字符串char是否是数字。

从API version 8开始支持，从API version 9开始不再维护，建议使用isDigit代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isSpaceChar^(deprecated)

static isSpaceChar(char: string): boolean

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

从API version 8开始支持，从API version 9开始不再维护，建议使用isSpaceChar代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isWhitespace^(deprecated)

static isWhitespace(char: string): boolean

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

从API version 8开始支持，从API version 9开始不再维护，建议使用isWhitespace代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isRTL^(deprecated)

static isRTL(char: string): boolean

判断字符串char是否是从右到左语言的字符。

从API version 8开始支持，从API version 9开始不再维护，建议使用isRTL代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isIdeograph^(deprecated)

static isIdeograph(char: string): boolean

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

从API version 8开始支持，从API version 9开始不再维护，建议使用isIdeograph代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isLetter^(deprecated)

static isLetter(char: string): boolean

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

从API version 8开始支持，从API version 9开始不再维护，建议使用isLetter代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isLowerCase^(deprecated)

static isLowerCase(char: string): boolean

判断字符串char是否是小写字母。

从API version 8开始支持，从API version 9开始不再维护，建议使用isLowerCase代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

isUpperCase^(deprecated)

static isUpperCase(char: string): boolean

判断字符串char是否是大写字母。

从API version 8开始支持，从API version 9开始不再维护，建议使用isUpperCase代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：

getType^(deprecated)

static getType(char: string): string

获取输入字符串的一般类别值。

从API version 8开始支持，从API version 9开始不再维护，建议使用getType代替。

系统能力：SystemCapability.Global.I18n

参数：

返回值：