提交 57306b93 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 540f787a
......@@ -44,9 +44,9 @@ static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -83,9 +83,9 @@ static getDisplayLanguage(language: string, locale: string, sentenceCase?: boole
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -114,9 +114,9 @@ static getSystemLanguages(): Array&lt;string&gt;
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -137,9 +137,9 @@ static getSystemCountries(language: string): Array&lt;string&gt;
**参数:**
| 参数名 | 类型 | 说明 |
| -------- | ------ | ----- |
| language | string | 语言ID。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----- |
| language | string | 是 | 语言ID。 |
**返回值:**
......@@ -151,9 +151,9 @@ static getSystemCountries(language: string): Array&lt;string&gt;
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -189,9 +189,9 @@ static isSuggested(language: string, region?: string): boolean
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -220,9 +220,9 @@ static getSystemLanguage(): string
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -247,17 +247,17 @@ static setSystemLanguage(language: string): void
**参数:**
| 参数名 | 类型 | 说明 |
| -------- | ------ | ----- |
| language | string | 语言ID。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----- |
| language | string | 是 | 语言ID。 |
**错误码:**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -286,9 +286,9 @@ static getSystemRegion(): string
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -313,17 +313,17 @@ static setSystemRegion(region: string): void
**参数:**
| 参数名 | 类型 | 说明 |
| ------ | ------ | ----- |
| region | string | 地区ID。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| region | string | 是 | 地区ID。 |
**错误码:**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -352,9 +352,9 @@ static getSystemLocale(): string
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -379,17 +379,17 @@ static setSystemLocale(locale: string): void
**参数:**
| 参数名 | 类型 | 说明 |
| ------ | ------ | --------------- |
| locale | string | 指定区域ID,例如zh-CN。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------- |
| locale | string | 是 | 指定区域ID,例如zh-CN。 |
**错误码:**
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -418,9 +418,9 @@ static is24HourClock(): boolean
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -453,9 +453,9 @@ static set24HourClock(option: boolean): void
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -490,9 +490,9 @@ static addPreferredLanguage(language: string, index?: number): void
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -528,9 +528,9 @@ static removePreferredLanguage(index: number): void
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -561,9 +561,9 @@ static getPreferredLanguageList(): Array&lt;string&gt;
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -592,9 +592,9 @@ static getFirstPreferredLanguage(): string
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -623,9 +623,9 @@ static getAppPreferredLanguage(): string
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```js
......@@ -658,9 +658,9 @@ static setUsingLocalDigit(flag: boolean): void
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```ts
......@@ -689,9 +689,9 @@ static getUsingLocalDigit(): boolean
以下错误码的详细介绍请参见[ohos.i18n错误码](../errorcodes/errorcode-i18n.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 890001 | Unspported para value. |
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | Unspported para value. |
**示例:**
```ts
......@@ -713,9 +713,9 @@ isRTL(locale: string): boolean
**参数:**
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------- |
| locale | string | 指定区域ID。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| locale | string | 是 | 指定区域ID。 |
**返回值:**
......@@ -905,7 +905,7 @@ setFirstDayOfWeek(value: number): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | --------------------- |
| value | number | | 设置一周的起始日,1代表周日,7代表周六。 |
| value | number | | 设置一周的起始日,1代表周日,7代表周六。 |
**示例:**
```js
......@@ -947,7 +947,7 @@ setMinimalDaysInFirstWeek(value: number): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------ |
| value | number | | 一年中第一周的最小天数。 |
| value | number | | 一年中第一周的最小天数。 |
**示例:**
```js
......@@ -1153,7 +1153,7 @@ getLocationName(number: string, locale: string): string
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ------ | ---- | ---- | ---------------------------------------- |
| type | string | 是 | 是 | 表示对电话号码格式化的类型,取值范围:"E164",&nbsp;"INTERNATIONAL",&nbsp;"NATIONAL",&nbsp;"RFC3966"。 |
......@@ -1164,7 +1164,7 @@ getLocationName(number: string, locale: string): string
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
| unit | string | 是 | 是 | 单位的名称,如:"meter",&nbsp;"inch",&nbsp;"cup"等。 |
| measureSystem | string | 是 | 是 | 单位的度量体系,取值包括:"SI",&nbsp;"US",&nbsp;"UK"。 |
......
......@@ -4,9 +4,9 @@
[I18N模块](js-apis-i18n.md)提供其他非ECMA 402定义的国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> **说明:**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - Intl模块包含国际化能力基础接口(在ECMA 402中定义),包括时间日期格式化、数字格式化、排序等,国际化增强能力请参考[I18N模块](js-apis-i18n.md)。
> - Intl模块包含国际化能力基础接口(在ECMA 402中定义),包括时间日期格式化、数字格式化、排序等,国际化增强能力请参考[I18N模块](js-apis-i18n.md)。
## 导入模块
......@@ -21,9 +21,9 @@ import Intl from '@ohos.intl';
### 属性
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
| language | string | 是 | 否 | 与区域设置关联的语,&nbsp;如:zh。 |
| script | string | 是 | 否 | 语言的书写方式,如:Hans。 |
......@@ -61,9 +61,9 @@ constructor(locale: string, options?: LocaleOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------- | ---- | ---------------------------- |
| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------- | ---- | ---------------------------- |
| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options<sup>9+</sup> | [LocaleOptions](#localeoptions9) | 否 | 用于创建区域对象的选项。 |
**示例:**
......@@ -141,7 +141,7 @@ minimize(): Locale
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
| calendar | string | 是 | 是 | 日历参数,如:"buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
| collation | string | 是 | 是 | 排序参数,取值包括:"big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
......@@ -178,9 +178,9 @@ constructor(locale: string | Array&lt;string&gt;, options?: DateTimeOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------------------------------------ | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options<sup>9+</sup> | [DateTimeOptions](#datetimeoptions9) | 否 | 用于创建时间日期格式化的选项。 |
**示例:**
......@@ -263,8 +263,8 @@ resolvedOptions(): DateTimeOptions
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | ----------------------------- |
| 类型 | 说明 |
| ------------------------------------ | ----------------------------- |
| [DateTimeOptions](#datetimeoptions9) | DateTimeFormat&nbsp;对象的格式化选项。 |
**示例:**
......@@ -280,7 +280,7 @@ resolvedOptions(): DateTimeOptions
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 否 | 区域参数,&nbsp;如:zh-Hans-CN。 |
| dateStyle | string | 是 | 是 | 日期显示格式,取值包括:"long",&nbsp;"short",&nbsp;"medium",&nbsp;"full"。 |
......@@ -330,9 +330,9 @@ constructor(locale: string | Array&lt;string&gt;, options?: NumberOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options<sup>9+</sup> | [NumberOptions](#numberoptions9) | 否 | 用于创建数字格式化的选项。 |
**示例:**
......@@ -379,8 +379,8 @@ resolvedOptions(): NumberOptions
**返回值:**
| 类型 | 说明 |
| ------------------------------- | --------------------------- |
| 类型 | 说明 |
| -------------------------------- | --------------------------- |
| [NumberOptions](#numberoptions9) | NumberFormat&nbsp;对象的格式化选项。 |
......@@ -395,9 +395,9 @@ resolvedOptions(): NumberOptions
表示设备支持的能力。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------- | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 否 | 区域参数,&nbsp;如:"zh-Hans-CN"。 |
| currency | string | 是 | 是 | 货币单位,&nbsp;如:"EUR","CNY","USD"等。 |
......@@ -447,9 +447,9 @@ constructor(locale: string | Array&lt;string&gt;, options?: CollatorOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------------------------------------ | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options<sup>9+</sup> | [CollatorOptions](#collatoroptions9) | 否 | 用于创建排序对象的选项。 |
**示例:**
......@@ -496,8 +496,8 @@ resolvedOptions(): CollatorOptions
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | ----------------- |
| 类型 | 说明 |
| ------------------------------------ | ----------------- |
| [CollatorOptions](#collatoroptions9) | 返回的Collator对象的属性。 |
**示例:**
......@@ -513,7 +513,7 @@ resolvedOptions(): CollatorOptions
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------- | ------- | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值范围:"best&nbsp;fit",&nbsp;"lookup"。 |
| usage | string | 是 | 是 | 比较的用途,取值范围:"sort",&nbsp;"search"。 |
......@@ -551,9 +551,9 @@ constructor(locale: string | Array&lt;string&gt;, options?: PluralRulesOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ---------------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options<sup>9+</sup> | [PluralRulesOptions](#pluralrulesoptions9) | 否 | 用于创建单复数对象的选项。 |
**示例:**
......@@ -595,7 +595,7 @@ select(n: number): string
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best&nbsp;fit",&nbsp;"lookup"。 |
| type | string | 是 | 是 | 排序的类型,取值包括:"cardinal",&nbsp;"ordinal"。 |
......@@ -633,9 +633,9 @@ constructor(locale: string | Array&lt;string&gt;, options?: RelativeTimeFormatIn
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ---------------------------------------- | ---- | ---------------------------- |
| locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options<sup>9+</sup> | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions9) | 否 | 用于创建相对时间格式化对象的选项。 |
**示例:**
......@@ -727,7 +727,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best&nbsp;fit",&nbsp;"lookup"。 |
| numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",&nbsp;"auto"。 |
......@@ -740,7 +740,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------- | ------ | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",&nbsp;"auto"。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册