Skip to content

D
Docs

(_灬幸福相伴 / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 1
Fork 0
D
Docs

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 c4143e34 编写于 作者: Y YOUR_NAME
浏览文件
操作

fix: fix docs 

Signed-off-by: Nliujiandong <liujiandong1@huawei.com>
上级 69f3fa54
隐藏空白更改
内联 并排
Showing with 115 addition and 53 deletion
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ c4143e34
......@@ -595,6 +595,8 @@ httpResponseCache.delete().then() => {
http的数据类型。
**系统能力**：SystemCapability.Communication.NetStack
| 名称 | 值 | 说明 |
| ------------------ | -- | ----------- |
| STRING | 0 | 字符串类型。 |
......@@ -605,6 +607,8 @@ http的数据类型。
http协议版本。
**系统能力**：SystemCapability.Communication.NetStack
| 名称 | 说明 |
| :-------- | :----------- |
| HTTP1_1 | 协议http1.1 |
......
zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md
浏览文件 @ c4143e34
......@@ -14,7 +14,7 @@ import ethernet from '@ohos.net.ethernet'
## ethernet.setIfaceConfig
setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback\<void>): void;
setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallback\<void>): void
设置网络接口配置信息，使用callback方式作为异步方法。
......@@ -48,7 +48,7 @@ ethernet.setIfaceConfig("eth0", {mode:ethernet.STATIC,ipAddr:"192.168.1.123", ro
## ethernet.setIfaceConfig
setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise\<void>;
setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise\<void>
设置网络接口配置信息，使用Promise方式作为异步方法。
......@@ -84,7 +84,7 @@ ethernet.setIfaceConfig("eth0", {mode:ethernet.STATIC,ipAddr:"192.168.1.123", ro
## ethernet.getIfaceConfig
getIfaceConfig(iface: string, callback: AsyncCallback\<InterfaceConfiguration>): void;
getIfaceConfig(iface: string, callback: AsyncCallback\<InterfaceConfiguration>): void
获取指定网络接口信息，使用callback方式作为异步方法。
......@@ -121,7 +121,7 @@ ethernet.getIfaceConfig("eth0", (error, value) => {
## ethernet.getIfaceConfig
getIfaceConfig(iface: string): Promise\<InterfaceConfiguration>;
getIfaceConfig(iface: string): Promise\<InterfaceConfiguration>
获取指定网络接口信息，使用Promise方式作为异步方法。
......@@ -161,7 +161,7 @@ ethernet.getIfaceConfig("eth0").then((data) => {
## ethernet.isIfaceActive
isIfaceActive(iface?: string, callback: AsyncCallback\<number>): void;
isIfaceActive(iface: string, callback: AsyncCallback\<number>): void
判断接口是否已激活，使用callback方式作为异步方法。
......@@ -175,7 +175,7 @@ isIfaceActive(iface?: string, callback: AsyncCallback\<number>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------------------------------- |
| iface | string | 否 | 接口名。为空时代表查询是否存在激活接口 |
| iface | string | 是 | 接口名。为空时代表查询是否存在激活接口 |
| callback | AsyncCallback\<number> | 是 | 回调函数，已激活:1,未激活:0,其他为获取失败错误码。 |
**示例：**
......@@ -192,7 +192,7 @@ ethernet.isIfaceActive("eth0", (error, value) => {
## ethernet.isIfaceActive
isIfaceActive(iface?: string): Promise\<number>;
isIfaceActive(iface: string): Promise\<number>
判断接口是否已激活，使用Promise方式作为异步方法。
......@@ -206,7 +206,7 @@ isIfaceActive(iface?: string): Promise\<number>;
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------------------- |
| iface | string | 否 | 接口名。为空时代表查询是否存在激活接口 |
| iface | string | 是 | 接口名。为空时代表查询是否存在激活接口 |
**返回值：**
......@@ -226,7 +226,7 @@ ethernet.isIfaceActive("eth0").then((data) => {
## ethernet.getAllActiveIfaces
getAllActiveIfaces(callback: AsyncCallback\<Array\<string>>): void;
getAllActiveIfaces(callback: AsyncCallback\<Array\<string>>): void
获取活动的网络接口，使用callback方式作为异步方法。
......@@ -259,7 +259,7 @@ ethernet.getAllActiveIfaces((error, value) => {
## ethernet.getAllActiveIfaces
getAllActiveIfaces(): Promise\<Array\<string>>;
getAllActiveIfaces(): Promise\<Array\<string>>
获取活动的网络接口，使用Promise方式作为异步方法。
......@@ -269,8 +269,6 @@ getAllActiveIfaces(): Promise\<Array\<string>>;
**系统能力**：SystemCapability.Communication.NetManager.Ethernet
**参数：**
**返回值：**
| 类型 | 说明 |
......@@ -298,14 +296,14 @@ ethernet.getAllActiveIfaces().then((data) => {
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Ethernet。
| 参数名 | 类型 | 说明 |
| ----------------------- | ----------------------------------- | ------------------------------------------------------------ |
| mode | [IPSetMode](#ipsetmode) | 以太网连接配置模式。 |
| ipAddr | string | 以太网连接静态配置ip信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| route | string | 以太网连接静态配置路由信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| gateway | string | 以太网连接配置网关信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| netMask | string | 以太网连接配置子网掩码，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| dnsServers | string | 以太网连接配置dns服务地址，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）多地址间用“,”隔开。 |
| 名称 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---|------------------------------------------------------------ |
| mode | [IPSetMode](#ipsetmode) | 是 | 以太网连接配置模式。 |
| ipAddr | string | 是 | 以太网连接静态配置ip信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| route | string | 是 | 以太网连接静态配置路由信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| gateway | string | 是 | 以太网连接配置网关信息，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| netMask | string | 是 | 以太网连接配置子网掩码，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）。 |
| dnsServers | string | 是 | 以太网连接配置dns服务地址，地址值范围0-255.0-255.0-255.0-255（DHCP模式无需配置）多地址间用“,”隔开。 |
## IPSetMode
......
zh-cn/application-dev/reference/apis/js-apis-net-sharing.md
浏览文件 @ c4143e34
......@@ -18,9 +18,11 @@ isSharingSupported(callback: AsyncCallback\<boolean>): void
判断是否支持网络共享，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -43,9 +45,11 @@ isSharingSupported(): Promise\<boolean>
判断是否支持网络共享，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**返回值：**
......@@ -69,9 +73,11 @@ isSharing(callback: AsyncCallback\<boolean>): void
获取当前网络共享状态，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -94,9 +100,11 @@ isSharing(): Promise\<boolean>
获取当前网络共享状态，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**返回值：**
......@@ -120,9 +128,11 @@ startSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void
开启指定类型共享，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -146,9 +156,11 @@ startSharing(type: SharingIfaceType): Promise\<void>
开启指定类型共享，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -179,9 +191,11 @@ stopSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void
关闭指定类型共享，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -205,9 +219,11 @@ stopSharing(type: SharingIfaceType): Promise\<void>
关闭指定类型共享，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -238,9 +254,11 @@ getStatsRxBytes(callback: AsyncCallback\<number>): void
获取共享网络接收数据量，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -263,9 +281,11 @@ getStatsRxBytes(): Promise\<number>
获取共享网络接收数据量，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**返回值：**
......@@ -289,9 +309,11 @@ getStatsTxBytes(callback: AsyncCallback\<number>): void
获取共享网络发送数据量，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -314,9 +336,11 @@ getStatsTxBytes(): Promise\<number>
获取共享网络发送数据量，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**返回值：**
......@@ -340,9 +364,11 @@ getStatsTotalBytes(callback: AsyncCallback\<number>): void
获取共享网络总数据量，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -365,9 +391,11 @@ getStatsTotalBytes(): Promise\<number>
获取共享网络总数据量，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**返回值：**
......@@ -391,15 +419,17 @@ getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback\<Array\<strin
获取指定状态的网卡名称列表，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| state | state: [SharingIfaceState](#sharingifacestate) | 是 | 网络共享状态。 |
| state | [SharingIfaceState](#sharingifacestate) | 是 | 网络共享状态。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调函数，返回指定状态的网卡名称列表。 |
**示例：**
......@@ -418,15 +448,17 @@ getSharingIfaces(state: SharingIfaceState): Promise\<Array\<string>>
获取指定状态的网卡名称列表，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| state | state: [SharingIfaceState](#sharingifacestate) | 是 | 网络共享状态。 |
| state | [SharingIfaceState](#sharingifacestate) | 是 | 网络共享状态。 |
**返回值：**
......@@ -451,9 +483,11 @@ getSharingState(type: SharingIfaceType, callback: AsyncCallback\<SharingIfaceSta
获取指定类型网络共享状态，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -478,9 +512,11 @@ getSharingState(type: SharingIfaceType): Promise\<SharingIfaceState>
获取指定类型网络共享状态，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -511,9 +547,11 @@ getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback\<Array\<strin
获取指定类型网卡名称正则表达式列表，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -538,9 +576,11 @@ getSharableRegexes(type: SharingIfaceType): Promise\<Array\<string>>
获取指定类型网卡名称正则表达式列表，使用Promise方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -571,9 +611,11 @@ on(type: 'sharingStateChange', callback: Callback\<boolean>): void
注册网络共享状态变化事件，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -597,9 +639,11 @@ off(type: 'sharingStateChange', callback?: Callback\<boolean>): void
注销网络共享状态变化事件，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -623,9 +667,11 @@ on(type: 'interfaceSharingStateChange', callback: Callback\<{ type: SharingIface
注册网卡网络共享状态变化事件，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -649,15 +695,17 @@ off(type: 'interfaceSharingStateChange', callback?: Callback\<{ type: SharingIfa
注销网卡网络共享状态变化事件，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- |
| type | string | 否 | 事件名称。 |
| type | string | 是 | 事件名称。 |
| callback | AsyncCallback\<{ type: [SharingIfaceType](#sharingifacetype), iface: string, state: SharingIfaceState(#sharingifacestate) }> | 否 | 回调函数，注销指定网卡共享状态变化通知。 |
**示例：**
......@@ -675,9 +723,11 @@ on(type: 'sharingUpstreamChange', callback: Callback\<NetHandle>): void
注册上行网络变化事件，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -701,9 +751,11 @@ off(type: 'sharingUpstreamChange', callback?: Callback\<NetHandle>): void
注销上行网络变化事件，使用callback方式作为异步方法。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**：SystemCapability.Communication.NetManager.Core
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
**参数：**
......@@ -725,9 +777,11 @@ sharing.off('sharingUpstreamChange', (error, data) => {
网络共享状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
| 参数名 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| SHARING_NIC_SERVING | 1 | 正在网络共享。 |
| SHARING_NIC_CAN_SERVER | 2 | 可提供网络共享。 |
......@@ -737,9 +791,11 @@ sharing.off('sharingUpstreamChange', (error, data) => {
网络共享类型（暂不支持USB共享）。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.Communication.NetManager.NetSharing
| 参数名 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| SHARING_WIFI | 0 | 网络共享类型Wi-Fi。 |
| SHARING_USB | 1 | 网络共享类型USB。 |
......
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ c4143e34
......@@ -1966,6 +1966,7 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
**错误码：**
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error. |
......@@ -1998,6 +1999,7 @@ getRemoteAddress\(\): Promise\<NetAddress>
**错误码：**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error. |
......@@ -2029,6 +2031,7 @@ getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>):
**错误码：**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2303504 | Error looking up x509. |
| 2300002 | System internal error. |
......@@ -2062,6 +2065,7 @@ getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)>
**错误码：**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2303504 | Error looking up x509. |
| 2300002 | System internal error. |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或