Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 9592e792 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 725eb5ff
隐藏空白更改
内联 并排
Showing with 69 addition and 73 deletion
zh-cn/application-dev/quick-start/start-with-js-low-code.md
浏览文件 @ 9592e792
......@@ -100,7 +100,7 @@ OpenHarmony低代码开发方式，具有丰富的UI界面编辑功能，遵循[
## 实现页面间的跳转
页面间的导航可以通过[页面路由router](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ui-js-building-ui-routes.md)来实现。页面路由router根据页面uri找到目标页面，从而实现跳转。使用页面路由请导入router模块。
页面间的导航可以通过[页面路由router](../ui/ui-js-building-ui-routes.md)来实现。页面路由router根据页面uri找到目标页面，从而实现跳转。使用页面路由请导入router模块。
1. **第一个页面跳转到第二个页面。**
在第一个页面中，跳转按钮绑定onclick方法，点击按钮时跳转到第二页。需同时处理js文件及visual文件。
......
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @ 9592e792
......@@ -2649,7 +2649,7 @@ on(type: 'stateChange', callback: Callback<AudioState\>): void
| 参数名 | 类型 | 必填 | 说明 |
| :------- | :------------------------- | :--- | :------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件为：'stateChange'。 |
| callback | [AudioState](#AudioState8) | 是 | 返回监听的状态。 |
| callback | [AudioState](#audiostate8) | 是 | 返回监听的状态。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ 9592e792
......@@ -2,8 +2,8 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 蓝牙模块提供了基础的传统蓝牙能力以及BLE的扫描、广播等功能。
蓝牙模块提供了基础的传统蓝牙能力以及BLE的扫描、广播等功能。
## 导入模块
......@@ -216,9 +216,9 @@ getProfileConnState(profileId: ProfileId): ProfileConnectionState
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------- |
| [ProfileConnectionState](#ProfileConnectionState) | profile的连接状态。 |
| 类型 | 说明 |
| ------------------------------------------------- | ------------------- |
| [ProfileConnectionState](#profileconnectionstate) | profile的连接状态。 |
**示例：**
......@@ -1240,10 +1240,10 @@ getDeviceState(device: string): ProfileConnectionState
**返回值：**
| | |
| ---------------------------------------- | --------------- |
| 类型 | 说明 |
| [ProfileConnectionState](#profileconnectionState) | 返回profile的连接状态。 |
| | |
| ------------------------------------------------- | ----------------------- |
| 类型 | 说明 |
| [ProfileConnectionState](#profileconnectionstate) | 返回profile的连接状态。 |
## A2dpSourceProfile
......@@ -3116,10 +3116,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ---------------------------------------- | ---- | ---- | -------------------------------- |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| state | [ProfileConnectionState](#profileconnectionState) | 是 | 是 | 表示BLE连接状态的枚举。 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---- | --------------------------------------------- |
| deviceId | string | 是 | 否 | 表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 |
| state | [ProfileConnectionState](#profileconnectionstate) | 是 | 是 | 表示BLE连接状态的枚举。 |
## ProfileConnectionState
......@@ -3285,10 +3285,10 @@ let rssi = gattClient.getRssiValue().then((data) => {
**系统能力**：SystemCapability.Communication.Bluetooth.Core。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ---------------------------------------- | ---- | ---- | ------------------- |
| deviceId | string | 是 | 否 | 表示蓝牙设备地址。 |
| state | [ProfileConnectionState](#ProfileConnectionState) | 是 | 否 | 表示蓝牙设备的profile连接状态。 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---- | ------------------------------- |
| deviceId | string | 是 | 否 | 表示蓝牙设备地址。 |
| state | [ProfileConnectionState](#profileconnectionstate) | 是 | 否 | 表示蓝牙设备的profile连接状态。 |
## DeviceClass<sup>8+</sup><a name="DeviceClass"></a>
......
zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md
浏览文件 @ 9592e792
......@@ -26,15 +26,15 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| extension | ElementName | 是 | 否 | Extension匹配信息。 |
| pid | number | 是 | 否 | 进程ID。 |
| uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Extension启动时间。 |
| clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 |
| type | [bundle.ExtensionAbilityType](#bundle-extensionabilitytype) | 是 | 否 | Extension类型。 |
| extension | ElementName | 是 | 否 | Extension匹配信息。 |
| pid | number | 是 | 否 | 进程ID。 |
| uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Extension启动时间。 |
| clientPackage | Array&lt;String&gt; | 是 | 否 | 表示当期进程下的所有包名。 |
| type | [bundle.ExtensionAbilityType](#bundleextensionabilitytype) | 是 | 否 | Extension类型。 |
## bundle.ExtensionAbilityType
......
zh-cn/application-dev/reference/apis/js-apis-formInfo.md
浏览文件 @ 9592e792
......@@ -30,9 +30,9 @@ SystemCapability.Ability.Form
| abilityName | 只读 | string | 表示卡片所属的Ability名称 |
| name | 只读 | string | 表示卡片名称 |
| description | 只读 | string | 表示卡片描述 |
| type | 只读 | [FormType](#enum-formtype) | 表示卡片类型，当前支持JS卡片 |
| type | 只读 | [FormType](#formtype) | 表示卡片类型，当前支持JS卡片 |
| jsComponentName | 只读 | string | 表示js卡片的组件名 |
| colorMode | 只读 | [ColorMode](#enum-colormode) | 表示卡片颜色模式 |
| colorMode | 只读 | [ColorMode](#colormode) | 表示卡片颜色模式 |
| isDefault | 只读 | boolean | 表示是否是默认卡片 |
| updateEnabled | 只读 | boolean | 表示卡片是否使能更新 |
| formVisibleNotify | 只读 | string | 表示卡片是否使能可见通知 |
......@@ -44,9 +44,9 @@ SystemCapability.Ability.Form
| supportDimensions | 只读 | Array&lt;number&gt; | 表示卡片支持的规格 |
| customizeData | 只读 | {[key: string]: [value: string]} | 表示卡片用户数据 |
## enum FormType
## FormType
支持的卡片类型
枚举，支持的卡片类型。
**系统能力：**
......@@ -56,9 +56,9 @@ SystemCapability.Ability.Form
| ----------- | ---- | ------------ |
| JS | 1 | 卡片类型为JS |
## enum ColorMode
## ColorMode
卡片支持的颜色模式
枚举，卡片支持的颜色模式。
**系统能力：**
......@@ -72,7 +72,7 @@ SystemCapability.Ability.Form
## FormStateInfo
卡片状态信息
卡片状态信息。
**系统能力：**
......@@ -80,12 +80,12 @@ SystemCapability.Ability.Form
| 名称 | 读写属性 | 类型 | 描述 |
| ----------- | -------- | -------------------- | ------------------------------------------------------------ |
| formState | 只读 | [FormState](#enum-formstate) | 表示卡片状态 |
| formState | 只读 | [FormState](#formstate) | 表示卡片状态 |
| want | 只读 | Want | Want文本内容 |
## enum FormState
## FormState
卡片状态
枚举，卡片状态。
**系统能力：**
......@@ -97,9 +97,9 @@ SystemCapability.Ability.Form
| DEFAULT | 0 | 默认状态 |
| READY | 1 | 就绪状态 |
## enum FormParam
## FormParam
卡片参数
枚举，卡片参数。
**系统能力：**
......
zh-cn/application-dev/reference/apis/js-apis-formhost.md
浏览文件 @ 9592e792
......@@ -725,10 +725,10 @@ SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| want | [Want](js-apis-featureAbility.md#want) | 是 | 查询卡片状态时携带的want信息 |
| callback | AsyncCallback&lt;[FormStateInfo](./js-apis-formInfo.md#formstateinfo)&gt; | 是 | callback形式返回卡片状态 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| want | [Want](js-apis-featureAbility.md#want) | 是 | 查询卡片状态时携带的want信息 |
| callback | AsyncCallback&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | 是 | callback形式返回卡片状态 |
**示例：**
......@@ -761,7 +761,7 @@ function acquireFormState(formIds: Array&ltstring&gt): Promise&lt;formInfo.FormS
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise&lt;[FormStateInfo](./js-apis-formInfo.md#formstateinfo)&gt; | Promise实例，用于返回卡片状态 |
| Promise&lt;[FormStateInfo](js-apis-formInfo.md#formstateinfo)&gt; | Promise实例，用于返回卡片状态 |
**系统能力：**
......
zh-cn/application-dev/reference/apis/js-apis-huks.md
浏览文件 @ 9592e792
......@@ -1140,7 +1140,7 @@ var options = {
var result = huks.abort(handle, options);
```
## HuksParam
## HuksParam
调用接口使用的options中的properties数组中的param。
......@@ -1151,7 +1151,7 @@ var result = huks.abort(handle, options);
| tag | HuksTag | 是 | 标签 |
| value | boolean\|number\|bigint\|Uint8Array | 是 | 标签对应值 |
## HuksOptions
## HuksOptions
调用接口使用的options。
......@@ -1162,7 +1162,7 @@ var result = huks.abort(handle, options);
| properties | Array\<HuksParam> | 否 | 属性,存HuksParam的数组。 |
| inData | Uint8Array | 否 | 输入数据。 |
## HuksHandle
## HuksHandle
huks Handle结构体。
......@@ -1175,7 +1175,7 @@ huks Handle结构体。
| token | Uint8Array | 否 | 预留字段 |
## HuksResult
## HuksResult
调用接口返回的result。
......
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 9592e792
......@@ -10,7 +10,7 @@
- 音频播放（[AudioPlayer](#audioplayer)）
- 视频播放（[VideoPlayer](#videoplayer8)）
- 音频录制（[AudioRecorder](#audiorecorder)）
- 视频录制（[VideoRecorder](#videoRecorder9)）
- 视频录制（[VideoRecorder](#videorecorder9)）
后续将提供以下功能：DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
......@@ -2487,7 +2487,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| audioSampleRate | number | 是 | 音频采样率。 |
| fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 |
| videoBitrate | number | 是 | 视频编码比特率。 |
| videoCodec | [CodecMimeType](#CodecMimeType8) | 是 | 视频编码格式。 |
| videoCodec | [CodecMimeType](#codecmimetype8) | 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 |
| videoFrameRate | number | 是 | 录制视频帧率。 |
......
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ 9592e792
......@@ -2096,8 +2096,7 @@ async function example() {
MediaType
---------
## MediaType
枚举，媒体类型。
......@@ -2110,8 +2109,7 @@ MediaType
| VIDEO | 2 | 视频 |
| AUDIO | 3 | 音频 |
FileKey
-------
## FileKey
枚举，文件关键信息。
......@@ -2139,8 +2137,7 @@ FileKey
| ALBUM_ID | bucket_id | 文件所归属的相册编号 |
| ALBUM_NAME | bucket_display_name | 文件所归属相册名称 |
DirectoryType
-------------
## DirectoryType
枚举，目录类型。
......@@ -2155,8 +2152,7 @@ DirectoryType
| DIR_DOCUMENTS | 4 | 表示文档路径 |
| DIR_DOWNLOAD | 5 | 表示下载路径 |
DeviceType
-----------
## DeviceType
枚举，设备类型。
......
zh-cn/application-dev/reference/apis/js-apis-net-connection.md
浏览文件 @ 9592e792
......@@ -893,7 +893,7 @@ connection.getDefaultNet().then(function (netHandle) {
| linkUpBandwidthKbps | number | 上行（设备到网络）带宽。 |
| linkDownBandwidthKbps | number | 下行（网络到设备）带宽。 |
| networkCap | Array<[NetCap](#netcap)> | 网络具体能力。 |
| bearerTypes | Array<[NetBearType](#netbearType)> | 网络类型。 |
| bearerTypes | Array<[NetBearType](#netbeartype)> | 网络类型。 |
## NetCap
......
zh-cn/application-dev/reference/apis/js-apis-observer.md
浏览文件 @ 9592e792
......@@ -278,7 +278,7 @@ on\(type: 'cellularDataConnectionStateChange', callback: Callback\<{ state: Data
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectState), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectstate), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
**示例：**
......@@ -303,7 +303,7 @@ on\(type: 'cellularDataConnectionStateChange', options: { slotId: number }, call
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectState), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectstate), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
**示例：**
......@@ -331,7 +331,7 @@ off\(type: 'cellularDataConnectionStateChange', callback?: Callback\<{ state: D
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectState), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 否 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectstate), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 否 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-radio.md
浏览文件 @ 9592e792
......@@ -173,7 +173,7 @@ getNetworkSelectionMode\(slotId: number, callback: AsyncCallback<NetworkSelectio
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<[NetworkSelectionMode](#networkselectionMode)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[NetworkSelectionMode](#networkselectionmode)\> | 是 | 回调函数。 |
**示例：**
......@@ -622,7 +622,7 @@ promise.then(data => {
| isRoaming | boolean | 是否处于漫游状态。 |
| regState | [RegState](#regstate) | 设备的网络注册状态。 |
| cfgTech<sup>8+</sup> | [RadioTechnology](#radiotechnology) | 设备的无线接入技术。 |
| nsaState | [NsaState](#nsaState) | 设备的NSA网络注册状态。 |
| nsaState | [NsaState](#nsastate) | 设备的NSA网络注册状态。 |
| isCaActive | boolean | CA的状态。 |
| isEmergency | boolean | 此设备是否只允许拨打紧急呼叫。 |
......
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @ 9592e792
......@@ -671,10 +671,10 @@ getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor&
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------------- |
| path | string | 是 | rawfile文件路径 |
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8+</sup)&gt; | 是 | 异步回调，用于返回获取的rawfile文件的descriptor |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| path | string | 是 | rawfile文件路径 |
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是 | 异步回调，用于返回获取的rawfile文件的descriptor |
**示例：**
```
......
zh-cn/application-dev/reference/apis/js-apis-sim.md
浏览文件 @ 9592e792
......@@ -350,7 +350,7 @@ getSimState\(slotId: number, callback: AsyncCallback<SimState\>\): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<[SimState](#simState)\> | 是 | 回调函数。参考[SimState](#simState)。 |
| callback | AsyncCallback\<[SimState](#simstate)\> | 是 | 回调函数。参考[SimState](#simstate)。 |
**示例：**
......@@ -379,7 +379,7 @@ getSimState\(slotId: number\): Promise<SimState\>
| 类型 | 说明 |
| -------------------------------- | ------------------------------------------ |
| Promise\<[SimState](#simState)\> | 以Promise形式返回获取指定卡槽的SIM卡状态。 |
| Promise\<[SimState](#simstate)\> | 以Promise形式返回获取指定卡槽的SIM卡状态。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-system-router.md
浏览文件 @ 9592e792
......@@ -277,7 +277,7 @@ enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options | [EnableAlertBeforeBackPageOptions](#EnableAlertbeforebackpageoptions) | 是 | 详细请参见EnableAlertBeforeBackPageOptions。 |
| options | [EnableAlertBeforeBackPageOptions](#enableAlertbeforebackpageoptions6) | 是 | 详细请参见EnableAlertBeforeBackPageOptions。 |
**示例：**
......@@ -309,7 +309,7 @@ disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options | [DisableAlertBeforeBackPageOptions](#disablealertbeforebackpageoptions)| 否 | 详细请参见DisableAlertBeforeBackPageOptions。 |
| options | [DisableAlertBeforeBackPageOptions](#disablealertbeforebackpageoptions6) | 否 | 详细请参见DisableAlertBeforeBackPageOptions。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @ 9592e792
......@@ -85,7 +85,7 @@ let ws = webSocket.createWebSocket();
## WebSocket
在调用WebSocket的方法前，需要先通过[webSocket.createWebSocket](#webSocketcreatewebsocket)创建一个WebSocket。
在调用WebSocket的方法前，需要先通过[webSocket.createWebSocket](#websocketcreatewebsocket)创建一个WebSocket。
### connect
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或