说明
chrome.networking.onc
API 用于配置网络连接(移动网络、以太网、VPN 或 Wi-Fi)。此 API 适用于自动启动的 Chrome 操作系统自助服务终端会话。
网络连接配置是按照开放网络配置 (ONC) 规范指定的。
注意:大多数字典属性和枚举值都使用 UpperCamelCase(大驼峰式命名法)格式以符合 ONC 规范,而不是 JavaScript lowerCamelCase 惯例。
权限
networking.onc
可用性
类型
ActivationStateType
枚举
CaptivePortalStatus
枚举
"ProxyAuthRequired"
CellularProperties
属性
-
ActivationState
运营商帐号激活状态。
-
ActivationType
字符串(可选)
移动网络激活类型。
-
AllowRoaming
布尔值 选填
网络是否允许漫游。
-
AutoConnect
布尔值 选填
是否应自动连接移动网络(在覆盖范围内时)。
-
家庭
字符串(可选)
移动设备技术系列 -
CDMA
或GSM
。 -
FirmwareRevision
字符串(可选)
在移动网络调制解调器中加载的固件修订版本。
-
FoundNetworks
在最近一次网络扫描中找到的网络列表。
-
HardwareRevision
字符串(可选)
移动网络调制解调器硬件修订版。
-
HomeProvider
与调制解调器中当前安装的 SIM 卡的发行运营商相关的信息。
-
制造商
字符串(可选)
移动网络调制解调器制造商。
-
ModelID
字符串(可选)
移动网络调制解调器型号 ID。
-
NetworkTechnology
字符串(可选)
如果调制解调器已在网络上注册,则表示当前正在使用的网络技术。
-
PaymentPortal
PaymentPortal(可选)
用户可用于注册或修改移动流量套餐的在线付款门户。
-
RoamingState
字符串(可选)
当前网络上的移动网络调制解调器的漫游状态。
-
SIMLockStatus
SIMLockStatus(可选)
GSM 家庭网络的 SIM 卡锁定状态。
-
SIMPresent
布尔值 选填
是否有 SIM 卡。
-
扫描
布尔值 选填
Chrome 63 及更高版本如果正在进行移动网络扫描,则为 true。
-
ServingOperator
关于当前注册了调制解调器网络的运营商的信息。
-
SignalStrength
数字可选
当前网络信号强度。
-
SupportNetworkScan
布尔值 选填
移动网络是否支持扫描。
CellularProviderProperties
属性
-
代码
string
移动网络 ID,即网络 MCC(移动设备国家/地区代码)和 MNC(移动网络代码)的简单串联。
-
国家/地区
字符串(可选)
由两个字母表示的国家/地区代码。
-
名称
string
运算符名称。
CellularStateProperties
属性
-
ActivationState
-
NetworkTechnology
字符串(可选)
-
RoamingState
字符串(可选)
-
SIMPresent
布尔值 选填
-
SignalStrength
数字可选
CertificatePattern
属性
-
EnrollmentURI
string[] 可选
在未找到与此格式匹配的证书时可将用户定向到的 URI 列表。
-
颁发者
如果设置了此字段,则表示应与 X.509 发卡机构设置匹配的模式。
-
IssuerCARef
string[] 可选
证书颁发者 CA 证书的列表。证书必须由其中之一的签名才能匹配此模式。
-
主题
如果设置了此字段,则 X.509 主题设置应与之进行匹配的模式。
ClientCertificateType
枚举
"Ref"
ConnectionStateType
枚举
DeviceStateProperties
属性
-
SIMLockStatus
SIMLockStatus(可选)
Chrome 62 及更高版本如果类型 = 移动网络且 SIMPresent = True,则为 SIM 卡锁定状态。
-
SIMPresent
布尔值 选填
Chrome 62 及更高版本如果设备类型为“移动网络”,则设置为 SIM 卡显示状态。
-
扫描
布尔值 选填
设置设备是否处于启用状态。如果设备目前正在扫描,则为 true。
-
设备的当前状态。
-
类型
与设备关联的网络类型(移动网络、以太网或 Wi-Fi)。
DeviceStateType
枚举
"Uninitialized"
设备可用,但尚未初始化。
"Disabled"
设备已初始化,但尚未启用。
"正在启用"
已请求启用状态,但尚未完成。
"已启用"
设备已启用。
“禁止”
禁止使用设备。
EAPProperties
属性
-
AnonymousIdentity
字符串(可选)
-
ClientCertPKCS11ID
字符串(可选)
Chrome 60 及更高版本 -
ClientCertPattern
-
ClientCertProvisioningProfileId
字符串(可选)
Chrome 93 及更高版本 -
ClientCertRef
字符串(可选)
-
ClientCertType
-
身份
字符串(可选)
-
内联接
字符串(可选)
-
外部
字符串(可选)
外部 EAP 类型。ONC 要求填写此字段,但在从 Shill 进行翻译时可能不提供。
-
密码
字符串(可选)
-
SaveCredentials
布尔值 选填
-
ServerCAPEMs
string[] 可选
-
ServerCARefs
string[] 可选
-
SubjectMatchChrome 60 及更高版本
-
UseProactiveKeyCaching
布尔值 选填
-
UseSystemCAs
布尔值 选填
EthernetProperties
属性
-
身份验证
字符串(可选)
以太网网络使用的身份验证机制。可能的值有
None
和8021X
。 -
AutoConnect
布尔值 选填
是否自动连接以太网。
-
EAP
EAPProperties(可选)
网络的 EAP 设置。8021X 身份验证需要使用该选项。
EthernetStateProperties
属性
-
身份验证
string
FoundNetworkProperties
属性
-
LongName
字符串(可选)
网络运营商的长格式名称。
-
NetworkId
string
广告网络 ID。
-
ShortName
字符串(可选)
网络运营商的短格式名称。
-
状态
string
网络可用性。
-
科技
string
网络使用的访问技术。
GlobalPolicy
属性
-
AllowOnlyPolicyNetworksToAutoconnect
布尔值 选填
如果为 true,则只有政策网络可以自动连接。默认值为 false。
-
AllowOnlyPolicyNetworksToConnect
布尔值 选填
如果为 true,则只能连接到政策网络,并且无法添加或配置新网络。默认值为 false。
-
AllowOnlyPolicyNetworksToConnectIfAvailable
布尔值 选填
Chrome 70 及更高版本如果为 true,且可见网络列表中有托管网络,则只能连接到政策网络,无法添加或配置新网络。默认值为 false。
-
BlockedHexSSIDs
string[] 可选
Chrome 86 及更高版本已屏蔽广告联盟的列表。禁止连接到已屏蔽的网络。您可以通过指定明确的网络配置再次取消屏蔽网络。默认为空列表。
IPConfigProperties
属性
-
ExcludedRoutes
string[] 可选
Chrome 76 及更高版本采用 CIDR 表示法的 IP 块数组,请参阅 onc_spec.md 了解详情。
-
网关
字符串(可选)
用于 IP 配置的网关地址。
-
IPAddress
字符串(可选)
连接的 IP 地址。可以是 IPv4 或 IPv6 地址,具体取决于
Type
的值。 -
IncludedRoutes
string[] 可选
Chrome 76 及更高版本采用 CIDR 表示法的 IP 块数组,请参阅 onc_spec.md 了解详情。
-
NameServers
string[] 可选
用于域名服务器的地址数组。
-
RoutingPrefix
数字可选
路由前缀。
-
SearchDomains
string[] 可选
Chrome 76 及更高版本用于名称解析的字符串数组,请参阅 onc_spec.md 了解详情。
-
类型
字符串(可选)
IP 配置类型。可以是
IPv4
或IPv6
。 -
WebProxyAutoDiscoveryUrl
字符串(可选)
WEb 代理自动发现的网址,通过 DHCP 报告。
IPConfigType
枚举
IssuerSubjectPattern
属性
-
CommonName
字符串(可选)
如果设置,则为与证书正文的通用名称匹配的值。
-
市行政区
字符串(可选)
如果设置,则为与证书正文的公共位置匹配的值。
-
组织
字符串(可选)
如果设置,则为与证书正文的组织匹配的值。至少有一个组织应与该值相匹配。
-
OrganizationalUnit
字符串(可选)
如果设置,则为与证书正文的组织部门匹配的值。至少有一个组织部门应与该值相匹配。
ManagedBoolean
属性
-
有效
布尔值 选填
网络配置管理器当前使用的有效值(例如 Shill)。
-
DeviceEditable
布尔值 选填
属性的 DevicePolicy 是否存在以及是否允许修改该属性(即通过政策设置建议的属性值)。默认为
false
。 -
DevicePolicy
布尔值 选填
设备政策提供的属性值。
-
生效日期
字符串(可选)
确定有效属性值的来源。
-
布尔值 选填
为设备的所有用户设置的值。仅当
DeviceEditiable
为true
时提供。 -
UserEditable
布尔值 选填
属性是否存在 UserPolicy,是否允许修改该属性(即通过策略设置建议的属性值)。默认为
false
。 -
UserPolicy
布尔值 选填
用户规范提供的属性值。
-
UserSetting
布尔值 选填
由已登录用户设置的属性值。仅当
UserEditable
为true
时提供。
ManagedCellularProperties
属性
-
ActivationState
-
ActivationType
字符串(可选)
-
AllowRoaming
布尔值 选填
-
AutoConnect
-
家庭
字符串(可选)
-
FirmwareRevision
字符串(可选)
-
FoundNetworks
-
HardwareRevision
字符串(可选)
-
HomeProvider
-
制造商
字符串(可选)
-
ModelID
字符串(可选)
-
NetworkTechnology
字符串(可选)
-
PaymentPortal
PaymentPortal(可选)
-
RoamingState
字符串(可选)
-
SIMLockStatus
SIMLockStatus(可选)
-
SIMPresent
布尔值 选填
-
扫描
布尔值 选填
Chrome 63 及更高版本 -
ServingOperator
-
SignalStrength
数字可选
-
SupportNetworkScan
布尔值 选填
ManagedDOMString
属性
-
有效
字符串(可选)
网络配置管理器当前使用的有效值(例如 Shill)。
-
DeviceEditable
布尔值 选填
属性的 DevicePolicy 是否存在以及是否允许修改该属性(即通过政策设置建议的属性值)。默认为
false
。 -
DevicePolicy
字符串(可选)
设备政策提供的属性值。
-
生效日期
字符串(可选)
确定有效属性值的来源。
-
字符串(可选)
为设备的所有用户设置的值。仅当
DeviceEditiable
为true
时提供。 -
UserEditable
布尔值 选填
属性是否存在 UserPolicy,是否允许修改该属性(即通过策略设置建议的属性值)。默认为
false
。 -
UserPolicy
字符串(可选)
用户规范提供的属性值。
-
UserSetting
字符串(可选)
由已登录用户设置的属性值。仅当
UserEditable
为true
时提供。
ManagedDOMStringList
属性
-
有效
string[] 可选
网络配置管理器当前使用的有效值(例如 Shill)。
-
DeviceEditable
布尔值 选填
属性的 DevicePolicy 是否存在以及是否允许修改该属性(即通过政策设置建议的属性值)。默认为
false
。 -
DevicePolicy
string[] 可选
设备政策提供的属性值。
-
生效日期
字符串(可选)
确定有效属性值的来源。
-
string[] 可选
为设备的所有用户设置的值。仅当
DeviceEditiable
为true
时提供。 -
UserEditable
布尔值 选填
属性是否存在 UserPolicy,是否允许修改该属性(即通过策略设置建议的属性值)。默认为
false
。 -
UserPolicy
string[] 可选
用户规范提供的属性值。
-
UserSetting
string[] 可选
由已登录用户设置的属性值。仅当
UserEditable
为true
时提供。
ManagedEthernetProperties
属性
-
身份验证
-
AutoConnect
ManagedIPConfigProperties
属性
-
网关
-
IPAddress
-
NameServers
-
RoutingPrefix
ManagedLong(可选)
-
类型
-
WebProxyAutoDiscoveryUrl
ManagedIPConfigType
属性
-
有效
IPConfigType 可选
网络配置管理器当前使用的有效值(例如 Shill)。
-
DeviceEditable
布尔值 选填
属性的 DevicePolicy 是否存在以及是否允许修改该属性(即通过政策设置建议的属性值)。默认为
false
。 -
DevicePolicy
IPConfigType 可选
设备政策提供的属性值。
-
生效日期
字符串(可选)
确定有效属性值的来源。
-
IPConfigType 可选
为设备的所有用户设置的值。仅当
DeviceEditiable
为true
时提供。 -
UserEditable
布尔值 选填
属性是否存在 UserPolicy,是否允许修改该属性(即通过策略设置建议的属性值)。默认为
false
。 -
UserPolicy
IPConfigType 可选
用户规范提供的属性值。
-
UserSetting
IPConfigType 可选
由已登录用户设置的属性值。仅当
UserEditable
为true
时提供。
ManagedLong
属性
-
有效
数字可选
网络配置管理器当前使用的有效值(例如 Shill)。
-
DeviceEditable
布尔值 选填
属性的 DevicePolicy 是否存在以及是否允许修改该属性(即通过政策设置建议的属性值)。默认为
false
。 -
DevicePolicy
数字可选
设备政策提供的属性值。
-
生效日期
字符串(可选)
确定有效属性值的来源。
-
数字可选
为设备的所有用户设置的值。仅当
DeviceEditiable
为true
时提供。 -
UserEditable
布尔值 选填
属性是否存在 UserPolicy,是否允许修改该属性(即通过策略设置建议的属性值)。默认为
false
。 -
UserPolicy
数字可选
用户规范提供的属性值。
-
UserSetting
数字可选
由已登录用户设置的属性值。仅当
UserEditable
为true
时提供。
ManagedManualProxySettings
属性
-
FTPProxy
-
HTTPProxy
-
袜子
-
SecureHTTPProxy
ManagedProperties
属性
-
移动网络
-
可连接
布尔值 选填
-
ConnectionState
-
ErrorState
字符串(可选)
-
以太网
-
GUID
string
-
IPAddressConfigType
-
IPConfigs
IPConfigProperties[] 可选
-
MacAddress
字符串(可选)
-
按流量计费Chrome 85 及更高版本
-
名称
-
NameServersConfigType
-
优先级
ManagedLong(可选)
-
ProxySettings
-
RestrictedConnectivity
布尔值 选填
-
SavedIPConfig
-
来源
字符串(可选)
-
StaticIPConfig
-
TrafficCounterResetTime
数字可选
Chrome 125 及更高版本 -
类型
-
VPN
-
WiFi
ManagedProxyLocation
属性
-
端口
ManagedProxySettings
属性
-
ExcludeDomains
-
政治行动委员会
ManagedProxySettingsType
属性
-
有效
网络配置管理器当前使用的有效值(例如 Shill)。
-
DeviceEditable
布尔值 选填
属性的 DevicePolicy 是否存在以及是否允许修改该属性(即通过政策设置建议的属性值)。默认为
false
。 -
DevicePolicy
设备政策提供的属性值。
-
生效日期
字符串(可选)
确定有效属性值的来源。
-
为设备的所有用户设置的值。仅当
DeviceEditiable
为true
时提供。 -
UserEditable
布尔值 选填
属性是否存在 UserPolicy,是否允许修改该属性(即通过策略设置建议的属性值)。默认为
false
。 -
UserPolicy
用户规范提供的属性值。
-
UserSetting
由已登录用户设置的属性值。仅当
UserEditable
为true
时提供。
ManagedThirdPartyVPNProperties
属性
-
ExtensionID
-
ProviderName
字符串(可选)
ManagedVPNProperties
属性
-
AutoConnect
-
主机
-
类型
ManagedWiFiProperties
属性
-
AllowGatewayARPPolling
-
AutoConnect
-
BSSID
字符串(可选)
-
频率
数字可选
-
FrequencyList
number[] 选填
-
HexSSID
-
HiddenSSID
-
RoamThreshold
ManagedLong(可选)
已弃用,已忽略。请参见
WiFiProperties.RoamThreshold
。 -
SSID
-
安全性
-
SignalStrength
数字可选
ManualProxySettings
属性
-
FTPProxy
FTP 代理设置。
-
HTTPProxy
HTTP 代理的设置。
-
袜子
SOCKS 代理的设置。
-
SecureHTTPProxy
安全 HTTP 代理的设置。
NetworkConfigProperties
属性
-
移动网络
-
以太网
-
GUID
字符串(可选)
-
IPAddressConfigType
IPConfigType 可选
-
名称
字符串(可选)
-
NameServersConfigType
IPConfigType 可选
-
优先级
数字可选
-
类型
NetworkType(可选)
-
VPN
-
WiFi
-
WiMAX
已弃用。
NetworkFilter
属性
-
已配置
布尔值 选填
如果为 true,则仅包含已配置(已保存)的网络。默认值为“false”。
-
限制
数字可选
要返回的网络数上限。如果未指定,则默认为 1,000。使用 0 表示无限制。
-
networkType
要返回的网络类型。
-
visible
布尔值 选填
如果为 true,则仅包含可见(物理连接或位于范围内)网络。默认值为“false”。
NetworkProperties
属性
-
移动网络
对于移动网络,移动网络属性。
-
可连接
布尔值 选填
网络是否可连接。
-
ConnectionState
网络的当前连接状态。
-
ErrorState
字符串(可选)
上次记录的网络连接错误状态。
-
以太网
对于以太网,请指以太网网络属性。
-
GUID
string
网络 GUID。
-
IPAddressConfigType
IPConfigType 可选
网络的 IP 地址配置类型。
-
IPConfigs
IPConfigProperties[] 可选
网络的 IP 配置。
-
MacAddress
字符串(可选)
网络的 MAC 地址。
-
按流量计费
布尔值 选填
Chrome 85 及更高版本网络是否按流量计费。
-
名称
字符串(可选)
方便用户使用的网络名称。
-
NameServersConfigType
IPConfigType 可选
网络使用的域名服务器的 IP 配置类型。
-
优先级
数字可选
网络优先级。
-
ProxySettings
网络的代理设置。
-
RestrictedConnectivity
布尔值 选填
对于已连接的网络,互联网连接是否受限(例如,网络位于门户后面,或移动网络未激活)。
-
SavedIPConfig
在应用静态 IP 配置之前从 DHCP 服务器收到的 IP 配置。
-
来源
字符串(可选)
指示是否配置了网络以及如何配置。可能的值包括:
Device
DevicePolicy
User
UserPolicy
None
“None”与生成扩展代码冲突,因此我们必须为“Source”使用字符串,而不是 SourceType 枚举。
-
StaticIPConfig
网络的静态 IP 配置。
-
TrafficCounterResetTime
数字可选
Chrome 125 及更高版本流量计数器上次重置的时间。
-
类型
网络类型。
-
VPN
对于 VPN 网络,则为网络 VPN 属性。
-
WiFi
对于 Wi-Fi 网络,表示网络 Wi-Fi 属性。
NetworkStateProperties
属性
-
移动网络
-
可连接
布尔值 选填
-
ConnectionState
-
ErrorState
字符串(可选)
-
以太网
-
GUID
string
-
名称
字符串(可选)
-
优先级
数字可选
-
来源
字符串(可选)
-
类型
-
VPN
-
WiFi
NetworkType
枚举
PaymentPortal
属性
-
方法
string
用于支付门户的 HTTP 方法。
-
PostData
字符串(可选)
要发送到付款门户的博文数据。除非
Method
为POST
,否则会被忽略。 -
网址
字符串(可选)
付款门户网址。
ProxyLocation
属性
-
主机
string
代理 IP 地址主机。
-
端口
number
用于代理的端口。
ProxySettings
属性
-
ExcludeDomains
string[] 可选
已排除手动代理设置的网域和主机。
-
手动
手动代理设置 - 仅用于
Manual
代理设置。 -
政治行动委员会
字符串(可选)
代理自动配置文件的网址。
-
代理设置的类型。
ProxySettingsType
枚举
"WPAD"
SIMLockStatus
属性
-
LockEnabled
boolean
是否启用 SIM 卡锁定功能。
-
LockType
string
SIM 卡锁定状态 - 可能的值为
'sim-pin'
、'sim-puk'
和''
。 -
RetriesLeft
数字可选
在需要使用 PUK 码才能解锁 SIM 卡之前,所允许的 PIN 码锁定尝试次数。
ThirdPartyVPNProperties
属性
-
ExtensionID
string
第三方 VPN 提供商扩展程序的 ID。
-
ProviderName
字符串(可选)
VPN 提供方名称。
VPNProperties
属性
-
AutoConnect
布尔值 选填
是否应自动连接 VPN 网络。
-
主机
字符串(可选)
VPN 主机。
-
类型
字符串(可选)
VPN 类型。因为“L2TP-IPSec”,所以不能是枚举类型。对于传递到 setProperties 的 NetworkConfigProperties,这是可选的。
VPNStateProperties
属性
-
类型
string
WiFiProperties
属性
-
AllowGatewayARPPolling
布尔值 选填
是否允许对默认网关进行 ARP 轮询。默认值为 true。
-
AutoConnect
布尔值 选填
是否在覆盖范围内时自动连接 Wi-Fi 网络。
-
BSSID
字符串(可选)
关联接入点的 BSSID。
-
EAP
EAPProperties(可选)
网络 EAP 属性。对于
WEP-8021X
和WPA-EAP
网络而言是必需的。 -
频率
数字可选
Wi-Fi 服务运行频率(以 MHz 为单位)。对于连接的网络,显示当前连接该网络的频率。否则为最佳可用 BSS 的频率。
-
FrequencyList
number[] 选填
包含 Wi-Fi 网络最近发现的所有运行频率。
-
HexSSID
字符串(可选)
网络 SSID 的十六进制编码副本。
-
HiddenSSID
布尔值 选填
是否广播网络 SSID。
-
口令
字符串(可选)
Chrome 66 及更高版本WEP/WPA/WPA2 连接的密码。此属性只能设置,
getProperties
返回的属性不会包含此值。 -
RoamThreshold
数字可选
已弃用,已忽略。
-
SSID
字符串(可选)
网络 SSID。
-
安全性
字符串(可选)
网络安全类型。
-
SignalStrength
数字可选
网络信号强度。
WiFiStateProperties
属性
-
BSSID
字符串(可选)
-
频率
数字可选
-
HexSSID
字符串(可选)
Chrome 62 及更高版本 -
SSID
字符串(可选)
Chrome 62 及更高版本 -
安全性
string
-
SignalStrength
数字可选
WiMAXProperties
属性
-
AutoConnect
布尔值 选填
该网络是否应该自动连接。
-
EAP
EAPProperties(可选)
网络 EAP 属性。
方法
createNetwork()
chrome.networking.onc.createNetwork(
shared: boolean,
properties: NetworkConfigProperties,
callback?: function,
)
根据媒体资源创建新的网络配置。如果匹配的已配置网络已存在,则操作将失败。否则,返回新网络的 GUID。
参数
-
boolean
如果为
true
,与其他用户共享此网络配置。此选项仅向 Chrome 网页界面提供。* 由应用调用时,
false
是唯一允许的值。 -
用于配置新网络的属性。
-
callback
函数(可选)
callback
参数如下所示:(result: string) => void
-
结果
string
-
返回
-
Promise<string>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
disableNetworkType()
chrome.networking.onc.disableNetworkType(
networkType: NetworkType,
)
停用与指定网络类型匹配的所有设备。请参阅 enableNetworkType
的备注。
参数
-
networkType
要停用的网络类型。
enableNetworkType()
chrome.networking.onc.enableNetworkType(
networkType: NetworkType,
)
启用与指定网络类型匹配的所有设备。请注意,该类型可能代表多种网络类型(例如“无线”)。
参数
-
networkType
要启用的网络类型。
forgetNetwork()
chrome.networking.onc.forgetNetwork(
networkGuid: string,
callback?: function,
)
通过清除 GUID networkGuid
的网络配置的所有属性,清除网络配置。这可能还包括具有匹配标识符(例如 WiFi SSID 和安全)的任何其他网络。如果不存在此类配置,系统将会设置错误且操作将失败。
在自助服务终端会话中,此方法不会忘记共享的网络配置。
参数
-
networkGuid
string
要删除的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:() => void
返回
-
Promise<void>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getCaptivePortalStatus()
chrome.networking.onc.getCaptivePortalStatus(
networkGuid: string,
callback?: function,
)
返回与“networkGuid”匹配的网络的强制门户状态。
参数
-
networkGuid
string
获取强制门户状态的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:(result: CaptivePortalStatus) => void
返回
-
Promise<CaptivePortalStatus>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getDeviceStates()
chrome.networking.onc.getDeviceStates(
callback?: function,
)
返回可用网络设备的状态。
参数
-
callback
函数(可选)
callback
参数如下所示:(result: DeviceStateProperties[]) => void
返回
-
Promise<DeviceStateProperties[]>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getGlobalPolicy()
chrome.networking.onc.getGlobalPolicy(
callback?: function,
)
获取全局政策属性。这些属性不会在会话期间发生变化。
参数
-
callback
函数(可选)
callback
参数如下所示:(result: GlobalPolicy) => void
-
结果
-
返回
-
Promise<GlobalPolicy>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getManagedProperties()
chrome.networking.onc.getManagedProperties(
networkGuid: string,
callback?: function,
)
从来源获取具有 ID networkGuid 的网络的合并属性:用户设置、共享设置、用户政策、设备政策和当前有效的设置。
参数
-
networkGuid
string
要获取其属性的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:(result: ManagedProperties) => void
返回
-
Promise<ManagedProperties>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getNetworks()
chrome.networking.onc.getNetworks(
filter: NetworkFilter,
callback?: function,
)
返回广告网络对象的列表,这些对象具有 getState
提供的相同属性。提供的过滤器可指定返回的网络类型并限制网络数量。系统会按优先级对网络进行排序,已连接或连接的网络排在最前面。
参数
-
filter
描述要返回的网络。
-
callback
函数(可选)
callback
参数如下所示:(result: NetworkStateProperties[]) => void
返回
-
Promise<NetworkStateProperties[]>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getProperties()
chrome.networking.onc.getProperties(
networkGuid: string,
callback?: function,
)
获取 ID 为 networkGuid 的网络的所有属性。包括网络的所有属性(只读和读/写值)。
参数
-
networkGuid
string
要获取其属性的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:(result: NetworkProperties) => void
返回
-
Promise<NetworkProperties>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
getState()
chrome.networking.onc.getState(
networkGuid: string,
callback?: function,
)
获取 ID 为 networkGuid 的网络的缓存只读属性。这意味着,该函数的性能要高于 getProperties
,后者需要往返才能查询网络子系统。系统会针对所有网络返回以下属性:GUID、类型、名称、Wi-Fi.Security。为可见网络提供了其他属性:ConnectionState、ErrorState、WiFi.SignalStrength、Cellular.NetworkTechnology、Cellular.ActivationState、Cellular.RoamingState。
参数
-
networkGuid
string
要获取其属性的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:(result: NetworkStateProperties) => void
返回
-
Promise<NetworkStateProperties>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
requestNetworkScan()
chrome.networking.onc.requestNetworkScan(
networkType?: NetworkType,
)
请求网络子系统扫描新网络并更新 getVisibleNetworks
返回的列表。这只是一个请求:网络子系统可以选择忽略它。如果列表更新,则会触发 onNetworkListChanged
事件。
参数
-
networkType
NetworkType(可选)
Chrome 63 及更高版本如果提供,则会请求特定于该类型的扫描。对于移动网络,系统将请求移动网络扫描(如果支持)。
setProperties()
chrome.networking.onc.setProperties(
networkGuid: string,
properties: NetworkConfigProperties,
callback?: function,
)
设置 ID 为 networkGuid
的网络的属性。这仅对已配置的网络有效(来源 != 无)。未配置的可见网络应改用 createNetwork
。在自助服务终端会话中,无法通过共享网络调用此方法。
参数
-
networkGuid
string
要为其设置属性的网络的 GUID。
-
要设置的属性。
-
callback
函数(可选)
callback
参数如下所示:() => void
返回
-
Promise<void>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
startConnect()
chrome.networking.onc.startConnect(
networkGuid: string,
callback?: function,
)
使用 networkGuid 开始连接到网络。
参数
-
networkGuid
string
要连接的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:() => void
返回
-
Promise<void>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
startDisconnect()
chrome.networking.onc.startDisconnect(
networkGuid: string,
callback?: function,
)
使用 networkGuid 开始断开与网络的连接。
参数
-
networkGuid
string
要断开连接的网络的 GUID。
-
callback
函数(可选)
callback
参数如下所示:() => void
返回
-
Promise<void>
Chrome 125 及更高版本只有 Manifest V3 及更高版本支持 Promise,其他平台需要使用回调。
活动
onDeviceStateListChanged
chrome.networking.onc.onDeviceStateListChanged.addListener(
callback: function,
)
在设备列表发生变化或任何设备状态属性发生变化时触发。
参数
-
callback
功能
callback
参数如下所示:() => void
onNetworkListChanged
chrome.networking.onc.onNetworkListChanged.addListener(
callback: function,
)
在网络列表发生更改时触发。发送当前所有网络的 GUID 的完整列表。
参数
-
callback
功能
callback
参数如下所示:(changes: string[]) => void
-
更改
字符串[]
-
onNetworksChanged
chrome.networking.onc.onNetworksChanged.addListener(
callback: function,
)
当任意网络上的属性发生变化时触发。针对属性已更改的网络,发送 GUID 列表。
参数
-
callback
功能
callback
参数如下所示:(changes: string[]) => void
-
更改
字符串[]
-
onPortalDetectionCompleted
chrome.networking.onc.onPortalDetectionCompleted.addListener(
callback: function,
)
在完成网络的门户检测时触发。发送网络的 GUID 以及相应的强制门户状态。
参数
-
callback
功能
callback
参数如下所示:(networkGuid: string, status: CaptivePortalStatus) => void
-
networkGuid
string
-
status
-