chrome.networking.onc

说明

chrome.networking.onc API 用于配置网络连接（移动网络、以太网、VPN 或 Wi-Fi）。此 API 可在自动启动的 Chrome 操作系统自助服务终端会话中使用。

网络连接配置是根据开放网络配置 (ONC) 规范指定的。

注意：大多数字典属性和枚举值都使用 UpperCamelCase（大写驼峰式命名法）来匹配 ONC 规范，而不是 JavaScript 小写驼峰式大小写惯例。

权限

networking.onc

可用性

Chrome 59 及更高版本 仅限 ChromeOS

类型

ActivationStateType

枚举

“已激活”

“正在激活”

“未激活”

“部分激活”

CaptivePortalStatus

枚举

“未知”

“离线”

“在线”

“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

    编号（选填）

    当前网络信号强度。

  • SupportNetworkScan

    布尔值（可选）

    移动网络是否支持扫描。

CellularProviderProperties

属性

  • 代码

    字符串

    移动网络 ID，作为网络的 MCC（移动设备国家/地区代码）和 MNC（移动网络代码）的简单连接。

  • 国家/地区

    字符串（可选）

    由两个字母组成的国家/地区代码。

  • 名称

    字符串

    运营商名称。

CellularStateProperties

属性

CertificatePattern

属性

  • EnrollmentURI

    string[] 选填

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

  • 颁发者

    IssuerSubjectPattern（可选）

    如果设置了此字段，应与其匹配 X.509 颁发者设置。

  • IssuerCARef

    string[] 选填

    证书颁发者 CA 证书列表。证书必须由其中某一方签署才能匹配此格式。

  • 主题

    IssuerSubjectPattern（可选）

    如果设置了此字段，应与其匹配 X.509 主题设置。

ClientCertificateType

枚举

“Ref”

“图案”

ConnectionStateType

枚举

“已连接”

“正在连接”

“NotConnected”

DeviceStateProperties

属性

  • SIMLockStatus

    SIMLockStatus（可选）

    Chrome 62 及更高版本

    如果类型 = 移动网络且 SIMPresent = True，则为 SIM 卡锁定状态。

  • SIMPresent

    布尔值（可选）

    Chrome 62 及更高版本

    如果设备类型为移动网络，则设置为 SIM 卡存在状态。

  • 扫描

    布尔值（可选）

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

  • 设备的当前状态。

  • 类型

    NetworkType

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

DeviceStateType

枚举

"Uninitialized"
设备可用，但未初始化。

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

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

"已启用"
设备已启用。

“禁止”
禁止使用设备。

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

    编号（选填）

    路由前缀。

  • SearchDomains

    string[] 选填

    Chrome 76 及更高版本

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

  • 类型

    字符串（可选）

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

  • WebProxyAutoDiscoveryUrl

    字符串（可选）

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

IPConfigType

枚举

“DHCP”

“静态”

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

属性

  • 有效

    编号（选填）

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

  • DeviceEditable

    布尔值（可选）

    属性是否存在 DevicePolicy，并允许对属性进行修改（即策略设置建议的属性值）。默认为 false。

  • DevicePolicy

    编号（选填）

    设备政策提供的属性值。

  • 生效日期

    字符串（可选）

    确定有效属性值的来源。

  • SharedSetting

    编号（选填）

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

  • UserEditable

    布尔值（可选）

    属性是否存在 UserPolicy 并允许对属性进行修改（即政策设置了建议的属性值）。默认为 false。

  • UserPolicy

    编号（选填）

    用户政策提供的属性值。

  • UserSetting

    编号（选填）

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

ManagedManualProxySettings

属性

ManagedProperties

属性

ManagedProxyLocation

属性

ManagedProxySettings

属性

ManagedProxySettingsType

属性

  • 有效

    ProxySettingsType optional

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

  • DeviceEditable

    布尔值（可选）

    属性是否存在 DevicePolicy，并允许对属性进行修改（即策略设置建议的属性值）。默认为 false。

  • DevicePolicy

    ProxySettingsType optional

    设备政策提供的属性值。

  • 生效日期

    字符串（可选）

    确定有效属性值的来源。

  • SharedSetting

    ProxySettingsType optional

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

  • UserEditable

    布尔值（可选）

    属性是否存在 UserPolicy 并允许对属性进行修改（即政策设置了建议的属性值）。默认为 false。

  • UserPolicy

    ProxySettingsType optional

    用户政策提供的属性值。

  • UserSetting

    ProxySettingsType optional

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

ManagedThirdPartyVPNProperties

属性

ManagedVPNProperties

属性

ManagedWiFiProperties

属性

ManualProxySettings

属性

NetworkConfigProperties

属性

NetworkFilter

属性

  • 已配置

    布尔值（可选）

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

  • 限制

    编号（选填）

    要返回的广告网络数量上限。如果未指定，则默认为 1000。使用 0 表示无限制。

  • networkType

    NetworkType

    要返回的广告网络的类型。

  • 可见

    布尔值（可选）

    如果为 true，则仅包含可见（物理连接或范围内）网络。默认值为“false”。

NetworkProperties

属性

  • 移动网络

    CellularProperties 可选

    对于移动网络，移动网络属性。

  • 可连接

    布尔值（可选）

    网络是否可连接。

  • ConnectionState

    ConnectionStateType optional

    网络的当前连接状态。

  • ErrorState

    字符串（可选）

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

  • 以太网

    EthernetProperties 可选

    对于以太网，这是指以太网网络属性。

  • GUID

    字符串

    网络 GUID。

  • IPAddressConfigType

    IPConfigType 可选

    网络的 IP 地址配置类型。

  • IPConfigs

    IPConfigProperties[] 可选

    网络的 IP 配置。

  • MacAddress

    字符串（可选）

    网络的 MAC 地址。

  • 按流量计费

    布尔值（可选）

    Chrome 85 及更高版本

    网络是否按流量计费。

  • 名称

    字符串（可选）

    方便用户使用的网络名称。

  • NameServersConfigType

    IPConfigType 可选

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

  • 优先级

    编号（选填）

    广告联盟优先级。

  • ProxySettings

    ProxySettings 可选

    网络的代理设置。

  • RestrictedConnectivity

    布尔值（可选）

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

  • SavedIPConfig

    IPConfigProperties 可选

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

  • 来源

    字符串（可选）

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

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

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

  • StaticIPConfig

    IPConfigProperties 可选

    网络的静态 IP 配置。

  • TrafficCounterResetTime

    编号（选填）

    Chrome 125 及更高版本

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

  • 类型

    NetworkType

    网络类型。

  • VPN

    VPNProperties（可选）

    对于 VPN 网络，指网络 VPN 属性。

  • Wi-Fi

    WiFiProperties 选填

    对于 Wi-Fi 网络，指网络 Wi-Fi 属性。

NetworkStateProperties

属性

NetworkType

枚举

“全部”

“移动网络”

“以太网”

“网络共享”

“VPN”

“无线”

“Wi-Fi”

PaymentPortal

属性

  • 方法

    字符串

    用于付款门户的 HTTP 方法。

  • PostData

    字符串（可选）

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

  • 网址

    字符串（可选）

    付款门户网址。

ProxyLocation

属性

  • 主机

    字符串

    代理 IP 地址主机。

  • 端口

    number

    要用于代理的端口。

ProxySettings

属性

  • ExcludeDomains

    string[] 选填

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

  • 手动

    ManualProxySettings 可选

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

  • 政治行动委员会

    字符串（可选）

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

  • 代理设置的类型。

ProxySettingsType

枚举

“直接”

“手动”

“PAC”

“WPAD”

SIMLockStatus

属性

  • LockEnabled

    布尔值

    是否启用了 SIM 卡锁定功能。

  • LockType

    字符串

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

  • RetriesLeft

    编号（选填）

    要求在输入 PUK 码之前允许尝试 PIN 码的次数，才能解锁 SIM 卡。

ThirdPartyVPNProperties

属性

  • ExtensionID

    字符串

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

  • ProviderName

    字符串（可选）

    VPN 提供方名称。

VPNProperties

属性

  • AutoConnect

    布尔值（可选）

    是否应自动连接 VPN 网络。

  • 主机

    字符串（可选）

    VPN 主机。

  • 类型

    字符串（可选）

    VPN 类型。由于“L2TP-IPSec”，此字段不能为枚举值。对于传递给 setProperties 的 NetworkConfigProperties 来说，这是可选操作，setProperties 可用于仅设置特定属性。

VPNStateProperties

属性

WiFiProperties

属性

  • AllowGatewayARPPolling

    布尔值（可选）

    是否允许默认网关的 ARP 轮询。默认值为 true。

  • AutoConnect

    布尔值（可选）

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

  • BSSID

    字符串（可选）

    关联接入点的 BSSID。

  • EAP

    EAPProperties 可选

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

  • 频率

    编号（选填）

    WLAN 服务工作频率（以 MHz 为单位）。对于已连接的网络，表示网络的当前连接频率。否则，最佳可用 BSS 的频率。

  • FrequencyList

    number[]（选填）

    包含 Wi-Fi 网络最近出现的所有工作频率。

  • HexSSID

    字符串（可选）

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

  • HiddenSSID

    布尔值（可选）

    是否广播网络 SSID。

  • 口令

    字符串（可选）

    Chrome 66 及更高版本

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

  • RoamThreshold

    编号（选填）

    已弃用，已忽略。

  • SSID

    字符串（可选）

    网络 SSID。

  • 安全

    字符串（可选）

    网络安全类型。

  • SignalStrength

    编号（选填）

    网络信号强度。

WiFiStateProperties

属性

WiMAXProperties

属性

  • AutoConnect

    布尔值（可选）

    是否应自动连接网络。

  • EAP

    EAPProperties 可选

    网络 EAP 属性。

方法

createNetwork()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.createNetwork(
  shared: boolean,
  properties: NetworkConfigProperties,
  callback?: function,
)

通过属性创建新的网络配置。如果已存在匹配的已配置网络，则该操作将失败。否则，返回新网络的 GUID。

参数

  • 共享

    布尔值

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

    此选项仅向 Chrome 网页界面提供。*被应用调用时，false 是唯一允许使用的值。

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

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: string) => void

    • 结果

      字符串

返回

  • 承诺<字符串>

    Chrome 125 及更高版本

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

disableNetworkType()

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

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

参数

enableNetworkType()

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

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

参数

forgetNetwork()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.forgetNetwork(
  networkGuid: string,
  callback?: function,
)

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

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

参数

  • networkGuid

    字符串

    要删除的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 125 及更高版本

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

getCaptivePortalStatus()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.getCaptivePortalStatus(
  networkGuid: string,
  callback?: function,
)

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

参数

  • networkGuid

    字符串

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

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: CaptivePortalStatus) => void

返回

  • Promise&lt;CaptivePortalStatus&gt;

    Chrome 125 及更高版本

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

getDeviceStates()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.getDeviceStates(
  callback?: function,
)

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

参数

返回

  • Promise&lt;DeviceStateProperties[]&gt;

    Chrome 125 及更高版本

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

getGlobalPolicy()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.getGlobalPolicy(
  callback?: function,
)

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

参数

返回

  • Promise&lt;GlobalPolicy&gt;

    Chrome 125 及更高版本

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

getManagedProperties()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.getManagedProperties(
  networkGuid: string,
  callback?: function,
)

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

参数

  • networkGuid

    字符串

    要获取其属性的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: ManagedProperties) => void

返回

  • Promise&lt;ManagedProperties&gt;

    Chrome 125 及更高版本

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

getNetworks()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.getNetworks(
  filter: NetworkFilter,
  callback?: function,
)

返回具有 getState 提供的相同属性的网络对象列表。系统会提供一个过滤条件来指定返回的网络类型并限制网络数量。系统按网络优先级对网络进行排序，最先列出的是已连接或连接的网络。

参数

返回

  • Promise&lt;NetworkStateProperties[]&gt;

    Chrome 125 及更高版本

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

getProperties()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.getProperties(
  networkGuid: string,
  callback?: function,
)

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

参数

  • networkGuid

    字符串

    要获取其属性的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    (result: NetworkProperties) => void

返回

  • Promise&lt;NetworkProperties&gt;

    Chrome 125 及更高版本

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

getState()

<ph type="x-smartling-placeholder"></ph> 承诺 
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。

参数

返回

  • Promise&lt;NetworkStateProperties&gt;

    Chrome 125 及更高版本

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

requestNetworkScan()

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

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

参数

  • networkType

    NetworkType（可选）

    Chrome 63 及更高版本

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

setProperties()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.setProperties(
  networkGuid: string,
  properties: NetworkConfigProperties,
  callback?: function,
)

设置 ID 为 networkGuid 的网络的属性。这仅对已配置的网络有效（来源 != 无）。未配置的可见网络应改用 createNetwork。在自助服务终端会话中，通过共享网络调用此方法会失败。

参数

  • networkGuid

    字符串

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

  • 要设置的属性。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 125 及更高版本

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

startConnect()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.startConnect(
  networkGuid: string,
  callback?: function,
)

使用 networkGuid 启动网络连接。

参数

  • networkGuid

    字符串

    要连接的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<void>

    Chrome 125 及更高版本

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

startDisconnect()

<ph type="x-smartling-placeholder"></ph> 承诺 
chrome.networking.onc.startDisconnect(
  networkGuid: string,
  callback?: function,
)

使用 networkGuid 发起与网络的连接。

参数

  • networkGuid

    字符串

    要断开连接的网络的 GUID。

  • callback

    函数（可选）

    callback 参数如下所示： 

    () => void

返回

  • 承诺<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 和相应的强制门户状态。

参数