chrome.networking.onc

说明

chrome.networking.onc API 用于配置网络连接（移动网络、以太网、VPN 或 Wi-Fi）。此 API 适用于自动启动的 ChromeOS 自助服务终端会话。

网络连接配置是按照 Open Network Configuration (ONC) 规范指定的。

注意：大多数字典属性和枚举值使用 UpperCamelCase 命名法，以符合 ONC 规范，而不是使用 JavaScript 的 lowerCamelCase 惯例。

权限

networking.onc

可用性

Chrome 59 及更高版本 仅限 ChromeOS

类型

ActivationStateType

枚举

“已启用”

“正在激活”

“NotActivated”

“PartiallyActivated”

CaptivePortalStatus

枚举

“Unknown”

“离线”

“在线”

“Portal”

"ProxyAuthRequired"

CellularProperties

属性

  • ActivationState

    ActivationStateType（可选）

    运营商账号激活状态。

  • ActivationType

    字符串（选填）

    移动网络激活类型。

  • AllowRoaming

    布尔值（可选）

    是否允许在该影音平台上进行漫游。

  • AutoConnect

    布尔值（可选）

    是否应自动连接到移动网络（在覆盖范围内）。

  • 家庭

    字符串（选填）

    移动设备技术系列 - CDMA 或 GSM。

  • FirmwareRevision

    字符串（选填）

    加载到移动网络调制解调器中的固件修订版。

  • FoundNetworks

    FoundNetworkProperties[] 可选

    在最近一次网络扫描期间发现的网络列表。

  • HardwareRevision

    字符串（选填）

    移动网络调制解调器硬件修订版本。

  • HomeProvider

    CellularProviderProperties（可选）

    关于目前安装在调制解调器中的 SIM 卡的发卡运营商的信息。

  • 制造商

    字符串（选填）

    移动网络调制解调器制造商。

  • ModelID

    字符串（选填）

    移动网络调制解调器型号 ID。

  • NetworkTechnology

    字符串（选填）

    如果调制解调器已注册到某个网络，则为当前使用的网络技术。

  • PaymentPortal

    PaymentPortal（付款门户）可选

    用户可用于订阅或修改移动流量套餐的在线付款门户。

  • RoamingState

    字符串（选填）

    当前网络上移动网络调制解调器的漫游状态。

  • SIMLockStatus

    SIMLockStatus（可选）

    GSM 家庭网络的 SIM 卡锁定状态。

  • SIMPresent

    布尔值（可选）

    SIM 卡是否存在。

  • 扫描

    布尔值（可选）

    Chrome 63 及更高版本

    如果正在进行移动网络扫描，则为 true。

  • ServingOperator

    CellularProviderProperties（可选）

    有关调制解调器当前注册在哪个运营商网络上的信息。

  • SignalStrength

    number 可选

    当前的网络信号强度。

  • SupportNetworkScan

    布尔值（可选）

    移动网络是否支持扫描。

CellularProviderProperties

属性

  • 代码

    字符串

    移动网络 ID 是网络的 MCC（移动设备国家/地区代码）和 MNC（移动网络代码）的简单串联。

  • 国家/地区

    字符串（选填）

    双字母国家/地区代码。

  • 名称

    字符串

    运营商名称。

CellularStateProperties

属性

CertificatePattern

属性

  • EnrollmentURI

    string[] 可选

    如果未找到与此模式匹配的证书，可将用户定向到的 URI 列表。

  • 颁发者

    IssuerSubjectPattern（可选）

    如果设置，则表示与 X.509 颁发者设置进行匹配的模式。

  • IssuerCARef

    string[] 可选

    证书颁发机构 CA 证书的列表。证书必须由其中一个签署，才能与此模式匹配。

  • 主题

    IssuerSubjectPattern（可选）

    如果设置，则表示与 X.509 正文设置进行匹配的模式。

ClientCertificateType

枚举

“Ref”

“Pattern”

ConnectionStateType

枚举

“已连接”

“正在连接”

“NotConnected”

DeviceStateProperties

属性

  • SIMLockStatus

    SIMLockStatus（可选）

    Chrome 62 及更高版本

    如果 Type = Cellular 且 SIMPresent = True，则为 SIM 卡锁定状态。

  • SIMPresent

    布尔值（可选）

    Chrome 62 及更高版本

    如果设备类型为“移动网络”，则设置为 SIM 卡已装入状态。

  • 扫描

    布尔值（可选）

    设置设备是否已启用。如果设备当前正在扫描，则为 true。

  • 设备的当前状态。

  • 类型

    NetworkType

    与设备关联的网络类型（移动网络、以太网或 Wi-Fi）。

DeviceStateType

枚举

“未初始化”
设备可用，但未初始化。

“已停用”
设备已初始化，但未启用。

“正在启用”
已请求启用状态，但尚未完成。

“已启用”
设备已启用。

“禁止”
设备被禁止。

EAPProperties

属性

  • AnonymousIdentity

    字符串（选填）

  • ClientCertPKCS11Id

    字符串（选填）

    Chrome 60 及更高版本
  • ClientCertPattern

    CertificatePattern（可选）

  • ClientCertProvisioningProfileId

    字符串（选填）

    Chrome 93 及更高版本
  • ClientCertRef

    字符串（选填）

  • ClientCertType

    ClientCertificateType

  • 身份

    字符串（选填）

  • 内连接

    字符串（选填）

  • 外连接

    字符串（选填）

    外部 EAP 类型。由 ONC 要求提供，但在从 Shill 进行转换时可能无法提供。

  • 密码

    字符串（选填）

  • SaveCredentials

    布尔值（可选）

  • ServerCAPEMs

    string[] 可选

  • ServerCARefs

    string[] 可选

  • SubjectMatch

    ManagedDOMString（可选）

    Chrome 60 及更高版本
  • UseProactiveKeyCaching

    布尔值（可选）

  • UseSystemCAs

    布尔值（可选）

EthernetProperties

属性

  • 身份验证

    字符串（选填）

    以太网络使用的身份验证。可能的值有 None 和 8021X。

  • AutoConnect

    布尔值（可选）

    是否应自动连接以太网络。

  • EAP

    EAPProperties（可选）

    网络的 EAP 设置。8021X 身份验证需要此参数。

EthernetStateProperties

属性

FoundNetworkProperties

属性

  • LongName

    字符串（选填）

    网络运营商的长格式名称。

  • NetworkId

    字符串

    广告网络 ID。

  • ShortName

    字符串（选填）

    网络运营商的简短格式名称。

  • 状态

    字符串

    网络可用性。

  • 技术

    字符串

    网络使用的访问技术。

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

    number 可选

    路由前缀。

  • SearchDomains

    string[] 可选

    Chrome 76 及更高版本

    用于名称解析的字符串数组，如需了解详情，请参阅 onc_spec.md。

  • 类型

    字符串（选填）

    IP 配置类型。可以是 IPv4 或 IPv6。

  • WebProxyAutoDiscoveryUrl

    字符串（选填）

    通过 DHCP 报告的网络代理自动发现的网址。

IPConfigType

枚举

“DHCP”

“Static”

IssuerSubjectPattern

属性

  • CommonName

    字符串（选填）

    如果设置，则为与证书正文的公用名进行匹配的值。

  • 市行政区

    字符串（选填）

    如果设置，则为与证书正文的常用位置进行匹配的值。

  • 组织

    字符串（选填）

    如果设置，则为与证书正文的组织进行匹配的值。至少有一个组织应与该值匹配。

  • OrganizationalUnit

    字符串（选填）

    如果设置，则是用于与证书正文的组织部门进行匹配的值。至少有一个组织部门应与该值匹配。

ManagedBoolean

属性

  • 有效

    布尔值（可选）

    网络配置管理器（例如 Shill）当前使用的有效值。

  • DeviceEditable

    布尔值（可选）

    是否存在适用于该媒体资源的 DevicePolicy 且允许修改该媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • DevicePolicy

    布尔值（可选）

    设备政策提供的属性值。

  • 生效日期

    字符串（选填）

    用于确定有效媒体资源价值的来源。

  • SharedSetting

    布尔值（可选）

    为设备的所有用户设置的值。仅当 DeviceEditiable 为 true 时才提供。

  • UserEditable

    布尔值（可选）

    媒体资源是否存在 UserPolicy 且允许修改媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • UserPolicy

    布尔值（可选）

    用户政策提供的属性值。

  • UserSetting

    布尔值（可选）

    由已登录用户设置的属性值。仅当 UserEditable 为 true 时才提供。

ManagedCellularProperties

属性

ManagedDOMString

属性

  • 有效

    字符串（选填）

    网络配置管理器（例如 Shill）当前使用的有效值。

  • DeviceEditable

    布尔值（可选）

    是否存在适用于该媒体资源的 DevicePolicy 且允许修改该媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • DevicePolicy

    字符串（选填）

    设备政策提供的属性值。

  • 生效日期

    字符串（选填）

    用于确定有效媒体资源价值的来源。

  • SharedSetting

    字符串（选填）

    为设备的所有用户设置的值。仅当 DeviceEditiable 为 true 时才提供。

  • UserEditable

    布尔值（可选）

    媒体资源是否存在 UserPolicy 且允许修改媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • UserPolicy

    字符串（选填）

    用户政策提供的属性值。

  • UserSetting

    字符串（选填）

    由已登录用户设置的属性值。仅当 UserEditable 为 true 时才提供。

ManagedDOMStringList

属性

  • 有效

    string[] 可选

    网络配置管理器（例如 Shill）当前使用的有效值。

  • DeviceEditable

    布尔值（可选）

    是否存在适用于该媒体资源的 DevicePolicy 且允许修改该媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • DevicePolicy

    string[] 可选

    设备政策提供的属性值。

  • 生效日期

    字符串（选填）

    用于确定有效媒体资源价值的来源。

  • SharedSetting

    string[] 可选

    为设备的所有用户设置的值。仅当 DeviceEditiable 为 true 时才提供。

  • UserEditable

    布尔值（可选）

    媒体资源是否存在 UserPolicy 且允许修改媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • UserPolicy

    string[] 可选

    用户政策提供的属性值。

  • UserSetting

    string[] 可选

    由已登录用户设置的属性值。仅当 UserEditable 为 true 时才提供。

ManagedEthernetProperties

属性

ManagedIPConfigProperties

属性

ManagedIPConfigType

属性

  • 有效

    IPConfigType（可选）

    网络配置管理器（例如 Shill）当前使用的有效值。

  • DeviceEditable

    布尔值（可选）

    是否存在适用于该媒体资源的 DevicePolicy 且允许修改该媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • DevicePolicy

    IPConfigType（可选）

    设备政策提供的属性值。

  • 生效日期

    字符串（选填）

    用于确定有效媒体资源价值的来源。

  • SharedSetting

    IPConfigType（可选）

    为设备的所有用户设置的值。仅当 DeviceEditiable 为 true 时才提供。

  • UserEditable

    布尔值（可选）

    媒体资源是否存在 UserPolicy 且允许修改媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • UserPolicy

    IPConfigType（可选）

    用户政策提供的属性值。

  • UserSetting

    IPConfigType（可选）

    由已登录用户设置的属性值。仅当 UserEditable 为 true 时才提供。

ManagedLong

属性

  • 有效

    number 可选

    网络配置管理器（例如 Shill）当前使用的有效值。

  • DeviceEditable

    布尔值（可选）

    是否存在适用于该媒体资源的 DevicePolicy 且允许修改该媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • DevicePolicy

    number 可选

    设备政策提供的属性值。

  • 生效日期

    字符串（选填）

    用于确定有效媒体资源价值的来源。

  • SharedSetting

    number 可选

    为设备的所有用户设置的值。仅当 DeviceEditiable 为 true 时才提供。

  • UserEditable

    布尔值（可选）

    媒体资源是否存在 UserPolicy 且允许修改媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • UserPolicy

    number 可选

    用户政策提供的属性值。

  • UserSetting

    number 可选

    由已登录用户设置的属性值。仅当 UserEditable 为 true 时才提供。

ManagedManualProxySettings

属性

ManagedProperties

属性

ManagedProxyLocation

属性

ManagedProxySettings

属性

ManagedProxySettingsType

属性

  • 有效

    ProxySettingsType（可选）

    网络配置管理器（例如 Shill）当前使用的有效值。

  • DeviceEditable

    布尔值（可选）

    是否存在适用于该媒体资源的 DevicePolicy 且允许修改该媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • DevicePolicy

    ProxySettingsType（可选）

    设备政策提供的属性值。

  • 生效日期

    字符串（选填）

    用于确定有效媒体资源价值的来源。

  • SharedSetting

    ProxySettingsType（可选）

    为设备的所有用户设置的值。仅当 DeviceEditiable 为 true 时才提供。

  • UserEditable

    布尔值（可选）

    媒体资源是否存在 UserPolicy 且允许修改媒体资源（即政策设置了建议的媒体资源值）。默认为 false。

  • UserPolicy

    ProxySettingsType（可选）

    用户政策提供的属性值。

  • UserSetting

    ProxySettingsType（可选）

    由已登录用户设置的属性值。仅当 UserEditable 为 true 时才提供。

ManagedThirdPartyVPNProperties

属性

ManagedVPNProperties

属性

ManagedWiFiProperties

属性

ManualProxySettings

属性

NetworkConfigProperties

属性

NetworkFilter

属性

  • 已配置

    布尔值（可选）

    如果为 true，则仅包含已配置（已保存）的网络。默认为“false”。

  • 限制

    number 可选

    要返回的影音平台数量上限。如果未指定，则默认为 1000。使用 0 表示不设限。

  • networkType

    NetworkType

    要返回的网络类型。

  • 可见

    布尔值（可选）

    如果为 true，则仅包含可见的网络（已实际连接或在范围内）。默认为“false”。

NetworkProperties

属性

  • 移动网络

    CellularProperties（可选）

    对于移动网络，请使用移动网络属性。

  • 可连接

    布尔值（可选）

    网络是否可连接。

  • ConnectionState

    ConnectionStateType（连接状态类型）可选

    网络的当前连接状态。

  • ErrorState

    字符串（选填）

    上次记录的网络错误状态。

  • 以太网

    EthernetProperties（可选）

    对于以太网，则为以太网网络属性。

  • GUID

    字符串

    影音平台 GUID。

  • IPAddressConfigType

    IPConfigType（可选）

    网络的 IP 地址配置类型。

  • IPConfigs

    IPConfigProperties[] 可选

    网络的 IP 配置。

  • MacAddress

    字符串（选填）

    网络的 MAC 地址。

  • 按流量计费

    布尔值（可选）

    Chrome 85 及更高版本

    网络是否按流量计费。

  • 名称

    字符串（选填）

    简单易懂的广告联盟名称。

  • NameServersConfigType

    IPConfigType（可选）

    网络使用的域名服务器的 IP 配置类型。

  • 优先级

    number 可选

    网络优先级。

  • ProxySettings

    ProxySettings（可选）

    广告联盟的代理设置。

  • RestrictedConnectivity

    布尔值（可选）

    对于已连接的网络，网络与互联网的连接是否受限，例如，网络是否位于门户后面，或移动网络是否未激活。

  • SavedIPConfig

    IPConfigProperties（可选）

    在应用静态 IP 配置之前从 DHCP 服务器收到的 IP 配置。

  • 来源

    字符串（选填）

    指示网络是否已配置以及配置方式。可能的值包括：

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    “None”与扩展程序代码生成冲突，因此我们必须使用字符串“Source”，而不是 SourceType 枚举。

  • StaticIPConfig

    IPConfigProperties（可选）

    网络的静态 IP 配置。

  • TrafficCounterResetTime

    number 可选

    Chrome 125 及更高版本

    上次重置流量计数器的时间。

  • 类型

    NetworkType

    网络类型。

  • VPN

    VPNProperties（可选）

    对于 VPN 网络，请使用网络 VPN 属性。

  • Wi-Fi

    WiFiProperties（可选）

    对于 Wi-Fi 网络，请使用网络 Wi-Fi 属性。

NetworkStateProperties

属性

NetworkType

枚举

“全部”

“移动网络”

“Ethernet”

“网络共享”

“VPN”

“无线”

“Wi-Fi”

PaymentPortal

属性

  • 方法

    字符串

    要用于付款门户的 HTTP 方法。

  • PostData

    字符串（选填）

    要发送到付款门户的 POST 数据。除非 Method 为 POST，否则会被忽略。

  • 网址

    字符串（选填）

    付款门户网址。

ProxyLocation

属性

  • 主机

    字符串

    代理 IP 地址主机。

  • 端口

    数值

    代理使用的端口。

ProxySettings

属性

  • ExcludeDomains

    string[] 可选

    要排除手动代理设置的网域和主机。

  • 手动

    ManualProxySettings（可选）

    手动代理设置 - 仅适用于 Manual 代理设置。

  • 政治行动委员会

    字符串（选填）

    代理自动配置文件的网址。

  • 代理设置的类型。

ProxySettingsType

枚举

“直接”

“手动”

"PAC"

"WPAD"

SIMLockStatus

属性

  • LockEnabled

    布尔值

    SIM 卡锁定功能是否处于启用状态。

  • LockType

    字符串

    SIM 卡锁定的状态 - 可能的值包括 'sim-pin'、'sim-puk' 和 ''。

  • RetriesLeft

    number 可选

    在需要使用 PUK 码解锁 SIM 卡之前允许的 PIN 码锁定尝试次数。

ThirdPartyVPNProperties

属性

  • ExtensionID

    字符串

    第三方 VPN 提供商扩展程序的 ID。

  • ProviderName

    字符串（选填）

    VPN 提供商名称。

VPNProperties

属性

  • AutoConnect

    布尔值（可选）

    是否应自动连接 VPN 网络。

  • 主机

    字符串（选填）

    VPN 主机。

  • 类型

    字符串（选填）

    VPN 类型。由于存在“L2TP-IPSec”，因此这不能是枚举。对于 NetworkConfigProperties，此属性是可选的，会传递给 setProperties，后者可能仅用于设置特定属性。

VPNStateProperties

属性

WiFiProperties

属性

  • AllowGatewayARPPolling

    布尔值（可选）

    从 Chrome 131 开始已废弃

    已在 M131 中移除。目前没有正在进行的 ARP 轮询。

  • AutoConnect

    布尔值（可选）

    是否应在 Wi-Fi 网络范围内自动连接。

  • BSSID

    字符串（选填）

    关联的接入点的 BSSID。

  • EAP

    EAPProperties（可选）

    网络 EAP 属性。WEP-8021X 和 WPA-EAP 网络必需。

  • 频率

    number 可选

    Wi-Fi 服务的运行频率（以 MHz 为单位）。对于已连接的网络，则为网络当前的连接频率。否则，则为可用的最佳 BSS 的频率。

  • FrequencyList

    number[] 可选

    包含最近看到的 WiFi 网络的所有运行频率。

  • HexSSID

    字符串（选填）

    网络 SSID 的十六进制编码副本。

  • HiddenSSID

    布尔值（可选）

    网络 SSID 是否会广播。

  • 口令

    字符串（选填）

    Chrome 66 及更高版本

    WEP/WPA/WPA2 连接的密码。此属性只能设置 - getProperties 返回的属性不会包含此值。

  • RoamThreshold

    number 可选

    已废弃，会被忽略。

  • SSID

    字符串（选填）

    网络 SSID。

  • 安全

    字符串（选填）

    网络安全类型。

  • SignalStrength

    number 可选

    网络信号强度。

WiFiStateProperties

属性

WiMAXProperties

属性

  • AutoConnect

    布尔值（可选）

    是否应自动连接到网络。

  • EAP

    EAPProperties（可选）

    网络 EAP 属性。

方法

createNetwork()

prometido 
chrome.networking.onc.createNetwork(
  shared: boolean,
  properties: NetworkConfigProperties,
  callback?: function,
)

根据媒体资源创建新的网络配置。如果已存在匹配的已配置网络，则此操作将失败。否则，返回新网络的 GUID。

参数

  • 共享

    布尔值

    如果为 true，请与其他用户共享此网络配置。

    此选项仅向 Chrome 的 Web 界面公开。* 由应用调用时，false 是唯一允许的值。

  • 用于配置新网络的属性。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: string) => void

    • 结果

      字符串

返回

  • Promise<string>

    Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

disableNetworkType()

chrome.networking.onc.disableNetworkType(
  networkType: NetworkType,
)

停用与指定网络类型匹配的所有设备。请参阅 enableNetworkType 的备注。

参数

enableNetworkType()

chrome.networking.onc.enableNetworkType(
  networkType: NetworkType,
)

启用与指定网络类型匹配的所有设备。请注意，此类型可能代表多种网络类型（例如“无线”）。

参数

forgetNetwork()

prometido 
chrome.networking.onc.forgetNetwork(
  networkGuid: string,
  callback?: function,
)

通过清除 GUID 为 networkGuid 的网络配置的所有配置属性来忘记网络配置。这可能还包括具有匹配标识符（例如 Wi-Fi SSID 和安全性）的任何其他网络。如果不存在此类配置，系统会设置错误，并且操作将失败。

在自助服务终端会话中，此方法无法清除共享网络配置。

参数

  • networkGuid

    字符串

    要取消保存的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getCaptivePortalStatus()

prometido 
chrome.networking.onc.getCaptivePortalStatus(
  networkGuid: string,
  callback?: function,
)

返回与“networkGuid”匹配的网络的强制门户状态。

参数

  • networkGuid

    字符串

    要获取其强制门户状态的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: CaptivePortalStatus) => void

返回

  • Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getDeviceStates()

prometido 
chrome.networking.onc.getDeviceStates(
  callback?: function,
)

返回可用网络设备的状态。

参数

返回

  • Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getGlobalPolicy()

prometido 
chrome.networking.onc.getGlobalPolicy(
  callback?: function,
)

获取全局政策属性。这些属性在会话期间不应发生变化。

参数

返回

  • Promise<GlobalPolicy>

    Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getManagedProperties()

prometido 
chrome.networking.onc.getManagedProperties(
  networkGuid: string,
  callback?: function,
)

从以下来源获取 ID 为 networkGuid 的网络的已合并属性：用户设置、共享设置、用户政策、设备政策和当前有效的设置。

参数

  • networkGuid

    字符串

    要获取房源的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: ManagedProperties) => void

返回

  • Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getNetworks()

prometido 
chrome.networking.onc.getNetworks(
  filter: NetworkFilter,
  callback?: function,
)

返回具有 getState 提供的相同属性的网络对象列表。您可以使用过滤条件指定返回的网络类型并限制网络数量。系统会根据优先级对网络进行排序，已连接或正在连接的网络会列在前面。

参数

返回

  • Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getProperties()

prometido 
chrome.networking.onc.getProperties(
  networkGuid: string,
  callback?: function,
)

获取 ID 为 networkGuid 的网络的所有属性。包含网络的所有属性（只读值和读写值）。

参数

  • networkGuid

    字符串

    要获取房源的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: NetworkProperties) => void

返回

  • Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getState()

prometido 
chrome.networking.onc.getState(
  networkGuid: string,
  callback?: function,
)

获取 ID 为 networkGuid 的广告联盟的缓存只读属性。此函数的性能应高于 getProperties，后者需要进行往返查询网络子系统。系统会针对所有网络返回以下属性：GUID、类型、名称、WiFi.Security。系统会为可见网络提供其他属性：ConnectionState、ErrorState、WiFi.SignalStrength、Cellular.NetworkTechnology、Cellular.ActivationState、Cellular.RoamingState。

参数

返回

  • Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

requestNetworkScan()

chrome.networking.onc.requestNetworkScan(
  networkType?: NetworkType,
)

请求网络子系统扫描新的网络并更新 getVisibleNetworks 返回的列表。这只是一个请求：网络子系统可以选择忽略它。如果列表发生更新，系统会触发 onNetworkListChanged 事件。

参数

  • networkType

    NetworkType（网络类型）可选

    Chrome 63 及更高版本

    如果提供，则请求针对该类型进行扫描。对于移动网络，系统会请求进行移动网络扫描（如果受支持）。

setProperties()

prometido 
chrome.networking.onc.setProperties(
  networkGuid: string,
  properties: NetworkConfigProperties,
  callback?: function,
)

设置 ID 为 networkGuid 的网络的属性。此参数仅适用于已配置的网络（Source != None）。未配置的可见网络应改用 createNetwork。在自助服务终端会话中，在共享网络上调用此方法将会失败。

参数

  • networkGuid

    字符串

    要为其设置属性的网络的 GUID。

  • 要设置的属性。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

startConnect()

prometido 
chrome.networking.onc.startConnect(
  networkGuid: string,
  callback?: function,
)

使用 networkGuid 开始与网络的连接。

参数

  • networkGuid

    字符串

    要连接的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    Chrome 125 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

startDisconnect()

prometido 
chrome.networking.onc.startDisconnect(
  networkGuid: string,
  callback?: function,
)

使用 networkGuid 开始断开网络连接。

参数

  • networkGuid

    字符串

    要断开连接的网络的 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 和相应的强制门户状态。

参数