Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
ffbe413e
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
ffbe413e
编写于
6月 19, 2023
作者:
O
openharmony_ci
提交者:
Gitee
6月 19, 2023
浏览文件
操作
浏览文件
下载
差异文件
!19896 增加SystemLocaleManager接口文档
Merge pull request !19896 from sunyaozu/cherry-pick-1687167988
上级
531c2c69
3cf607e7
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
151 addition
and
0 deletion
+151
-0
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+151
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
ffbe413e
...
...
@@ -2210,6 +2210,157 @@ normalize(text: string): string
| NFKD | 4 | NFKD范式。 |
## SystemLocaleManager<sup>10+</sup>
### constructor<sup>10+</sup>
constructor()
创建SystemLocaleManager对象。
**系统接口**
:此接口为系统接口。
**系统能力**
:SystemCapability.Global.I18n
**示例:**
```
js
let
systemLocaleManager
=
new
I18n
.
SystemLocaleManager
();
```
### getLanguageInfoArray<sup>10+</sup>
getLanguageInfoArray(languages: Array
<
string
>
, options?: SortOptions): Array
<
LocaleItem
>
获取语言排序数组。
**系统接口**
:此接口为系统接口。
**系统能力**
:SystemCapability.Global.I18n
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------- | ---- | ------------- |
| languages | Array
<
string
>
| 是 | 待排序语言列表。|
| options |
[
SortOptions
](
#sortoptions10
)
| 否 | 语言排序选项。 |
**返回值:**
| 类型 | 说明 |
| ----------------- | -------------------- |
| Array
<
[LocaleItem](#localeitem10)
>
| 排序后的语言列表信息。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | param value not valid |
**示例:**
```
js
// 当系统语言为zh-Hans,系统地区为CN,系统Locale为zh-Hans-CN时
let
systemLocaleManager
=
new
I18n
.
SystemLocaleManager
();
var
languages
=
[
"
zh-Hans
"
,
"
en-US
"
,
"
pt
"
,
"
ar
"
];
var
sortOptions
=
{
locale
:
"
zh-Hans-CN
"
,
isUseLocalName
:
true
,
isSuggestedFirst
:
true
};
try
{
// 排序后的语言顺序为: [zh-Hans, en-US, pt, ar]
let
sortedLanguages
=
systemLocaleManager
.
getLanguageInfoArray
(
languages
,
sortOptions
);
}
catch
(
error
)
{
console
.
error
(
`call systemLocaleManager.getLanguageInfoArray failed, error code:
${
error
.
code
}
, message:
${
error
.
message
}
.`
);
}
```
### getRegionInfoArray<sup>10+</sup>
getRegionInfoArray(regions: Array
<
string
>
, options?: SortOptions): Array
<
LocaleItem
>
获取国家或地区排序数组。
**系统接口**
:此接口为系统接口。
**系统能力**
:SystemCapability.Global.I18n
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------- | ---- | ------------- |
| regions | Array
<
string
>
| 是 | 待排序的国家或地区列表。|
| options |
[
SortOptions
](
#sortoptions10
)
| 否 | 国家或地区排序选项。 |
**返回值:**
| 类型 | 说明 |
| ----------------- | -------------------- |
| Array
<
[LocaleItem](#localeitem10)
>
| 排序后的国家或地区列表信息。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.i18n错误码
](
../errorcodes/errorcode-i18n.md
)
。
| 错误码ID | 错误信息 |
| ------ | ---------------------- |
| 890001 | param value not valid |
**示例:**
```
js
// 当系统语言为zh-Hans,系统地区为CN,系统Locale为zh-Hans-CN时
let
systemLocaleManager
=
new
I18n
.
SystemLocaleManager
();
var
regions
=
[
"
CN
"
,
"
US
"
,
"
PT
"
,
"
EG
"
];
var
sortOptions
=
{
locale
:
"
zh-Hans-CN
"
,
isUseLocalName
:
false
,
isSuggestedFirst
:
true
};
try
{
// 排序后的地区顺序为: [CN, EG, US, PT]
let
sortedRegions
=
systemLocaleManager
.
getRegionInfoArray
(
regions
,
sortOptions
);
}
catch
(
error
)
{
console
.
error
(
`call systemLocaleManager.getRegionInfoArray failed, error code:
${
error
.
code
}
, message:
${
error
.
message
}
.`
);
}
```
## LocaleItem<sup>10+</sup>
SystemLocaleManager对语言或国家地区列表的排序结果信息项。
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 类型 | 必填 | 说明 |
| --------------- | --------------- | ------ | --------------------------------------- |
| id | string | 是 | 语言代码或国家地区代码,如"zh"、"CN"。 |
| suggestionType |
[
SuggestionType
](
#suggestiontype10
)
| 是 | 语言或国家地区推荐类型。 |
| displayName | string | 是 | id在SystemLocaleManager的Locale下的表示。|
| localName | string | 否 | id的本地名称。 |
## SuggestionType<sup>10+</sup>
语言或国家地区的推荐类型。
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 值 | 说明 |
| ---------------------- | ---- | ---- |
| SUGGESTION_TYPE_NONE | 0x00 | 非推荐语言或国家地区。 |
| SUGGESTION_TYPE_RELATED| 0x01 | 系统语言推荐的国家地区或系统国家地区推荐的语言。 |
| SUGGESTION_TYPE_SIM | 0x02 | Sim卡国家地区推荐的语言。 |
## SortOptions<sup>10+<sup>
语言或国家地区排序选项。
**系统能力**
:SystemCapability.Global.I18n
| 名称 | 类型 | 必填 | 说明 |
| --------------- | --------------- | ---- | --------------------------------------- |
| locale | string | 否 | 区域代码,如"zh-Hans-CN"。 |
| isUseLocalName | boolean | 否 | 表示是否使用本地名称进行排序。 |
| isSuggestedFirst | boolean | 否 | 表示是否将推荐语言或国家地区在排序结果中置顶。 |
## I18n.getDisplayCountry<sup>(deprecated)</sup>
getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录