Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
3317088e
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,发现更多精彩内容 >>
提交
3317088e
编写于
3月 02, 2022
作者:
M
maosiping
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
change readme
Signed-off-by:
N
maosiping
<
maosiping@huawei.com
>
上级
471eca2f
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
567 addition
and
57 deletion
+567
-57
.gitignore
.gitignore
+1
-0
zh-cn/application-dev/reference/apis/@ohos.net.connection.d.ts
.../application-dev/reference/apis/@ohos.net.connection.d.ts
+509
-0
zh-cn/application-dev/reference/apis/js-apis-net-connection.md
.../application-dev/reference/apis/js-apis-net-connection.md
+57
-57
未找到文件。
.gitignore
浏览文件 @
3317088e
...
...
@@ -21,3 +21,4 @@
Network Trash Folder
Temporary Items
.apdisk
.idea
\ No newline at end of file
zh-cn/application-dev/reference/apis/@ohos.net.connection.d.ts
0 → 100644
浏览文件 @
3317088e
/*
* Copyright (C) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import
{
AsyncCallback
,
Callback
}
from
"
./basic
"
;
import
http
from
"
./@ohos.net.http
"
;
import
socket
from
"
./@ohos.net.socket
"
;
/**
* Provides interfaces to manage and use data networks.
*
* @since 8
* @sysCap SystemCapability.Communication.NetManager.Core
*/
declare
namespace
connection
{
type
HttpRequest
=
http
.
HttpRequest
;
type
TCPSocket
=
socket
.
TCPSocket
;
type
UDPSocket
=
socket
.
UDPSocket
;
/**
* Create a network connection with optional netSpefifier and timeout.
*
* @param netSpecifier Indicates the network specifier. See {@link NetSpecifier}.
* @param timeout The time in milliseconds to attempt looking for a suitable network before
* {@link NetConnection#netUnavailable} is called.
*/
function
createNetConnection
(
netSpecifier
?:
NetSpecifier
,
timeout
?:
number
):
NetConnection
;
/**
* Obtains the data network that is activated by default.
*
* <p>To call this method, you must have the {@code ohos.permission.GET_NETWORK_INFO} permission.
*
* @param callback Returns the {@link NetHandle} object;
* returns {@code null} if the default network is not activated.
* @permission ohos.permission.GET_NETWORK_INFO
*/
function
getDefaultNet
(
callback
:
AsyncCallback
<
NetHandle
>
):
void
;
function
getDefaultNet
():
Promise
<
NetHandle
>
;
/**
* Obtains the list of data networks that are activated.
*
* <p>To invoke this method, you must have the {@code ohos.permission.GET_NETWORK_INFO} permission.
*
* @param callback Returns the {@link NetHandle} object; returns {@code null} if no network is activated.
* @permission ohos.permission.GET_NETWORK_INFO
*/
function
getAllNets
(
callback
:
AsyncCallback
<
Array
<
NetHandle
>>
):
void
;
function
getAllNets
():
Promise
<
Array
<
NetHandle
>>
;
/**
* Queries the connection properties of a network.
*
* <p>This method requires the {@code ohos.permission.GET_NETWORK_INFO} permission.
*
* @param netHandle Indicates the network to be queried.
* @param callback Returns the {@link ConnectionProperties} object.
* @permission ohos.permission.GET_NETWORK_INFO
*/
function
getConnectionProperties
(
netHandle
:
NetHandle
,
callback
:
AsyncCallback
<
ConnectionProperties
>
):
void
;
function
getConnectionProperties
(
netHandle
:
NetHandle
):
Promise
<
ConnectionProperties
>
;
/**
* Obtains {@link NetCapabilities} of a {@link NetHandle} object.
*
* <p>To invoke this method, you must have the {@code ohos.permission.GET_NETWORK_INFO} permission.
*
* @param netHandle Indicates the handle. See {@link NetHandle}.
* @param callback Returns {@link NetCapabilities}; returns {@code null} if {@code handle} is invalid.
* @permission ohos.permission.GET_NETWORK_INFO
*/
function
getNetCapabilities
(
netHandle
:
NetHandle
,
callback
:
AsyncCallback
<
NetCapabilities
>
):
void
;
function
getNetCapabilities
(
netHandle
:
NetHandle
):
Promise
<
NetCapabilities
>
;
/**
* Checks whether the default data network is activated.
*
* @param callback Returns {@code true} if the default data network is activated; returns {@code false} otherwise.
*/
function
hasDefaultNet
(
callback
:
AsyncCallback
<
boolean
>
):
void
;
function
hasDefaultNet
():
Promise
<
boolean
>
;
/**
* Enables the airplane mode for a device.
*
* @systemapi Hide this for inner system use. Only used for system app.
*/
function
enableAirplaneMode
(
callback
:
AsyncCallback
<
void
>
):
void
;
function
enableAirplaneMode
():
Promise
<
void
>
;
/**
* Disables the airplane mode for a device.
*
* @systemapi Hide this for inner system use. Only used for system app.
*/
function
disableAirplaneMode
(
callback
:
AsyncCallback
<
void
>
):
void
;
function
disableAirplaneMode
():
Promise
<
void
>
;
/**
* Reports the network state is connected.
*
* @param netHandle Indicates the network whose state is to be reported.
* @permission ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET
*/
function
reportNetConnected
(
netHandle
:
NetHandle
,
callback
:
AsyncCallback
<
void
>
):
void
;
function
reportNetConnected
(
netHandle
:
NetHandle
):
Promise
<
void
>
;
/**
* Reports the network state is disconnected.
*
* @param netHandle Indicates the network whose state is to be reported.
* @permission ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET
*/
function
reportNetDisconnected
(
netHandle
:
NetHandle
,
callback
:
AsyncCallback
<
void
>
):
void
;
function
reportNetDisconnected
(
netHandle
:
NetHandle
):
Promise
<
void
>
;
/**
* Resolves the host name to obtain all IP addresses based on the default data network.
*
* @param host Indicates the host name or the domain.
* @param callback Returns the NetAddress list.
* @permission ohos.permission.GET_NETWORK_INFO
*/
function
getAddressesByName
(
host
:
string
,
callback
:
AsyncCallback
<
Array
<
NetAddress
>>
):
void
;
function
getAddressesByName
(
host
:
string
):
Promise
<
Array
<
NetAddress
>>
;
export
interface
NetConnection
{
on
(
type
:
'
netAvailable
'
,
callback
:
Callback
<
NetHandle
>
):
void
;
on
(
type
:
'
netBlockStatusChange
'
,
callback
:
Callback
<
{
netHandle
:
NetHandle
,
blocked
:
boolean
}
>
):
void
;
on
(
type
:
'
netCapabilitiesChange
'
,
callback
:
Callback
<
{
netHandle
:
NetHandle
,
netCap
:
NetCapabilities
}
>
):
void
;
on
(
type
:
'
netConnectionPropertiesChange
'
,
callback
:
Callback
<
{
netHandle
:
NetHandle
,
connectionProperties
:
ConnectionProperties
}
>
):
void
;
on
(
type
:
'
netLost
'
,
callback
:
Callback
<
NetHandle
>
):
void
;
on
(
type
:
'
netUnavailable
'
,
callback
:
Callback
<
void
>
):
void
;
/**
* Receives status change notifications of a specified network.
*
* @permission ohos.permission.GET_NETWORK_INFO
*/
register
(
callback
:
AsyncCallback
<
void
>
):
void
;
/**
* Cancels listening for network status changes.
*/
unregister
(
callback
:
AsyncCallback
<
void
>
):
void
;
}
export
interface
NetSpecifier
{
netCapabilities
:
NetCapabilities
;
bearerPrivateIdentifier
?:
string
;
}
export
interface
NetHandle
{
netId
:
number
;
/**
* Binds a TCPSocket or UDPSocket to the current network. All data flows from
* the socket will use this network, without being subject to {@link setAppNet}.
* Before using this method, ensure that the socket is disconnected.
*
* @param socketParam Indicates the TCPSocket or UDPSocket object.
*/
bindSocket
(
socketParam
:
TCPSocket
|
UDPSocket
,
callback
:
AsyncCallback
<
void
>
):
void
;
bindSocket
(
socketParam
:
TCPSocket
|
UDPSocket
):
Promise
<
void
>
;
/**
* Accesses a specified URL.
*
* @param url Indicates a URL connection.
* @param callback Returns a {@code URLConnection} object matching the given {@code url}.
*/
openConnection
(
url
:
string
,
callback
:
AsyncCallback
<
HttpRequest
>
):
void
;
openConnection
(
url
:
string
,
proxy
:
NetProxy
,
callback
:
AsyncCallback
<
HttpRequest
>
):
void
;
openConnection
(
url
:
string
,
proxy
?:
NetProxy
):
Promise
<
HttpRequest
>
;
/**
* Resolves a host name to obtain all IP addresses based on the specified NetHandle.
*
* @param host Indicates the host name or the domain.
* @param callback Returns the NetAddress list.
*/
getAddressesByName
(
host
:
string
,
callback
:
AsyncCallback
<
Array
<
NetAddress
>>
):
void
;
getAddressesByName
(
host
:
string
):
Promise
<
Array
<
NetAddress
>>
;
/**
* Resolves a host name to obtain the first IP address based on the specified NetHandle.
*
* @param host Indicates the host name or the domain.
* @return Returns the first NetAddress.
*/
getAddressByName
(
host
:
string
,
callback
:
AsyncCallback
<
NetAddress
>
):
void
;
getAddressByName
(
host
:
string
):
Promise
<
NetAddress
>
;
}
export
interface
NetCapabilities
{
linkUpBandwidthKbps
?:
number
;
linkDownBandwidthKbps
?:
number
;
networkCap
?:
Array
<
NetCap
>
;
bearerTypes
:
Array
<
NetBearType
>
;
}
export
enum
NetCap
{
/**
* Indicates that the network can access the carrier's MMSC to send and receive multimedia messages.
*/
NET_CAPABILITY_MMS
=
0
,
/**
* Indicates that the network can access the carrier's SUPL server.
*/
NET_CAPABILITY_SUPL
=
1
,
/**
* Indicates that the network can access the carrier's DUN or Tethering gateway.
*/
NET_CAPABILITY_DUN
=
2
,
/**
* Indicates that the network can access the FOTA server for remote device upgrade.
*/
NET_CAPABILITY_FOTA
=
3
,
/**
* Indicates that the network can access the IMS server.
*/
NET_CAPABILITY_IMS
=
4
,
/**
* Indicates that the network can access the carrier's CBS server.
*/
NET_CAPABILITY_CBS
=
5
,
/**
* Indicates that the network can be used for Wi-Fi Direct.
*/
NET_CAPABILITY_WIFI_P2P
=
6
,
/**
* Indicates that the network can access the carrier's Initial Attach server.
*/
NET_CAPABILITY_IA
=
7
,
/**
* Indicates that the network can access the carrier's RCS server.
*/
NET_CAPABILITY_RCS
=
8
,
/**
* Indicates that the network can access the carrier's XCAP server.
*/
NET_CAPABILITY_XCAP
=
9
,
/**
* Indicates that the network can access the carrier's IMS emergency call server.
*/
NET_CAPABILITY_EIMS
=
10
,
/**
* Indicates that the network traffic is not metered.
*/
NET_CAPABILITY_NOT_METERED
=
11
,
/**
* Indicates that the network can access the Internet.
*/
NET_CAPABILITY_INTERNET
=
12
,
/**
* Indicates that the network is not restricted.
*/
NET_CAPABILITY_NOT_RESTRICTED
=
13
,
/**
* Indicates that the network is trusted.
*/
NET_CAPABILITY_TRUSTED
=
14
,
/**
* Indicates that the network does not use a VPN.
*/
NET_CAPABILITY_NOT_VPN
=
15
,
/**
* Indicates that the network is available.
*/
NET_CAPABILITY_VALIDATED
=
16
,
/**
* Indicates that this network was found to have a captive portal in place last time it was
* probed.
*/
NET_CAPABILITY_CAPTIVE_PORTAL
=
17
,
/**
* Indicates that the network is unavailable during roaming.
*/
NET_CAPABILITY_NOT_ROAMING
=
18
,
/**
* Indicates that the network is available only for foreground applications.
*/
NET_CAPABILITY_FOREGROUND
=
19
,
/**
* Indicates that the network is not congested.
*/
NET_CAPABILITY_NOT_CONGESTED
=
20
,
/**
* Indicates that the network is not suspended.
*/
NET_CAPABILITY_NOT_SUSPENDED
=
21
,
/**
* Indicates that traffic that goes through this network is paid by oem. For example,
* this network can be used by system apps to upload telemetry data.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_OEM_PAID
=
22
,
/**
* Indicates that the network can access the Mission Critical server of the carrier.
*/
NET_CAPABILITY_MCX
=
23
,
/**
* Indicates that the network was tested to only provide partial connectivity.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_PARTIAL_CONNECTIVITY
=
24
,
/**
* Indicates that the network extends cap
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_HW_BASE
=
NET_CAPABILITY_PARTIAL_CONNECTIVITY
,
/**
* Indicates that the network can access the BIP0 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP0
=
NET_CAPABILITY_HW_BASE
+
1
,
/**
* Indicates that the network can access the BIP1 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP1
=
NET_CAPABILITY_HW_BASE
+
2
,
/**
* Indicates that the network can access the BIP2 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP2
=
NET_CAPABILITY_HW_BASE
+
3
,
/**
* Indicates that the network can access the BIP3 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP3
=
NET_CAPABILITY_HW_BASE
+
4
,
/**
* Indicates that the network can access the BIP4 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP4
=
NET_CAPABILITY_HW_BASE
+
5
,
/**
* Indicates that the network can access the BIP5 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP5
=
NET_CAPABILITY_HW_BASE
+
6
,
/**
* Indicates that the network can access the BIP6 server.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_BIP6
=
NET_CAPABILITY_HW_BASE
+
7
,
/**
* Indicates that the network can access internal default servers.
*
* @systemapi Hide this for inner system use.
*/
NET_CAPABILITY_INTERNAL_DEFAULT
}
export
enum
NetBearType
{
/**
* Indicates that the network is based on a cellular network.
*/
BEARER_CELLULAR
=
0
,
/**
* Indicates that the network is based on a Wi-Fi network.
*/
BEARER_WIFI
=
1
,
/**
* Indicates that the network is based on a Bluetooth network.
*/
BEARER_BLUETOOTH
=
2
,
/**
* Indicates that the network is an Ethernet network.
*/
BEARER_ETHERNET
=
3
,
/**
* Indicates that the network is a VPN.
*/
BEARER_VPN
=
4
,
/**
* Indicates that the network is a Wi-Fi Aware network.
*/
BEARER_WIFI_AWARE
=
5
,
/**
* Indicates that the network is a LoWPAN network.
*/
BEARER_LOWPAN
=
6
}
export
interface
ConnectionProperties
{
interfaceName
:
string
;
isUsePrivateDns
:
boolean
;
privateDnsServerName
:
string
;
domains
:
string
;
httpProxy
:
HttpProxy
;
linkAddresses
:
Array
<
LinkAddress
>
;
dnses
:
Array
<
NetAddress
>
;
routes
:
Array
<
RouteInfo
>
;
mtu
:
number
;
}
export
interface
HttpProxy
{
host
:
string
;
port
:
number
;
parsedExclusionList
:
Array
<
string
>
;
}
export
interface
RouteInfo
{
interface
:
string
;
destination
:
LinkAddress
;
gateway
:
NetAddress
;
hasGateway
:
boolean
;
isDefaultRoute
:
boolean
;
}
export
interface
LinkAddress
{
address
:
NetAddress
;
prefixLength
:
number
;
}
/**
* @since 7
*/
export
interface
NetAddress
{
address
:
string
;
family
?:
number
;
// IPv4 = 1; IPv6 = 2, default is IPv4
port
?:
number
;
// [0, 65535]
}
export
interface
NetProxy
{
type
:
ProxyType
;
address
:
NetAddress
;
}
export
enum
ProxyType
{
/**
* Represents proxy for high level protocols such as HTTP or FTP.
*/
HTTP
,
/**
* Represents a SOCKS (V4 or V5) proxy.
*/
SOCKS
}
}
export
default
connection
;
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-net-connection.md
浏览文件 @
3317088e
...
...
@@ -24,7 +24,7 @@ getDefaultNet(callback: AsyncCallback\<NetHandle>): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| callback | AsyncCallback
\<
[
NetHandle
](
#
NetH
andle
)
> | 是 | 回调函数 |
| callback | AsyncCallback
\<
[
NetHandle
](
#
neth
andle
)
> | 是 | 回调函数 |
**示例:**
...
...
@@ -49,7 +49,7 @@ getDefaultNet(): Promise\<NetHandle>
| 类型 | 说明 |
| ----- | ----- |
| Promise
\<
[
NetHandle
](
#
NetH
andle
)
> | 以Promise形式返回 |
| Promise
\<
[
NetHandle
](
#
neth
andle
)
> | 以Promise形式返回 |
**示例:**
...
...
@@ -122,8 +122,8 @@ getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback\<Connectio
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| netHandle |
[
NetHandle
](
#
NetH
andle
)
| 是 | 对应网络 |
| callback | AsyncCallback
\<
[
ConnectionProperties
](
#
ConnectionP
roperties
)
> | 是 | 回调函数 |
| netHandle |
[
NetHandle
](
#
neth
andle
)
| 是 | 对应网络 |
| callback | AsyncCallback
\<
[
ConnectionProperties
](
#
connectionp
roperties
)
> | 是 | 回调函数 |
**示例:**
...
...
@@ -150,13 +150,13 @@ getConnectionProperties(netHandle: NetHandle): Promise\<ConnectionProperties>
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| netHandle |
[
NetHandle
](
#
NetH
andle
)
| 是 | 对应网络 |
| netHandle |
[
NetHandle
](
#
neth
andle
)
| 是 | 对应网络 |
**返回值:**
| 类型 | 说明 |
| ----- | ----- |
| Promise
\<
[
ConnectionProperties
](
#
ConnectionP
roperties
)
> | 以Promise形式返回 |
| Promise
\<
[
ConnectionProperties
](
#
connectionp
roperties
)
> | 以Promise形式返回 |
**示例:**
...
...
@@ -182,8 +182,8 @@ getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback\<NetCapabilitie
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| netHandle |
[
NetHandle
](
#
NetH
andle
)
| 是 | 对应网络 |
| callback | AsyncCallback
\<
[
NetCapabilities
](
#
NetC
apabilities
)
> | 是 | 回调函数 |
| netHandle |
[
NetHandle
](
#
neth
andle
)
| 是 | 对应网络 |
| callback | AsyncCallback
\<
[
NetCapabilities
](
#
netc
apabilities
)
> | 是 | 回调函数 |
**示例:**
...
...
@@ -210,13 +210,13 @@ getNetCapabilities(netHandle: NetHandle): Promise\<NetCapabilities>
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| netHandle |
[
NetHandle
](
#
NetH
andle
)
| 是 | 对应网络 |
| netHandle |
[
NetHandle
](
#
neth
andle
)
| 是 | 对应网络 |
**返回值:**
| 类型 | 说明 |
| ----- | ----- |
| Promise
\<
[
NetCapabilities
](
#
NetC
apabilities
)
> | 以Promise形式返回 |
| Promise
\<
[
NetCapabilities
](
#
netc
apabilities
)
> | 以Promise形式返回 |
**示例:**
...
...
@@ -243,7 +243,7 @@ getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>):
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| host | string | 是 | 需要解析的域名 |
| callback | AsyncCallback
\<
Array
\<
[
NetAddress
](
#
NetA
ddress
)
>> | 是 | 回调函数 |
| callback | AsyncCallback
\<
Array
\<
[
NetAddress
](
#
neta
ddress
)
>> | 是 | 回调函数 |
**示例:**
...
...
@@ -276,7 +276,7 @@ getAddressesByName(netHandle: NetHandle): Promise\<Array\<NetAddress>>
| 类型 | 说明 |
| ----- | ----- |
| Promise
\<
Array
\<
[
NetAddress
](
#
NetA
ddress
)
>> | 以Promise形式返回 |
| Promise
\<
Array
\<
[
NetAddress
](
#
neta
ddress
)
>> | 以Promise形式返回 |
**示例:**
...
...
@@ -292,7 +292,7 @@ connection.getDefaultNet().then(function (netHandle) {
createNetConnection(netSpecifier?: NetSpecifier, timeout?: number): NetConnection
获取一个netSpecifier指定的网络的句柄
获取一个netSpecifier指定的网络的句柄
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -302,14 +302,14 @@ createNetConnection(netSpecifier?: NetSpecifier, timeout?: number): NetConnectio
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| netSpecifier |
[
NetSpecifier
](
#
NetSpecifier
)
| 否 | 关注的网络的各项特征,不指定则关注默认网络
|
| timeout | number | 否 | 获取netSpecifier指定的网络时的超时时间,
前提是netSpecifier存在
|
| netSpecifier |
[
NetSpecifier
](
#
netspecifier
)
| 否 | 指定网络的各项特征,不指定则关注默认网络。
|
| timeout | number | 否 | 获取netSpecifier指定的网络时的超时时间,
仅netSpecifier存在时生效。
|
**返回值:**
| 类型 | 说明 |
| ----- | ----- |
|
[
NetConnection
](
#
NetC
onnection
)
| 所关注的网络的句柄 |
|
[
NetConnection
](
#
netc
onnection
)
| 所关注的网络的句柄 |
**示例:**
...
...
@@ -325,7 +325,7 @@ let netConnection2 = connection.createNetConnection({
})
```
##
connection.NetConnection<a name=NetConnection></a>
##
NetConnection
网络连接的句柄
...
...
@@ -333,7 +333,7 @@ let netConnection2 = connection.createNetConnection({
on(type: 'netAvailable', callback: Callback
\<
NetHandle>): void
监听网络可用事件
监听网络可用事件
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -344,7 +344,7 @@ on(type: 'netAvailable', callback: Callback\<NetHandle>): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| type | string | 是 | 监听的事件,固定'netAvailable' |
| callback | Callback
\<
[
NetHandle
](
#
NetH
andle
)
>> | 是 | 回调函数 |
| callback | Callback
\<
[
NetHandle
](
#
neth
andle
)
>> | 是 | 回调函数 |
**示例:**
...
...
@@ -358,7 +358,7 @@ connection.createNetConnection().on('netAvailable', function (data) {
on(type: 'netCapabilitiesChange', callback: Callback
<
{
netHandle:
NetHandle
,
netCap:
NetCapabilities
}
>
): void
监听网络能力变化事件
监听网络能力变化事件
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -369,7 +369,7 @@ on(type: 'netCapabilitiesChange', callback: Callback<{ netHandle: NetHandle, net
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| type | string | 是 | 监听的事件,固定'netCapabilitiesChange' |
| callback | Callback
<
{
netHandle:
[
NetHandle
](
#
NetHandle
),
netCap:
[
NetCapabilities
](
#NetC
apabilities
)
}
>
| 是 | 回调函数 |
| callback | Callback
<
{
netHandle:
[
NetHandle
](
#
nethandle
),
netCap:
[
NetCapabilities
](
#netc
apabilities
)
}
>
| 是 | 回调函数 |
**示例:**
...
...
@@ -383,7 +383,7 @@ connection.createNetConnection().on('netCapabilitiesChange', function (data) {
on(type: 'netConnectionPropertiesChange', callback: Callback
<
{
netHandle:
NetHandle
,
connectionProperties:
ConnectionProperties
}
>
): void
监听网络连接信息变化事件
监听网络连接信息变化事件
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -394,7 +394,7 @@ on(type: 'netConnectionPropertiesChange', callback: Callback<{ netHandle: NetHan
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| type | string | 是 | 监听的事件,固定'netConnectionPropertiesChange' |
| callback | Callback
<
{
netHandle:
[
NetHandle
](
#
NetHandle
),
connectionProperties:
[
ConnectionProperties
](
#ConnectionP
roperties
)
}
>
| 是 | 回调函数 |
| callback | Callback
<
{
netHandle:
[
NetHandle
](
#
nethandle
),
connectionProperties:
[
ConnectionProperties
](
#connectionp
roperties
)
}
>
| 是 | 回调函数 |
**示例:**
...
...
@@ -408,7 +408,7 @@ connection.createNetConnection().on('netConnectionPropertiesChange', function (d
on(type: 'netLost', callback: Callback
\<
NetHandle>): void
监听网络丢失事件
监听网络丢失事件
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -419,7 +419,7 @@ on(type: 'netLost', callback: Callback\<NetHandle>): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| type | string | 是 | 监听的事件,固定'netLost' |
| callback | Callback
\<
[
NetHandle
](
#
NetH
andle
)
>> | 是 | 回调函数 |
| callback | Callback
\<
[
NetHandle
](
#
neth
andle
)
>> | 是 | 回调函数 |
**示例:**
...
...
@@ -433,7 +433,7 @@ connection.createNetConnection().on('netLost', function (data) {
on(type: 'netUnavailable', callback: Callback
\<
void>): void
监听网络不可用事件
监听网络不可用事件
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -458,7 +458,7 @@ connection.createNetConnection().on('netUnavailable', function (data) {
register(callback: AsyncCallback
\<
void>): void
注册网络的监听
注册网络的监听
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -482,7 +482,7 @@ connection.createNetConnection().register(function (error) {
unregister(callback: AsyncCallback
\<
void>): void
注销网络的监听
注销网络的监听
。
**需要权限**
:ohos.permission.GET_NETWORK_INFO
...
...
@@ -502,7 +502,7 @@ connection.createNetConnection().unregister(function (error) {
})
```
##
connection.NetHandle<a name=NetHandle></a>
##
NetHandle
网络的句柄
...
...
@@ -525,7 +525,7 @@ getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>):
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| host | string | 是 | 需要解析的域名 |
| callback | AsyncCallback
\<
Array
\<
[
NetAddress
](
#
NetA
ddress
)
>> | 是 | 回调函数 |
| callback | AsyncCallback
\<
Array
\<
[
NetAddress
](
#
neta
ddress
)
>> | 是 | 回调函数 |
**示例:**
...
...
@@ -558,7 +558,7 @@ getAddressesByName(netHandle: NetHandle): Promise\<Array\<NetAddress>>
| 类型 | 说明 |
| ----- | ----- |
| Promise
\<
Array
\<
[
NetAddress
](
#
NetA
ddress
)
>> | 以Promise形式返回 |
| Promise
\<
Array
\<
[
NetAddress
](
#
neta
ddress
)
>> | 以Promise形式返回 |
**示例:**
...
...
@@ -585,7 +585,7 @@ getAddressByName(host: string, callback: AsyncCallback\<NetAddress>): void
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----- | ---- | ----- |
| host | string | 是 | 需要解析的域名 |
| callback | AsyncCallback
\<
[
NetAddress
](
#
NetA
ddress
)
> | 是 | 回调函数 |
| callback | AsyncCallback
\<
[
NetAddress
](
#
neta
ddress
)
> | 是 | 回调函数 |
**示例:**
...
...
@@ -618,7 +618,7 @@ getAddressByName(netHandle: NetHandle): Promise\<NetAddress>
| 类型 | 说明 |
| ----- | ----- |
| Promise
\<
[
NetAddress
](
#
NetA
ddress
)
> | 以Promise形式返回 |
| Promise
\<
[
NetAddress
](
#
neta
ddress
)
> | 以Promise形式返回 |
**示例:**
...
...
@@ -630,80 +630,80 @@ connection.getDefaultNet().then(function (netHandle) {
})
```
##
connection.NetSpecifier<a name=NetSpecifier></a>
##
NetSpecifier
网络的特征
网络的特征
。
| 变量 | 类型 | 说明 |
| ----- | ----- | ----- |
| netCapabilities |
[
NetCapabilities
](
#
NetC
apabilities
)
| 网络的能力集 |
| netCapabilities |
[
NetCapabilities
](
#
netc
apabilities
)
| 网络的能力集 |
| bearerPrivateIdentifier | string | 网络标识符,WIFI网络的标识符是"wifi",蜂窝网络的标识符是"slot0"(对应SIM卡1) |
##
connection.NetCapabilities<a name=NetCapabilities></a>
##
NetCapabilities
网络的能力集
网络的能力集
。
| 变量 | 类型 | 说明 |
| ----- | ----- | ----- |
| linkUpBandwidthKbps | number | 带宽上限 |
| linkDownBandwidthKbps | number | 带宽下限 |
| networkCap | Array
<
[
NetCap
](
#
NetC
ap
)
>
| 网络具体能力 |
| bearerTypes | Array
<
[
NetBearType
](
#
NetB
earType
)
>
| 网络类型 |
| networkCap | Array
<
[
NetCap
](
#
netc
ap
)
>
| 网络具体能力 |
| bearerTypes | Array
<
[
NetBearType
](
#
netb
earType
)
>
| 网络类型 |
##
connection.NetCap<a name=NetCap></a>
##
NetCap
网络具体能力
网络具体能力
。
| 变量 | 值 | 说明 |
| ------ | ----- | ----- |
| NET_CAPABILITY_INTERNET | 12 | 联网能力 |
| NET_CAPABILITY_VALIDATED | 16 | 网络可用 |
##
connection.NetBearType<a name=NetBearType></a>
##
NetBearType
网络类型
网络类型
。
| 变量 | 值 | 说明 |
| ------ | ----- | ----- |
| BEARER_CELLULAR | 0 | 蜂窝网络 |
| BEARER_WIFI | 1 | WIFI网络 |
##
connection.ConnectionProperties<a name=ConnectionProperties></a>
##
ConnectionProperties
网络连接信息
网络连接信息
。
| 变量 | 类型 | 说明 |
| ----- | ----- | ----- |
| interfaceName | string | 网卡名称 |
| domains | string | 所属域,默认"" |
| linkAddresses | Array
<
[
LinkAddress
](
#
LinkA
ddress
)
>
| 链路信息 |
| routes | Array
<
[
RouteInfo
](
#
RouteI
nfo
)
>
| 路由信息 |
| linkAddresses | Array
<
[
LinkAddress
](
#
linka
ddress
)
>
| 链路信息 |
| routes | Array
<
[
RouteInfo
](
#
routei
nfo
)
>
| 路由信息 |
| mtu | number | 最大传输单元 |
##
connection.LinkAddress<a name=LinkAddress></a>
##
LinkAddress
网络链路信息
网络链路信息
。
| 变量 | 类型 | 说明 |
| ----- | ----- | ----- |
| address |
[
NetAddress
](
#
NetA
ddress
)
| 链路地址 |
| address |
[
NetAddress
](
#
neta
ddress
)
| 链路地址 |
| prefixLength | number | 地址前缀长度 |
##
connection.RouteInfo<a name=RouteInfo></a>
##
RouteInfo
网络路由信息
网络路由信息
。
| 变量 | 类型 | 说明 |
| ----- | ----- | ----- |
| interface | string | 网卡名称 |
| destination |
[
LinkAddress
](
#
LinkA
ddress
)
| 目的地址 |
| gateway |
[
NetAddress
](
#
NetA
ddress
)
| 网关地址 |
| destination |
[
LinkAddress
](
#
linka
ddress
)
| 目的地址 |
| gateway |
[
NetAddress
](
#
neta
ddress
)
| 网关地址 |
| hasGateway | boolean | 是否有网关 |
| isDefaultRoute | boolean | 是否为默认路由 |
##
connection.NetAddress<a name=NetAddress></a>
##
NetAddress
地址
地址
。
| 变量 | 类型 | 说明 |
| ----- | ----- | ----- |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录