Internationalization – I18N
This module provides system-related or enhanced I18N capabilities, such as locale management, phone number formatting, and calendar, through supplementary I18N APIs that are not defined in ECMA 402.
The Intl module provides basic I18N capabilities through the standard I18N APIs defined in ECMA 402. It works with the I18N module to provide a complete suite of I18N capabilities.
NOTE
The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import i18n from '@ohos.i18n';
i18n.getDisplayLanguage
getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string
Obtains the localized script for the specified language.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
language | string | Yes | Specified language. |
locale | string | Yes | Locale ID. |
sentenceCase | boolean | No | Whether to use sentence case for the localized script. |
Return Value
Type | Description |
---|---|
string | Localized script for the specified language. |
Example
i18n.getDisplayLanguage("zh", "en-GB", true);
i18n.getDisplayLanguage("zh", "en-GB");
i18n.getDisplayCountry
getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string
Obtains the localized script for the specified country.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
country | string | Yes | Specified country. |
locale | string | Yes | Locale ID. |
sentenceCase | boolean | No | Whether to use sentence case for the localized script. |
Return Value
Type | Description |
---|---|
string | Localized script for the specified country. |
Example
i18n.getDisplayCountry("zh-CN", "en-GB", true);
i18n.getDisplayCountry("zh-CN", "en-GB");
i18n.isRTL7+
isRTL(locale: string): boolean
Checks whether the localized script for the specified language is displayed from right to left.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Description |
---|---|---|
locale | string | Locale ID. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the localized script is displayed from right to left; returns false otherwise. |
Example
i18n.isRTL("zh-CN");// Since Chinese is not written from right to left, false is returned.
i18n.isRTL("ar-EG");// Since Arabic is written from right to left, true is returned.
i18n.getSystemLanguage
getSystemLanguage(): string
Obtains the system language.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | System language ID. |
Example
i18n.getSystemLanguage();
i18n.setSystemLanguage
setSystemLanguage(language: string): boolean
Sets the system language. Currently, this API does not support real-time updating of the system language.
System API: This is a system API.
Required permission: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
System API: This is a system API and cannot be called by third-party applications.
Parameters
Name | Type | Description |
---|---|---|
language | string | Language ID. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the operation is successful; returns false otherwise. |
Example
i18n.setSystemLanguage('zh');
i18n.getSystemLanguages
getSystemLanguages(): Array<string>
Obtains the list of system languages.
System API: This is a system API.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
Array<string> | List of the IDs of system languages. |
Example
i18n.getSystemLanguages();
i18n.getSystemCountries
getSystemCountries(language: string): Array<string>
Obtains the list of countries and regions supported for the specified language.
System API: This is a system API.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Description |
---|---|---|
language | string | Language ID. |
Return Value
Type | Description |
---|---|
Array<string> | List of the IDs of the countries and regions supported for the specified language. |
Example
i18n.getSystemCountries('zh');
i18n.getSystemRegion
getSystemRegion(): string
Obtains the system region.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | System region ID. |
Example
i18n.getSystemRegion();
i18n.setSystemRegion
setSystemRegion(region: string): boolean
Sets the system region.
System API: This is a system API.
Required permission: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Description |
---|---|---|
region | string | Region ID. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the operation is successful; returns false otherwise. |
Example
i18n.setSystemRegion('CN');
i18n.getSystemLocale
getSystemLocale(): string
Obtains the system locale.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | System locale ID. |
Example
i18n.getSystemLocale();
i18n.setSystemLocale
setSystemLocale(locale: string): boolean
Sets the system locale.
System API: This is a system API.
Required permission: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Description |
---|---|---|
locale | string | System locale ID, for example, zh-CN. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the operation is successful; returns false otherwise. |
Example
i18n.setSystemLocale('zh-CN');
i18n.isSuggested
isSuggested(language: string, region?: string): boolean
Checks whether the system language matches the specified region.
System API: This is a system API.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
language | string | Yes | Valid language ID, for example, zh. |
region | string | No | Valid region ID, for example, CN. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the system language matches the specified region; returns false otherwise. |
Example
i18n.isSuggested('zh', 'CN');
i18n.getCalendar8+
getCalendar(locale: string, type? : string): Calendar
Obtains a Calendar object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | Yes | Valid locale value, for example, zh-Hans-CN. |
type | string | No | Valid calendar type. Currently, the valid types are as follows: buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, and persian. If this parameter is left unspecified, the default calendar type of the specified locale is used. |
Return Value
Type | Description |
---|---|
Calendar | Calendar object. |
Example
i18n.getCalendar("zh-Hans", "gregory");
Calendar8+
setTime8+
setTime(date: Date): void
Sets the date for this Calendar object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | Date | Yes | Date to be set for the Calendar object. |
Example
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
Sets the date and time for this Calendar object. The value is represented by the number of milliseconds that have elapsed since the Unix epoch (00:00:00 UTC on January 1, 1970).
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
time | number | Yes | Number of milliseconds that have elapsed since the Unix epoch. |
Example
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
Sets the year, month, day, hour, minute, and second for this Calendar object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
year | number | Yes | Year to set. |
month | number | Yes | Month to set. |
date | number | Yes | Day to set. |
hour | number | No | Hour to set. |
minute | number | No | Minute to set. |
second | number | No | Second to set. |
Example
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
Sets the time zone of this Calendar object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
timezone | string | Yes | Time zone, for example, Asia/Shanghai. |
Example
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
getTimeZone8+
getTimeZone(): string
Obtains the time zone of this Calendar object.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | Time zone of the Calendar object. |
Example
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
calendar.getTimeZone(); // Asia/Shanghai"
getFirstDayOfWeek8+
getFirstDayOfWeek(): number
Obtains the start day of a week for this Calendar object.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Start day of a week. The value 1 indicates Sunday, and the value 7 indicates Saturday. |
Example
var calendar = i18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek();
setFirstDayOfWeek8+
setFirstDayOfWeek(value: number): void
Sets the start day of a week for this Calendar object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
value | number | No | Start day of a week. The value 1 indicates Sunday, and the value 7 indicates Saturday. |
Example
var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0);
getMinimalDaysInFirstWeek8+
getMinimalDaysInFirstWeek(): number
Obtains the minimum number of days in the first week of a year.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Minimum number of days in the first week of a year. |
Example
var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek();
setMinimalDaysInFirstWeek8+
setMinimalDaysInFirstWeek(value: number): void
Sets the minimum number of days in the first week of a year.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
value | number | No | Minimum number of days in the first week of a year. |
Example
var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3);
get8+
get(field: string): number
Obtains the value of the specified field in the Calendar object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
field | string | Yes | Value of the specified field in the Calendar object. Currently, a valid field can be any of the following: era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week, day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month. |
Return Value
Type | Description |
---|---|
number | Value of the specified field. For example, if the year in the internal date of this Calendar object is 1990, the get("year") function will return 1990. |
Example
var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // Set time to 2021.10.1 08:00:00
calendar.get("hour_of_day"); // 8
getDisplayName8+
getDisplayName(locale: string): string
Obtains the name of the Calendar object displayed for the specified locale.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | Yes | Locale for which the name of the Calendar object is displayed. For example, if locale is en-US, the name of the Buddhist calendar will be Buddhist Calendar. |
Return Value
Type | Description |
---|---|
string | Name of the Calendar object displayed for the specified locale. |
Example
var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // Obtain the name of the Buddhist calendar in zh.
isWeekend8+
isWeekend(date?: Date): boolean
Checks whether the specified date in this Calendar object is a weekend.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | Date | No | Specified date in this Calendar object. If this parameter is left unspecified, the system checks whether the current date in the Calendar object is a weekend. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the date is a weekend; returns false if the date is a weekday. |
Example
var 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
var date = new Date(2011, 11, 6, 9, 0, 0);
calendar.isWeekend(date); // true
PhoneNumberFormat8+
constructor8+
constructor(country: string, options?: PhoneNumberFormatOptions)
Creates a PhoneNumberFormat object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
country | string | Yes | Country or region to which the phone number to be formatted belongs. |
options | PhoneNumberFormatOptions | No | Options of the PhoneNumberFormat object. |
Example
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
isValidNumber8+
isValidNumber(number: string): boolean
Checks whether the format of the specified phone number is valid.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
number | string | Yes | Phone number to be checked. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the phone number format is valid; returns false otherwise. |
Example
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312");
format8+
format(number: string): string
Formats a phone number.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
number | string | Yes | Phone number to be formatted. |
Return Value
Type | Description |
---|---|
string | Formatted phone number. |
Example
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312");
getLocationName9+
getLocationName(number: string, locale: string): string
Obtains the home location of a phone number.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
number | string | Yes | Phone number. |
locale | string | Yes | Locale ID. |
Return value
Type | Description |
---|---|
string | Home location of the phone number. |
Example
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312");
PhoneNumberFormatOptions8+
Defines the options for this PhoneNumberFormat object.
System capability: SystemCapability.Global.I18n
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
type | string | Yes | Yes | Format type of a phone number. The value can be E164, INTERNATIONAL, NATIONAL, or RFC3966. |
UnitInfo8+
Defines the measurement unit information.
System capability: SystemCapability.Global.I18n
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
unit | string | Yes | Yes | Name of the measurement unit, for example, meter, inch, or cup. |
measureSystem | string | Yes | Yes | Measurement system. The value can be SI, US, or UK. |
Util8+
unitConvert8+
static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string
Converts one measurement unit into another and formats the unit based on the specified locale and style.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
fromUnit | UnitInfo | Yes | Measurement unit to be converted. |
toUnit | UnitInfo | Yes | Measurement unit to be converted to. |
value | number | Yes | Value of the measurement unit to be converted. |
locale | string | Yes | Locale used for formatting, for example, zh-Hans-CN. |
style | string | No | Style used for formatting. The value can be long, short, or medium. |
Return Value
Type | Description |
---|---|
string | Character string obtained after formatting based on the measurement unit specified by toUnit. |
Example
i18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
getDateOrder9+
static getDateOrder(locale: string): string
Obtains the sequence of the year, month, and day in the specified locale.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | Yes | Locale used for formatting, for example, zh-Hans-CN. |
Return value
Type | Description |
---|---|
string | Sequence of the year, month, and day. |
Example
i18n.Util.getDateOrder("zh-CN");
getInstance8+
getInstance(locale?:string): IndexUtil
Creates an IndexUtil object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | No | A string containing locale information, including the language, optional script, and region. |
Return Value
Type | Description |
---|---|
IndexUtil | IndexUtil object mapping to the specified locale. |
Example
var indexUtil= i18n.getInstance("zh-CN");
IndexUtil8+
getIndexList8+
getIndexList(): Array<string>
Obtains the index list for this locale object.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
Array<string> | Index list for this locale object. |
Example
var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList();
addLocale8+
addLocale(locale: string): void
Adds the index of the new locale object to the index list.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | Yes | A string containing locale information, including the language, optional script, and region. |
Example
var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US");
getIndex8+
getIndex(text: string): string
Obtains the index of a text object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
text | string | Yes | text object whose index is to be obtained. |
Return Value
Type | Description |
---|---|
string | Index of the text object. |
Example
var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // Return hi.
Character8+
isDigit8+
static isDigit(char: string): boolean
Checks whether the input character string is composed of digits.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is a digit; returns false otherwise. |
Example
var isdigit = i18n.Character.isDigit("1"); // Return true.
isSpaceChar8+
static isSpaceChar(char: string): boolean
Checks whether the input character is a space.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is a space; returns false otherwise. |
Example
var isspacechar = i18n.Character.isSpaceChar("a"); // Return false.
isWhitespace8+
static isWhitespace(char: string): boolean
Checks whether the input character is a white space.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is a white space; returns false otherwise. |
Example
var iswhitespace = i18n.Character.isWhitespace("a"); // Return false.
isRTL8+
static isRTL(char: string): boolean
Checks whether the input character is of the right to left (RTL) language.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is of the RTL language; returns false otherwise. |
Example
var isrtl = i18n.Character.isRTL("a"); // Return false.
isIdeograph8+
static isIdeograph(char: string): boolean
Checks whether the input character is an ideographic character.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is an ideographic character; returns false otherwise. |
Example
var isideograph = i18n.Character.isIdeograph("a"); // Return false.
isLetter8+
static isLetter(char: string): boolean
Checks whether the input character is a letter.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is a letter; returns false otherwise. |
Example
var isletter = i18n.Character.isLetter("a"); // Return true.
isLowerCase8+
static isLowerCase(char: string): boolean
Checks whether the input character is a lowercase letter.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is a lowercase letter; returns false otherwise. |
Example
var islowercase = i18n.Character.isLowerCase("a"); // Return true.
isUpperCase8+
static isUpperCase(char: string): boolean
Checks whether the input character is an uppercase letter.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the input character is an uppercase letter; returns false otherwise. |
Example
var isuppercase = i18n.Character.isUpperCase("a"); // Return false.
getType8+
static getType(char: string): string
Obtains the type of the input character string.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
char | string | Yes | Input character. |
Return Value
Type | Description |
---|---|
string | Type of the input character. |
Example
var type = i18n.Character.getType("a");
i18n.getLineInstance8+
getLineInstance(locale: string): BreakIterator
Obtains a BreakIterator object for text segmentation.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | Yes | Valid locale value, for example, zh-Hans-CN. The BreakIterator object segments text according to the rules of the specified locale. |
Return Value
Type | Description |
---|---|
BreakIterator | BreakIterator object used for text segmentation. |
Example
var iterator = i18n.getLineInstance("en");
BreakIterator8+
setLineBreakText8+
setLineBreakText(text: string): void
Sets the text to be processed by the BreakIterator object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
text | string | Yes | Text to be processed by the BreakIterator object. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
getLineBreakText8+
getLineBreakText(): string
Obtains the text being processed by the BreakIterator object.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | Text being processed by the BreakIterator object. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.getLineBreakText(); // Apple is my favorite fruit.
current8+
current(): number
Obtains the position of the BreakIterator object in the text being processed.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Position of the BreakIterator object in the text being processed. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.current(); // 0
first8+
first(): number
Puts the BreakIterator object to the first text boundary, which is always at the beginning of the processed text.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Offset to the first text boundary of the processed text. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
last8+
last(): number
Puts the BreakIterator object to the last text boundary, which is always the next position after the end of the processed text.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Offset of the last text boundary of the processed text. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.last(); // 27
next8+
next(index?: number): number
Moves the BreakIterator object backward by the specified number of text boundaries if the specified index is a positive number. If the index is a negative number, the BreakIterator object will be moved forward by the corresponding number of text boundaries. If no index is specified, the index will be treated as 1.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
index | number | No | Number of text boundaries by which the BreakIterator object is moved. A positive value indicates that the text boundary is moved backward, and a negative value indicates the opposite. If no index is specified, the index will be treated as 1. |
Return Value
Type | Description |
---|---|
number | Position of the BreakIterator object in the text after it is moved by the specified number of text boundaries. The value -1 is returned if the position of the BreakIterator object is outside of the processed text after it is moved by the specified number of text boundaries. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
iterator.next(); // 6
iterator.next(10); // -1
previous8+
previous(): number
Moves the BreakIterator object to the previous text boundary.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Position of the BreakIterator object in the text after it is moved to the previous text boundary. The value -1 is returned if the position of the BreakIterator object is outside of the processed text after it is moved by the specified number of text boundaries. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
iterator.next(3); // 12
iterator.previous(); // 9
following8+
following(offset: number): number
Moves the BreakIterator object to the text boundary after the position specified by the offset. Position of the BreakIterator object after it is moved to the text boundary after the position specified by the offset.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
offset | number | Yes | Offset to the position before the text boundary to which the BreakIterator object is moved. |
Return Value
Type | Description |
---|---|
number | The value -1 is returned if the text boundary to which the BreakIterator object is moved is outside of the processed text. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.following(0); // 6
iterator.following(100); // -1
iterator.current(); // 27
isBoundary8+
isBoundary(offset: number): boolean
Checks whether the position specified by the offset is a text boundary. If true is returned, the BreakIterator object is moved to the position specified by the offset. If false is returned, the BreakIterator object is moved to the text boundary after the position specified by the offset, which is equivalent to calling following(offset).
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
offset | number | Yes | Position to check. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the position specified by the offset is a text boundary; returns false otherwise. |
Example
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.isBoundary(0); // true;
iterator.isBoundary(5); // false;
i18n.is24HourClock7+
is24HourClock(): boolean
Checks whether the 24-hour clock is used.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
boolean | Returns true if the 24-hour clock is used; returns false otherwise. |
Example
var is24HourClock = i18n.is24HourClock();
i18n.set24HourClock7+
set24HourClock(option: boolean): boolean
Sets the 24-hour clock.
Required permission: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
option | boolean | Yes | Whether to enable the 24-hour clock. The value true means to enable the 24-hour clock, and the value false means the opposite. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the 24-hour clock is enabled; returns false otherwise. |
Example
// Set the system time to the 24-hour clock.
var success = i18n.set24HourClock(true);
i18n.addPreferredLanguage8+
addPreferredLanguage(language: string, index?: number): boolean
Adds a preferred language to the specified position on the preferred language list.
Required permission: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
language | string | Yes | Preferred language to add. |
index | number | No | Position to which the preferred language is added. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the preferred language is successfully added; returns false otherwise. |
Example
// Add zh-CN to the preferred language list.
var language = 'zh-CN';
var index = 0;
var success = i18n.addPreferredLanguage(language, index);
i18n.removePreferredLanguage8+
removePreferredLanguage(index: number): boolean
Deletes a preferred language from the specified position on the preferred language list.
Required permission: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
index | number | Yes | Position of the preferred language to delete. |
Return Value
Type | Description |
---|---|
boolean | Returns true if the preferred language is deleted; returns false otherwise. |
Example
// Delete the first preferred language from the preferred language list.
var index = 0;
var success = i18n.removePreferredLanguage(index);
i18n.getPreferredLanguageList8+
getPreferredLanguageList(): Array<string>
Obtains the list of preferred languages.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
Array<string> | List of preferred languages. |
Example
var preferredLanguageList = i18n.getPreferredLanguageList();
i18n.getFirstPreferredLanguage8+
getFirstPreferredLanguage(): string
Obtains the first language in the preferred language list.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | First language in the preferred language list. |
Example
var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
i18n.getTimeZone7+
getTimeZone(zoneID?: string): TimeZone
Obtains the TimeZone object corresponding to the specified time zone ID.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
zondID | string | No | Time zone ID. |
Return Value
Type | Description |
---|---|
TimeZone | TimeZone object corresponding to the time zone ID. |
Example
var timezone = i18n.getTimeZone();
TimeZone
getID
getID(): string
Obtains the ID of the specified TimeZone object.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
string | Time zone ID corresponding to the TimeZone object. |
Example
var timezone = i18n.getTimeZone();
timezone.getID();
getDisplayName
getDisplayName(locale?: string, isDST?: boolean): string
Obtains the representation of a TimeZone object in the specified locale.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
locale | string | No | System locale ID. |
isDST | boolean | No | Whether to consider DST when obtaining the representation of the TimeZone object. |
Return Value
Type | Description |
---|---|
string | Representation of the TimeZone object in the specified locale. |
Example
var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false);
getRawOffset
getRawOffset(): number
Obtains the offset between the time zone represented by a TimeZone object and the UTC time zone.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Offset between the time zone represented by the TimeZone object and the UTC time zone. |
Example
var timezone = i18n.getTimeZone();
timezone.getRawOffset();
getOffset
getOffset(date?: number): number
Obtains the offset between the time zone represented by a TimeZone object and the UTC time zone at a certain time point.
System capability: SystemCapability.Global.I18n
Return Value
Type | Description |
---|---|
number | Offset between the time zone represented by the TimeZone object and the UTC time zone at a certain time point. |
Example
var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890);
getAvailableIDs9+
static getAvailableIDs(): Array<string>
Obtains the list of time zone IDs supported by the system.
System capability: SystemCapability.Global.I18n
Return value
Type | Description |
---|---|
Array<string> | List of time zone IDs supported by the system. |
Example
var ids = i18n.TimeZone.getAvailableIDs();
getAvailableZoneCityIDs9+
static getAvailableZoneCityIDs(): Array<string>
Obtains the list of time zone city IDs supported by the system.
System capability: SystemCapability.Global.I18n
Return value
Type | Description |
---|---|
Array<string> | List of time zone city IDs supported by the system. |
Example
var cityIDs = i18n.TimeZone.getAvailableZoneCityIDs();
getCityDisplayName9+
static getCityDisplayName(cityID: string, locale: string): string
Obtains the localized display of a time zone city in the specified locale.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
cityID | string | Yes | Time zone city ID. |
locale | string | Yes | Locale ID. |
Return value
Type | Description |
---|---|
string | Localized display of the time zone city in the specified locale. |
Example
var displayName = i18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN");
getTimezoneFromCity9+
static getTimezoneFromCity(cityID: string): TimeZone
Obtains the TimeZone object corresponding to the specified time zone city ID.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
cityID | string | Yes | Time zone city ID. |
Return value
Type | Description |
---|---|
TimeZone | TimeZone object corresponding to the specified time zone city ID. |
Example
var timezone = i18n.TimeZone.getTimezoneFromCity("Shanghai");
i18n.setUsingLocalDigit9+
setUsingLocalDigit(flag: boolean): boolean
Sets whether to turn on the local digit switch.
This is a system API.
Permission required: ohos.permission.UPDATE_CONFIGURATION
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
flag | boolean | Yes | Whether to turn on the local digit switch. The value true means to turn on the local digit switch, and the value false indicates the opposite. |
Return value
Type | Description |
---|---|
boolean | Result indicating whether the local digit switch is successfully set. The value true indicates that the local digit switch is successfully set, and the value false indicates the opposite. |
Example
var status = i18n.setUsingLocalDigit(true);
i18n.getUsingLocalDigit9+
getUsingLocalDigit(): boolean
Checks whether the local digit switch is turned on.
System capability: SystemCapability.Global.I18n
Return value
Type | Description |
---|---|
boolean | Result indicating whether the local digit switch is turned on. The value true indicates that the local digit switch is turned on, and the value false indicates the opposite. |
Example
var status = i18n.getUsingLocalDigit();
Transliterator9+
getAvailableIDs9+
static getAvailableIDs(): string[]
Obtains a list of IDs supported by the Transliterator object.
System capability: SystemCapability.Global.I18n
Return value
Type | Description |
---|---|
string[] | List of IDs supported by the Transliterator object. |
Example
i18n.Transliterator.getAvailableIDs();
getInstance9+
static getInstance(id: string): Transliterator
Creates a Transliterator object.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
id | string | Yes | ID supported by the Transliterator object. |
Return value
Type | Description |
---|---|
Transliterator | Transliterator object. |
Example
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
transform9+
transform(text: string): string
Converts the input string from the source format to the target format.
System capability: SystemCapability.Global.I18n
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
text | string | Yes | Input string. |
Return value
Type | Description |
---|---|
string | Target string. |
Example
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
transliterator.transform ("China");