Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
246f6fa5
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看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
246f6fa5
编写于
1月 20, 2023
作者:
O
openharmony_ci
提交者:
Gitee
1月 20, 2023
浏览文件
操作
浏览文件
下载
差异文件
!13865 一致性扫描问题修改
Merge pull request !13865 from luoying_ace/ly1111
上级
bb8b05bb
02cdf055
变更
7
隐藏空白更改
内联
并排
Showing
7 changed file
with
62 addition
and
109 deletion
+62
-109
zh-cn/application-dev/reference/apis/js-apis-animator.md
zh-cn/application-dev/reference/apis/js-apis-animator.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-promptAction.md
zh-cn/application-dev/reference/apis/js-apis-promptAction.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-router.md
zh-cn/application-dev/reference/apis/js-apis-router.md
+22
-81
zh-cn/application-dev/reference/apis/js-apis-system-app.md
zh-cn/application-dev/reference/apis/js-apis-system-app.md
+20
-8
zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
...plication-dev/reference/apis/js-apis-system-mediaquery.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-system-prompt.md
...n/application-dev/reference/apis/js-apis-system-prompt.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-system-router.md
...n/application-dev/reference/apis/js-apis-system-router.md
+7
-7
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-animator.md
浏览文件 @
246f6fa5
...
...
@@ -72,7 +72,7 @@ reset(options: AnimatorOptions): void
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f no page is found for pageId or fail to get object property list. |
| 100001 |
i
f no page is found for pageId or fail to get object property list. |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-promptAction.md
浏览文件 @
246f6fa5
...
...
@@ -32,7 +32,7 @@ showToast(options: ShowToastOptions): void
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100001 |
i
f UI execution context not found. |
**示例:**
...
...
@@ -88,7 +88,7 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse>
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100001 |
i
f UI execution context not found. |
**示例:**
...
...
@@ -142,7 +142,7 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100001 |
i
f UI execution context not found. |
**示例:**
...
...
@@ -218,7 +218,7 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100001 |
i
f UI execution context not found. |
**示例:**
...
...
@@ -276,7 +276,7 @@ showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100001 |
i
f UI execution context not found. |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-router.md
浏览文件 @
246f6fa5
...
...
@@ -40,9 +40,9 @@ pushUrl(options: RouterOptions): Promise<void>
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100002 |
I
f the uri is not exist. |
| 100003 |
I
f the pages are pushed too much. |
| 100001 |
i
f UI execution context not found. |
| 100002 |
i
f the uri is not exist. |
| 100003 |
i
f the pages are pushed too much. |
**示例:**
...
...
@@ -85,9 +85,9 @@ pushUrl(options: RouterOptions, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100002 |
I
f the uri is not exist. |
| 100003 |
I
f the pages are pushed too much. |
| 100001 |
i
f UI execution context not found. |
| 100002 |
i
f the uri is not exist. |
| 100003 |
i
f the pages are pushed too much. |
**示例:**
...
...
@@ -135,9 +135,9 @@ pushUrl(options: RouterOptions, mode: RouterMode): Promise<void>
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100002 |
I
f the uri is not exist. |
| 100003 |
I
f the pages are pushed too much. |
| 100001 |
i
f UI execution context not found. |
| 100002 |
i
f the uri is not exist. |
| 100003 |
i
f the pages are pushed too much. |
**示例:**
...
...
@@ -181,9 +181,9 @@ pushUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<voi
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100002 |
I
f the uri is not exist. |
| 100003 |
I
f the pages are pushed too much. |
| 100001 |
i
f UI execution context not found. |
| 100002 |
i
f the uri is not exist. |
| 100003 |
i
f the pages are pushed too much. |
**示例:**
...
...
@@ -231,8 +231,8 @@ replaceUrl(options: RouterOptions): Promise<void>
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found, only throw in standard system. |
| 200002 |
I
f the uri is not exist. |
| 100001 |
i
f UI execution context not found, only throw in standard system. |
| 200002 |
i
f the uri is not exist. |
**示例:**
...
...
@@ -272,8 +272,8 @@ replaceUrl(options: RouterOptions, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found, only throw in standard system. |
| 200002 |
I
f the uri is not exist. |
| 100001 |
i
f UI execution context not found, only throw in standard system. |
| 200002 |
i
f the uri is not exist. |
**示例:**
...
...
@@ -320,8 +320,8 @@ replaceUrl(options: RouterOptions, mode: RouterMode): Promise<void>
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found, only throw in standard system. |
| 200002 |
I
f the uri is not exist. |
| 100001 |
i
f UI execution context not found, only throw in standard system. |
| 200002 |
i
f the uri is not exist. |
**示例:**
...
...
@@ -362,8 +362,8 @@ replaceUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found, only throw in standard system. |
| 200002 |
I
f the uri is not exist. |
| 100001 |
i
f UI execution context not found, only throw in standard system. |
| 200002 |
i
f the uri is not exist. |
**示例:**
...
...
@@ -493,7 +493,7 @@ enableBackPageAlert(options: EnableAlertOptions): void
| 错误码ID | 错误信息 |
| --------- | ------- |
| 100001 |
I
f UI execution context not found. |
| 100001 |
i
f UI execution context not found. |
**示例:**
...
...
@@ -714,37 +714,6 @@ router.push({
}
});
```
## router.push<sup>(deprecated)</sup>
push(options: RouterOptions, mode: RouterMode): void
跳转到应用内的指定页面。
从API version9开始不再维护,建议使用
[
pushUrl<sup>9+</sup>
](
#routerpushurl9
)
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------- |
| options |
[
RouterOptions
](
#routeroptions
)
| 是 | 跳转页面描述信息。 |
| mode |
[
RouterMode
](
#routermode9
)
| 是 | 跳转页面使用的模式。 |
**示例:**
```
js
router
.
push
({
url
:
'
pages/routerpage2/routerpage2
'
,
params
:
{
data1
:
'
message
'
,
data2
:
{
data3
:
[
123
,
456
,
789
]
}
}
},
router
.
RouterMode
.
Standard
);
```
## router.replace<sup>(deprecated)</sup>
...
...
@@ -754,7 +723,7 @@ replace(options: RouterOptions): void
从API version9开始不再维护,建议使用
[
replaceUrl<sup>9+</sup>
](
#routerreplaceurl9
)
**系统能力:**
SystemCapability.ArkUI.ArkUI.
Full
**系统能力:**
SystemCapability.ArkUI.ArkUI.
Lite
**参数:**
...
...
@@ -773,34 +742,6 @@ router.replace({
});
```
## router.replace<sup>(deprecated)</sup>
replace(options: RouterOptions, mode: RouterMode): void
用应用内的某个页面替换当前页面,并销毁被替换的页面。
从API version9开始不再维护,建议使用
[
replaceUrl<sup>9+</sup>
](
#routerreplaceurl9
)
**系统能力:**
SystemCapability.ArkUI.ArkUI.Lite
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------- |
| options |
[
RouterOptions
](
#routeroptions
)
| 是 | 替换页面描述信息。 |
| mode |
[
RouterMode
](
#routermode9
)
| 是 | 跳转页面使用的模式。 |
**示例:**
```
js
router
.
replace
({
url
:
'
pages/detail/detail
'
,
params
:
{
data1
:
'
message
'
}
},
router
.
RouterMode
.
Standard
);
```
## router.enableAlertBeforeBackPage<sup>(deprecated)</sup>
enableAlertBeforeBackPage(options: EnableAlertOptions): void
...
...
zh-cn/application-dev/reference/apis/js-apis-system-app.md
浏览文件 @
246f6fa5
...
...
@@ -66,8 +66,6 @@ requestFullWindow(options?: RequestFullWindowOptions): void
请求应用以全窗口运行,FA在某些场景下(如半模态FA)会以非全窗口运行,调用该接口会从非全窗口切换为全窗口运行,如果已经以全窗口运行则该接口调用无效。
此接口为系统接口,三方应用不支持调用。
> **说明:** 从API Version 7开始,推荐使用[`@ohos.window`](js-apis-window.md)。
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
...
...
@@ -100,7 +98,7 @@ setImageCacheCount(value: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number |
否
| 内存中解码后图片的缓存数量。 |
| value | number |
是
| 内存中解码后图片的缓存数量。 |
**示例:**
...
...
@@ -130,7 +128,7 @@ setImageRawDataCacheSize(value: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number |
否
| 内存中解码前图片数据的缓存大小,单位为字节。 |
| value | number |
是
| 内存中解码前图片数据的缓存大小,单位为字节。 |
**示例:**
...
...
@@ -161,7 +159,7 @@ setImageFileCacheSize(value: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | number |
否
| 图片文件的缓存大小,单位为字节。 |
| value | number |
是
| 图片文件的缓存大小,单位为字节。 |
**示例:**
...
...
@@ -187,20 +185,34 @@ export default {
**系统能力:**
以下各项对应的系统能力有所不同,详见下表。
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- |-------- |
| appID
<sup>
6+
</sup>
| string | 是 | 表示应用的包名,用于标识应用的唯一性。
<br>
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full|
| appName | string | 是 | 表示应用的名称。
<br>
**系统能力:**
SystemCapability.ArkUI.ArkUI.Lite|
| versionName | string | 是 | 表示应用的版本名称。
<br>
**系统能力:**
SystemCapability.ArkUI.ArkUI.Lite|
| versionCode | number | 是 | 表示应用的版本号。
<br>
**系统能力:**
SystemCapability.ArkUI.ArkUI.Lite|
## ScreenOnVisible<sup>(deprecated)</sup>
screenOnVisible(options?: ScreenOnVisibleOptions)
定义屏幕唤醒时是否保持应用可见。
**说明:**
该接口从API Version 8 开始废弃。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- |-------- |
| options | ScreenOnVisibleOptions | 否 | 当启动保活时,锁屏时将阻止系统返回桌面显示,以保持屏幕唤醒时应用可见。 |
## ScreenOnVisibleOptions
定义屏幕上可见接口的选项。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| visible | boolean | 否 | 是否启动保活,默认值false。 |
| success | () => void | 否 | 接口调用成功的回调函数。 |
...
...
@@ -213,7 +225,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| duration | number | 是 | 定义动画选项的持续时间,单位为毫秒。 |
zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
浏览文件 @
246f6fa5
...
...
@@ -49,7 +49,7 @@ let mMediaQueryList = mediaquery.matchMedia('(max-width: 466)');
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ----- |
| matches | boolean | 是 | 匹配结果。 |
...
...
@@ -61,7 +61,7 @@ let mMediaQueryList = mediaquery.matchMedia('(max-width: 466)');
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | ----------------- |
| media | string | 否 | 序列化媒体查询条件,该参数为只读。 |
| matches | boolean | 是 | 匹配结果。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-system-prompt.md
浏览文件 @
246f6fa5
...
...
@@ -133,7 +133,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------------------- | -------------- | ---- | ---------------------------------------- |
| message | string | 是 | 显示的文本信息。 |
| duration | number | 否 | 默认值1500ms,建议区间:1500ms-10000ms。若小于1500ms则取默认值,最大取值为10000ms。 |
...
...
@@ -145,7 +145,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------- |
| text | string | 是 | 定义按钮信息。 |
| color | string | 是 | 定义按钮颜色。 |
...
...
@@ -156,7 +156,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ---------- |
| index | number | 是 | 定义数据的索引信息。 |
...
...
@@ -166,7 +166,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| title | string | 否 | 标题文本。 |
| message | string | 否 | 文本内容。 |
...
...
@@ -181,7 +181,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| title | string | 否 | 标题文本。 |
| buttons |
[
[Button
](
#button
)
,
[
Button
](
#button
)
?,
[
Button
](
#button
)
?,
[
Button
](
#button
)
?,
[
Button
](
#button
)
?,
[
Button
](
#button
)
?] | 是 | 对话框中按钮的数组,结构为:{text:'button', color: '
\#
666666'},支持1-6个按钮。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-system-router.md
浏览文件 @
246f6fa5
...
...
@@ -126,7 +126,7 @@ back(options?: BackRouterOptions): void
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ----------------------- |
| options |
[
BackRouterOptions
](
#backrouteroptions
)
|
是
| 详细请参考BackRouterOptions。 |
| options |
[
BackRouterOptions
](
#backrouteroptions
)
|
否
| 详细请参考BackRouterOptions。 |
**示例:**
...
...
@@ -186,7 +186,7 @@ export default {
> **说明:**
> 示例中的uri字段是页面路由,由配置文件中的pages列表指定。
## router.getParams
## router.getParams
<sup>7+</sup>
getParams(): ParamsInterface
...
...
@@ -339,7 +339,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Lite
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 目标页面的uri,可以是以下的两种格式:
<br/>
1. 页面的绝对路径,由config.json文件中的页面列表提供。例如:
<br/>
- pages/index/index
<br/>
-pages/detail/detail
<br/>
2. 特定路径。如果URI为斜杠(/),则显示主页。 |
| params | object | 否 | 表示路由跳转时要同时传递到目标页面的数据。跳转到目标页面后,使用router.getParams()获取传递的参数,此外,在类web范式中,参数也可以在页面中直接使用,如this.keyValue(keyValue为跳转时params参数中的key值),如果目标页面中已有该字段,则其值会被传入的字段值覆盖。 |
...
...
@@ -351,7 +351,7 @@ export default {
**系统能力:**
以下各项对应的系统能力有所不同,详见下表。
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ------------------------------------------------------------ |
| uri | string | 否 | 返回到指定uri的界面,如果页面栈上没有uri页面,则不响应该情况。如果uri未设置,则返回上一页。
<br>
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full |
| params | object | 否 | 跳转时要同时传递到目标页面的数据。
<br>
**系统能力:**
SystemCapability.ArkUI.ArkUI.Lite |
...
...
@@ -362,7 +362,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ---------------------------------- |
| index | number | 是 | 表示当前页面在页面栈中的索引。从栈底到栈顶,index从1开始递增。 |
| name | string | 是 | 表示当前页面的名称,即对应文件名。 |
...
...
@@ -374,7 +374,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | -------------------------------------------------- |
| message | string | 是 | 询问对话框内容。 |
| success | (errMsg: string) => void | 否 | 用户选择对话框确认按钮时触发,errMsg表示返回信息。 |
...
...
@@ -387,7 +387,7 @@ export default {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
| 名称 |
参数
类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | -------------------------------------------------- |
| success | (errMsg: string) => void | 否 | 关闭询问对话框能力成功时触发,errMsg表示返回信息。 |
| cancel | (errMsg: string) => void | 否 | 关闭询问对话框能力失败时触发,errMsg表示返回信息。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录