openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-04-03 04:32:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

modify syscap

Browse Source 
Signed-off-by: huangke11 <huangke11@huawei.com>
This commit is contained in:
huangke11 2022-03-02 11:23:43 +08:00
parent d0be7dc42a
commit 6513da04b1
3 changed files with 113 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/@ohos.configPolicy.d.ts vendored
View File

@ -19,7 +19,7 @@ import {AsyncCallback} from "./basic";
* Provides file path related APIS.
*
* @since 8
* @sysCap SystemCapability.Customization.ConfigPolicy
* @syscap SystemCapability.Customization.ConfigPolicy
*/
declare namespace configPolicy {
/**
@ -27,7 +27,7 @@ declare namespace configPolicy {
*
* @since 8
* @systemapi Hide this for inner system use.
* @sysCap SystemCapability.Customization.ConfigPolicy
* @syscap SystemCapability.Customization.ConfigPolicy
* @param relPath the relative path of the config file.
* @return Returns the path of the highest priority config file.
*/
@ -39,7 +39,7 @@ declare namespace configPolicy {
*
* @since 8
* @systemapi Hide this for inner system use.
* @sysCap SystemCapability.Customization.ConfigPolicy
* @syscap SystemCapability.Customization.ConfigPolicy
* @param relPath the relative path of the config file.
* @return Returns paths of config files.
*/
@ -51,7 +51,7 @@ declare namespace configPolicy {
*
* @since 8
* @systemapi Hide this for inner system use.
* @sysCap SystemCapability.Customization.ConfigPolicy
* @syscap SystemCapability.Customization.ConfigPolicy
* @return Returns paths of config directories.
*/
function getCfgDirList(callback: AsyncCallback<Array<string>>);

132
api/@ohos.i18n.d.ts vendored
View File

@ -16,14 +16,14 @@
/**
* Provides international settings related APIs.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 7
*/
declare namespace i18n {
/**
* Obtains the country or region name localized for display on a given locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param country The locale whose country or region name will be displayed.
* @param locale The locale used to display the country or region.
* @param sentenceCase Specifies whether the country or region name is displayed in sentence case.
@ -35,7 +35,7 @@ export function getDisplayCountry(country: string, locale: string, sentenceCase?
/**
* Obtains the language name localized for display on a given locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param language The locale whose language name will be displayed.
* @param locale The locale used to display the language.
* @param sentenceCase Specifies whether the language name is displayed in sentence case.
@ -47,7 +47,7 @@ export function getDisplayLanguage(language: string, locale: string, sentenceCas
/**
* Obtain all languages supported by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns all languages supported by the system.
* @since 7
* @systemapi Hide this for inner system use.
@ -57,7 +57,7 @@ export function getSystemLanguages(): Array<string>;
/**
* Obtain all regions supported by the system in the language.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param language The language used to get the list of regions.
* @return Returns all regions supported by the system in the language.
* @since 7
@ -68,7 +68,7 @@ export function getSystemCountries(language: string): Array<string>;
/**
* Determine whether the current language or region is recommended.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param language The language code.
* @param region The region code.
* @return Returns whether the current language or region is recommended.
@ -80,7 +80,7 @@ export function isSuggested(language: string, region?: string): boolean;
/**
* Obtain the language currently used by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the language currently used by the system.
* @since 7
*/
@ -89,7 +89,7 @@ export function getSystemLanguage(): string;
/**
* Set the language currently used by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param language The language to be used.
* @since 7
* @systemapi Hide this for inner system use.
@ -99,7 +99,7 @@ export function setSystemLanguage(language: string): boolean;
/**
* Obtain the region currently used by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the region currently used by the system.
* @since 7
*/
@ -108,7 +108,7 @@ export function getSystemRegion(): string;
/**
* Set the region currently used by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param region The region to be used.
* @since 7
* @systemapi Hide this for inner system use.
@ -118,7 +118,7 @@ export function setSystemRegion(region: string): boolean;
/**
* Obtain the locale currently used by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the locale currently used by the system.
* @since 7
*/
@ -127,7 +127,7 @@ export function getSystemLocale(): string;
/**
* Set the locale currently used by the system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale The locale to be used.
* @since 7
* @systemapi Hide this for inner system use.
@ -137,14 +137,14 @@ export function setSystemLocale(locale: string): boolean;
/**
* Provides util functions.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface Util {
/**
* Convert from unit to to unit and format according to the locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param fromUnit Information of the unit to be converted.
* @param toUnit Information about the unit to be converted to.
* @param value Indicates the number to be formatted.
@ -158,7 +158,7 @@ export interface Util {
/**
* Provides the options of unit.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface UnitInfo {
@ -176,7 +176,7 @@ export interface UnitInfo {
/**
* Provides the options of PhoneNumberFormat.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface PhoneNumberFormatOptions {
@ -189,14 +189,14 @@ export interface PhoneNumberFormatOptions {
/**
* Provides the API for formatting phone number strings
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class PhoneNumberFormat {
/**
* A constructor used to create a PhoneNumberFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param country Indicates a character string containing the country information for the PhoneNumberFormat object.
* @param type Indicates the type used to format the phone number, includes: "E164", "RFC3966", "INTERNATIONAL", "NATIONAL".
* @since 8
@ -206,7 +206,7 @@ export class PhoneNumberFormat {
/**
* Judges whether phone number is valid.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param number Indicates the input phone number to be judged.
* @return Returns a boolean indicates whether the input phone number is valid.
* @since 8
@ -216,7 +216,7 @@ export class PhoneNumberFormat {
/**
* Obtains the formatted phone number strings of number.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param number Indicates the input phone number to be formatted.
* @return Returns the formatted phone number.
* @since 8
@ -227,7 +227,7 @@ export class PhoneNumberFormat {
/**
* Get a Calendar instance specified by locale and type.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale The locale used to get calendar.
* @param type If type is not specified, get locale's default Calendar, else get the specified type of Calendar.
* such as buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura,
@ -240,7 +240,7 @@ export class Calendar {
/**
* set the date.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param date Date object used to set the time and date.
* @since 8
*/
@ -249,7 +249,7 @@ export class Calendar {
/**
* set the time.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param time Indicates the elapsed milliseconds from 1970.1.1 00:00:00 GMT.
* @since 8
*/
@ -258,7 +258,7 @@ export class Calendar {
/**
* Set the time
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param year The year field of the calendar, ranges from 0 to 9999.
* @param month The month field of the calendar, ranges from 0 to 11.
* @param date The day field of the calendar, ranges from 1 to 31.
@ -272,7 +272,7 @@ export class Calendar {
/**
* Set the timezone of this calendar.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param timezone The id of a timezone.
* @since 8
*/
@ -281,7 +281,7 @@ export class Calendar {
/**
* Get the timezone id of this calendar instance.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the timezone id of this calendar.
* @since 8
*/
@ -290,7 +290,7 @@ export class Calendar {
/**
* Get the start day of a week. 1 indicates Sunday, 7 indicates Saturday.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns start day of a week.
* @since 8
*/
@ -299,7 +299,7 @@ export class Calendar {
/**
* Set the start day of a week. 1 indicates Sunday, 7 indicates Saturday.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param value Indicates the start day of a week. 1 indicates Sunday, 7 indicates Saturday.
* @since 8
*/
@ -308,7 +308,7 @@ export class Calendar {
/**
* Get the minimal days of a week, which is needed for the first day of a year.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the minimal days of a week.
* @since 8
*/
@ -317,7 +317,7 @@ export class Calendar {
/**
* Set the minimal days of a week, which is needed for the first week of a year.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param value The value to be set.
* @since 8
*/
@ -326,7 +326,7 @@ export class Calendar {
/**
* Get the associated value with the field.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param field Field values such as 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.
@ -338,7 +338,7 @@ export class Calendar {
/**
* Get calendar's name localized for display in the given locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Locale used to get the localized name for this calendar.
* @return Returns the localized name of this calendar.
* @since 8
@ -349,7 +349,7 @@ export class Calendar {
* Returns true if the given date is a weekend day. If the date is not given,
* the date object of this calendar is used.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param date Date object whose attribute is desired.
* @return Returns whether the date is a weekend day.
* @since 8
@ -360,7 +360,7 @@ export class Calendar {
/**
* Judge whether the locale is RTL locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale The locale to be used.
* @return Returns true representing the locale is an RTL locale
*
@ -371,7 +371,7 @@ export function isRTL(locale: string): boolean;
/**
* Obtains a BreakIterator object for finding the location of break point in text.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale the returned BreakIterator will adapt the rule, specified by the locale, to break text.
* @return Returns a newly constructed BreakIterator object.
* @since 8
@ -381,14 +381,14 @@ export function isRTL(locale: string): boolean;
/**
* The BreakIterator class is used for finding the location of break point in text.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class BreakIterator {
/**
* Obtains the current position of the BreakIterator instance.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the current position of the BreakIterator instance.
* @since 8
*/
@ -398,7 +398,7 @@ export class BreakIterator {
* Set the BreakIterator's position to the first break point, the first break point is always the beginning of the
* processed text.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the index of the first break point.
* @since 8
*/
@ -408,7 +408,7 @@ export class BreakIterator {
* Set the BreakIterator's position to the last break point. the last break point is always the index beyond the
* last character of the processed text.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the index of the last break point.
* @since 8
*/
@ -417,7 +417,7 @@ export class BreakIterator {
/**
* Set the BreakItertor's position to the nth break point from the current break point.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param index indicates the number of break points to advance. If index is not given, n is treated as 1.
* @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1.
* @since 8
@ -427,7 +427,7 @@ export class BreakIterator {
/**
* Set the BreakItertor's position to the break point preceding the current break point.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1.
* @since 8
*/
@ -436,7 +436,7 @@ export class BreakIterator {
/**
* Set the text to be processed.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param text Indicates the text to be processed by the BreakIterator.
* @since 8
*/
@ -445,7 +445,7 @@ export class BreakIterator {
/**
* Set the BreakIterator's position to the first break point following the specified offset.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the index of the BreakIterator after moving. If there is not enough break points, returns -1.
* @since 8
*/
@ -454,7 +454,7 @@ export class BreakIterator {
/**
* Obtains the text being processed.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the text that is processed by the BreakIterator.
* @since 8
*/
@ -465,7 +465,7 @@ export class BreakIterator {
* position will be set to the position indicated by the offset if it returns true, otherwise the BreakIterator
* will be moved to the break point following the offset.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param offset The offset to be checked.
* @return Returns true if the offset is a break point.
* @since 8
@ -477,14 +477,14 @@ export class BreakIterator {
* Sequence text can be grouped under the specified area,
* and grouping index with different lengths can be specified.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class IndexUtil {
/**
* Get IndexUtil object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region, for the NumberFormat object.
* @return Returns IndexUtil object.
@ -495,7 +495,7 @@ export class IndexUtil {
/**
* Get a list of labels for use as a UI index
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns a list of labels
* @since 8
*/
@ -504,7 +504,7 @@ export class IndexUtil {
/**
* Add the index characters from a Locale to the index.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale The locale whose index characters are to be added.
* @since 8
*/
@ -513,7 +513,7 @@ export class IndexUtil {
/**
* Get corresponding index of the input text.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param text input text
* @since 8
*/
@ -523,14 +523,14 @@ export class IndexUtil {
/**
* Provides the API for accessing unicode character properties, sunch as whether a character is a digit.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class Character {
/**
* Determines whether the specified code point is a digit character
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a digit character
*/
@ -539,7 +539,7 @@ export class Character {
/**
* Determines if the specified character is a space character or not.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a space character
*/
@ -548,7 +548,7 @@ export class Character {
/**
* Determines if the specified character is a whitespace character
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a whitespace character
*/
@ -557,7 +557,7 @@ export class Character {
/**
* Determines if the specified character is a RTL character or not.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a RTL character
*/
@ -566,7 +566,7 @@ export class Character {
/**
* Determines if the specified character is a Ideographic character or not.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a Ideographic character
*/
@ -575,7 +575,7 @@ export class Character {
/**
* Determines if the specified character is a Letter or not.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a Letter
*/
@ -584,7 +584,7 @@ export class Character {
/**
* Determines if the specified character is a LowerCase character or not.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a LowerCase character
*/
@ -593,7 +593,7 @@ export class Character {
/**
* Determines if the specified character is a UpperCase character or not.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns true if the character is a UpperCase character
*/
@ -602,7 +602,7 @@ export class Character {
/**
* Get the general category value of the specified character.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param char the character to be tested
* @return Returns the general category of the specified character.
*/
@ -612,7 +612,7 @@ export class Character {
/**
* check out whether system is 24-hour system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns a boolean represent whether system is 24-hour system.
* @since 8
*/
@ -621,7 +621,7 @@ export class Character {
/**
* set 24-hour system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param option represent the boolean to be set.
* @return Returns a boolean represent whether setting 24-hour system success.
* @since 8
@ -631,7 +631,7 @@ export class Character {
/**
* Add one language to preferred language List.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param language the language to be added.
* @param index the position of preferred language list to be inserted.
* @return Returns a boolean represent whether language added success.
@ -642,7 +642,7 @@ export function addPreferredLanguage(language: string, index?: number): boolean;
/**
* Remove one language from preferred language list.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param index the position of removed language in preferred language list.
* @return Returns a boolean represent whether removed success.
* @since 8
@ -652,7 +652,7 @@ export function removePreferredLanguage(index: number): boolean;
/**
* Access the system preferred language list.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns a string Array represent the preferred language list.
* @since 8
*/
@ -661,7 +661,7 @@ export function getPreferredLanguageList(): Array<string>;
/**
* Get the first preferred language of system.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns a string represent the first preferred language of system.
* @since 8
*/

86
api/@ohos.intl.d.ts vendored
View File

@ -16,7 +16,7 @@
/**
* Provides internationalization related APIs.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
declare namespace intl {
@ -24,7 +24,7 @@ declare namespace intl {
* Provides the options of Locale.
*
* @since 8
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
*/
export interface LocaleOptions {
/**
@ -73,14 +73,14 @@ export interface LocaleOptions {
/**
* Provides APIs for obtaining locale information.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
export class Locale {
/**
* A constructor used to create a Locale object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region.
* @since 6
@ -90,7 +90,7 @@ export class Locale {
/**
* Indicates the language of the locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
language: string
@ -98,7 +98,7 @@ export class Locale {
/**
* Indicates the script of the locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
script: string
@ -106,7 +106,7 @@ export class Locale {
/**
* Indicates the region of the locale.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
region: string
@ -115,7 +115,7 @@ export class Locale {
* Indicates the basic locale information, which is returned as a substring of
* a complete locale string.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
baseName: string
@ -153,7 +153,7 @@ export class Locale {
/**
* Convert the locale information to string.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns locale information in string form.
*/
toString(): string;
@ -161,7 +161,7 @@ export class Locale {
/**
* Maximize the locale's base information.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns maximized locale.
*/
maximize(): Locale;
@ -169,7 +169,7 @@ export class Locale {
/**
* Minimize the locale's base information.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns minimized locale.
*/
minimize(): Locale;
@ -178,7 +178,7 @@ export class Locale {
/**
* Provides the options of date time format.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
*/
export interface DateTimeOptions {
/**
@ -280,14 +280,14 @@ export interface DateTimeOptions {
/**
* Provides the API for formatting date strings.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 6
*/
export class DateTimeFormat {
/**
* A constructor used to create a DateTimeFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
constructor();
@ -295,7 +295,7 @@ export class DateTimeFormat {
/**
* A constructor used to create a DateTimeFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates character string containing the locale information, including
* the language and optionally the script and region, for the DateTimeFormat object.
* @param options Indicates the options used to format the date.
@ -306,7 +306,7 @@ export class DateTimeFormat {
/**
* Obtains the formatted date strings.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param date Indicates the Date object to be formatted.
* @return Returns a date string formatted based on the specified locale.
* @since 6
@ -316,7 +316,7 @@ export class DateTimeFormat {
/**
* Obtains the formatted date strings of a date range.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param startDate Indicates the start date of the date range.
* @param endDate Indicates the end date of the date range.
* @return Returns a date string formatted based on the specified locale.
@ -327,7 +327,7 @@ export class DateTimeFormat {
/**
* Obtains the options of the DateTimeFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the options of the DateTimeFormat object.
* @since 6
*/
@ -337,7 +337,7 @@ export class DateTimeFormat {
/**
* Provides the options of number format.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
*/
export interface NumberOptions {
/**
@ -439,13 +439,13 @@ export interface NumberOptions {
/**
* Provides the API for formatting number strings.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
*/
export class NumberFormat {
/**
* A constructor used to create a NumberFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
constructor();
@ -453,7 +453,7 @@ export class NumberFormat {
/**
* A constructor used to create a NumberFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region, for the NumberFormat object.
* @param options Indicates the options used to format the number.
@ -464,7 +464,7 @@ export class NumberFormat {
/**
* Obtains the formatted number string.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param number Indicates the number to be formatted.
* @return Returns a number string formatted based on the specified locale.
* @since 6
@ -474,7 +474,7 @@ export class NumberFormat {
/**
* Obtains the options of the NumberFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns the options of the NumberFormat object.
* @since 6
*/
@ -484,7 +484,7 @@ export class NumberFormat {
/**
* Provides the options of Collator
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface CollatorOptions {
@ -533,21 +533,21 @@ export interface CollatorOptions {
/**
* Enable language-sensitive string comparison.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class Collator {
/**
* A constructor used to create Collator object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
constructor();
/**
* A constructor used to create Collator Object;
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region, for the Collator object.
* @param options Indicates the options used to initialize Collator object.
@ -558,7 +558,7 @@ export class Collator {
/**
* compares two strings according to the sort order of this Collator object
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param first The first string to compare.
* @param second The second string to compare.
* @return Returns a number indicating how first compare to second:
@ -573,7 +573,7 @@ export class Collator {
* Returns a new object with properties reflecting the locale and collation options computed
* during initialization of the object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @return Returns a CollatorOptions object reflecting the properties of this object.
* @since 8
*/
@ -583,7 +583,7 @@ export class Collator {
/**
* Provides the options of PluralRules
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface PluralRulesOptions {
@ -633,14 +633,14 @@ export interface PluralRulesOptions {
/**
* Enables plural-sensitive formatting and plural-related language rules.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class PluralRules {
/**
* A constructor used to create PluralRules object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
constructor();
@ -648,7 +648,7 @@ export class PluralRules {
/**
* A constructor used to create PluralRules object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region, for the PluralRules object.
* @param options Indicates the options used to initialize PluralRules object.
@ -659,7 +659,7 @@ export class PluralRules {
/**
* Returns a string indicating which plural rule to use for locale-aware formatting.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param n The number to get a plural rule for.
* @return A string representing the pluralization category of the number,
* can be one of zero, one, two, few, many or other.
@ -671,7 +671,7 @@ export class PluralRules {
/**
* Provides the input options of RelativeTimeFormat.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface RelativeTimeFormatInputOptions {
@ -697,7 +697,7 @@ export class PluralRules {
/**
* Provides the resolved options of RelativeTimeFormat.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export interface RelativeTimeFormatResolvedOptions {
@ -728,14 +728,14 @@ export interface RelativeTimeFormatResolvedOptions {
* Given a Time period length value and a unit, RelativeTimeFormat object enables
* language-sensitive relative time formatting.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
export class RelativeTimeFormat {
/**
* A constructor used to create RelativeTimeFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @since 8
*/
constructor();
@ -743,7 +743,7 @@ export class RelativeTimeFormat {
/**
* A constructor used to create RelativeTimeFormat object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param locale Indicates a character string containing the locale information, including
* the language and optionally the script and region, for the RelativeTimeFormat object.
* @param options Indicates the options used to initialize RelativeTimeFormat object.
@ -754,7 +754,7 @@ export class RelativeTimeFormat {
/**
* formats a value and unit according to the locale and formatting options of this object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param value Numeric value to use in the internationalized relative time message.
* @param unit Unit to use in the relative time internationalized message.
* Possible values are: year, quarter, month, week, day, hour, minute, second.
@ -767,7 +767,7 @@ export class RelativeTimeFormat {
* returns an Array of objects representing the relative time format in parts that can be used for
* custom locale-aware formatting
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @param value Numeric value to use in the internationalized relative time message.
* @param unit to use in the relative time internationalized message.
* Possible values are: year, quarter, month, week, day, hour, minute, second.
@ -780,7 +780,7 @@ export class RelativeTimeFormat {
* Returns a new object with properties reflecting the locale and formatting options computed during
* initialization of the object.
*
* @sysCap SystemCapability.Global.I18n
* @syscap SystemCapability.Global.I18n
* @returns RelativeTimeFormatOptions which reflecting the locale and formatting options of the object.
* @since 8
*/