chrome.networking.onc

說明

chrome.networking.onc API 可用於設定網路連線 (行動網路、乙太網路、VPN 或 Wi-Fi)。這個 API 適用於自動啟動的 Chrome 作業系統資訊站工作階段。

網路連線設定會依照開放網路設定 (ONC) 規格指定。

注意：大部分的字典屬性和列舉值都會使用 UpperCamelCase 格式來比對 ONC 規格，而非 JavaScript 更低的駝峰式大小寫慣例。

權限

networking.onc

適用國家/地區

Chrome 59 以上版本 僅限 ChromeOS

類型

ActivationStateType

列舉

CaptivePortalStatus

列舉

"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 做為網路「我的客戶中心」(行動裝置國家/地區代碼) 和 MNC (行動網路代碼) 的簡單串連。

  • 國家/地區

    字串 選用

    由兩個字母組成的國家/地區代碼。

  • 名稱

    字串

    運算子名稱。

CellularStateProperties

屬性

CertificatePattern

屬性

  • EnrollmentURI

    string[] 選填

    系統找不到符合此模式的憑證時，可以重新導向使用者的 URI 清單。

  • 核發單位

    IssuerSubjectPattern (選用)

    如有設定，請比對 X.509 核發者設定的模式。

  • IssuerCARef

    string[] 選填

    憑證核發者 CA 憑證的清單。憑證必須由其中一個實體簽署，才能符合這個模式。

  • 主旨

    IssuerSubjectPattern (選用)

    如有設定，請比對 X.509 主旨設定的模式。

ClientCertificateType

列舉

ConnectionStateType

列舉

DeviceStateProperties

屬性

  • SIMLockStatus

    SIMLockStatus 選用

    Chrome 62 以上版本

    如果 Type = Cellular，SIMPresent = True，SIM 卡鎖定狀態。

  • SIMPresent

    布林值 (選用)

    Chrome 62 以上版本

    如果裝置類型為「行動網路」，則設為 SIM 卡顯示狀態。

  • 掃描中

    布林值 (選用)

    設定裝置是否已啟用。如果裝置目前正在掃描，則為 true。

  • 裝置目前的狀態。

  • 類型

    NetworkType

    與裝置相關聯的網路類型 (行動網路、乙太網路或 Wi-Fi)。

DeviceStateType

列舉

「未初始化」
可使用裝置，但尚未初始化。

「已停用」
裝置已初始化但尚未啟用。

「啟用」
已要求啟用狀態，但尚未完成。

「已啟用」
已啟用裝置。

「禁止」
禁止使用裝置。

EAPProperties

屬性

  • AnonymousIdentity

    字串 選用

  • ClientCertPKCS11 ID

    字串 選用

    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 位址。視 Type 的值而定，可以是 IPv4 或 IPv6 位址。

  • IncludedRoutes

    string[] 選填

    Chrome 76 以上版本

    以 CIDR 標記法表示的 IP 區塊陣列，詳情請參閱 onc_spec.md。

  • NameServers

    string[] 選填

    名稱伺服器的位址陣列。

  • RoutingPrefix

    數字 選填

    路徑前置字串。

  • SearchDomains

    string[] 選填

    Chrome 76 以上版本

    名稱解析字串陣列，詳情請參閱 onc_spec.md。

  • 類型

    字串 選用

    IP 設定類型。可以是 IPv4 或 IPv6。

  • WebProxyAutoDiscoveryUrl

    字串 選用

    WEb Proxy Auto-Discovery 的網址，由 DHCP 回報。

IPConfigType

列舉

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 選用

    網路設定管理員 (例如 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」。

  • 限制

    數字 選填

    要傳回的網路數量上限。如未指定，則預設值為 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 設定類型。

  • 優先順序

    數字 選填

    網路優先順序。

  • ProxySettings

    ProxySettings 選用

    網路的 Proxy 設定。

  • RestrictedConnectivity

    布林值 (選用)

    針對已連線的網路，說明網際網路連線是否受限，例如網路位於入口網站後方，或是未啟用行動網路。

  • SavedIPConfig

    IPConfigProperties 選用

    在套用靜態 IP 設定前，從 DHCP 伺服器接收的 IP 設定。

  • 來源

    字串 選用

    指出是否設定網路以及設定方式。可能的值為：

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    「None」與擴充功能程式碼產生發生衝突，因此我們必須使用「Source」字串，而非 SourceType 列舉。

  • StaticIPConfig

    IPConfigProperties 選用

    網路的靜態 IP 設定。

  • TrafficCounterResetTime

    數字 選填

    待處理

    上次重設流量計數器的時間。

  • 類型

    NetworkType

    網路類型。

  • VPN

    VPNProperties 選用

    VPN 網路的網路 VPN 屬性；

  • WiFi

    WiFiProperties (選用)

    Wi-Fi 網路：網路 Wi-Fi 屬性。

NetworkStateProperties

屬性

NetworkType

列舉

PaymentPortal

屬性

  • 方法

    字串

    用於付款入口網站的 HTTP 方法。

  • PostData

    字串 選用

    要傳送至付款入口網站的訊息資料。忽略不看，除非 Method 為 POST。

  • 網址

    字串 選用

    付款入口網站網址。

ProxyLocation

屬性

  • 主機

    字串

    Proxy IP 位址主機。

  • 通訊埠

    號碼

    Proxy 使用的通訊埠。

ProxySettings

屬性

  • ExcludeDomains

    string[] 選填

    排除手動 Proxy 設定的網域和主機。

  • 手動

    ManualProxySettings 選用

    手動 Proxy 設定 - 僅適用於 Manual Proxy 設定。

  • 政治行動委員會

    字串 選用

    Proxy 自動設定檔的網址。

  • Proxy 設定類型。

ProxySettingsType

列舉

SIMLockStatus

屬性

  • LockEnabled

    boolean

    是否啟用 SIM 卡鎖定。

  • LockType

    字串

    SIM 卡鎖定狀態 - 可能的值包括 'sim-pin'、'sim-puk' 和 ''。

  • RetriesLeft

    數字 選填

    輸入 PIN 碼解鎖後，必須先透過 PUK 解鎖 SIM 卡。

ThirdPartyVPNProperties

屬性

  • ExtensionID

    字串

    第三方 VPN 供應商擴充功能 ID。

  • ProviderName

    字串 選用

    VPN 供應商名稱。

VPNProperties

屬性

  • AutoConnect

    布林值 (選用)

    是否要自動連線至 VPN 網路。

  • 主機

    字串 選用

    VPN 主機。

  • 類型

    字串 選用

    VPN 類型。由於「L2TP-IPSec」，因此不能列舉。NetworkConfigProperties 為選用項目，可以傳遞至 setProperties，使其只用於設定特定屬性。

VPNStateProperties

屬性

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 的 HEX 編碼副本。

  • HiddenSSID

    布林值 (選用)

    是否要播送網路 SSID。

  • 通關密語

    字串 選用

    Chrome 66 以上版本

    WEP/WPA/WPA2 連線通關密語。這個屬性只能設定 - getProperties 傳回的屬性不會包含這個值。

  • RoamThreshold

    數字 選填

    已淘汰，已忽略。

  • SSID

    字串 選用

    網路 SSID。

  • 安全性

    字串 選用

    網路安全性類型。

  • SignalStrength

    數字 選填

    網路訊號強度。

WiFiStateProperties

屬性

WiMAXProperties

屬性

  • AutoConnect

    布林值 (選用)

    是否要自動連線至網路。

  • EAP

    EAPProperties 選用

    網路 EAP 屬性。

方法

createNetwork()

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

以資源建立新的網路設定。如果已設定相符的網路，這項操作就會失敗。否則，會傳回新網路的 GUID。

參數

  • 已分享

    boolean

    如果設為 true，請與其他使用者共用這項網路設定。

    這個選項只會在 Chrome 的網頁版 UI 中顯示*。由應用程式呼叫時，false 是唯一允許的值。

  • 用來設定新網路的屬性。

  • 回呼

    函式選用

    callback 參數如下所示： 

    (result: string)=>void

    • 結果

      字串

傳回

  • Promise<string>

    待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

disableNetworkType()

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

停用所有符合指定網路類型的裝置。請參閱「enableNetworkType」的附註。

參數

enableNetworkType()

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

啟用符合指定網路類型的所有裝置。請注意，類型可能代表多種網路類型 (例如「無線」)。

參數

forgetNetwork()

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

使用 GUID networkGuid 清除網路設定的任何屬性，藉此清除網路設定。這可能包括 ID 相符的任何其他網路 (例如 Wi-Fi SSID 和安全性)。如果沒有這類設定，系統會設定錯誤，作業也會失敗。

在資訊站工作階段中，這個方法不會清除共用網路設定。

參數

  • networkGuid

    字串

    要清除的網路 GUID。

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getCaptivePortalStatus()

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

傳回符合「networkGuid」網路的網頁認證入口狀態。

參數

傳回

  • 待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getDeviceStates()

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

傳回可用網路裝置的狀態。

參數

傳回

  • 待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getGlobalPolicy()

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

取得全域政策屬性。這些屬性在工作階段內應該不會變更。

參數

傳回

  • Promise<GlobalPolicy>

    待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getManagedProperties()

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

從來源取得網路 (ID 為 networkGuid) 的合併屬性：使用者設定、共用設定、使用者政策、裝置政策，以及目前有效設定。

參數

傳回

  • 待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getNetworks()

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

傳回由 getState 提供的相同屬性的網路物件清單。系統會提供篩選器，指定傳回的網路類型及限制網路數量。系統會依優先順序排列網路，連線或連線的網路會列在最前面。

參數

傳回

  • 待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getProperties()

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

取得 ID 為 networkGuid 的網路所有屬性。包含網路的所有屬性 (唯讀和讀取/寫入值)。

參數

傳回

  • 待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

getState()

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

取得 ID 為 networkGuid 的網路快取唯讀屬性。其效能功能比 getProperties 來得高，因為需要往返才能查詢網路子系統。系統會針對所有網路傳回以下屬性：GUID、Type、Name、Wi-Fi.Security。下列為可見網路提供的額外屬性：ConnectionState、ErrorState、Wi-Fi.SignalStrength、Cellular.NetworkTechnology、Cellular.ActivationState、Cellular.RoamingState。

參數

傳回

  • 待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

requestNetworkScan()

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

網路子系統掃描新網路並更新 getVisibleNetworks 傳回的清單的要求。這只是請求：網路子系統可以選擇忽略。如果清單更新，就會觸發 onNetworkListChanged 事件。

參數

  • networkType

    NetworkType 選用

    Chrome 63 以上版本

    如有提供，請要求特定類型的掃描作業。如果支援行動網路，將要求掃描行動網路。

setProperties()

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

設定 ID 為 networkGuid 的網路屬性。這個值僅適用於已設定的網路 (來源 != 無)。未設定的可見網路應改用 createNetwork。在資訊站工作階段中，透過共用網路呼叫這個方法會失敗。

參數

  • networkGuid

    字串

    要設定屬性的網路 GUID。

  • 要設定的屬性。

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

startConnect()

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

使用 networkGuid 連線至網路。

參數

  • networkGuid

    字串

    要連線的網路 GUID。

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

startDisconnect()

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

啟動與 networkGuid 的網路中斷連線。

參數

  • networkGuid

    字串

    要中斷連線的網路 GUID。

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    待處理

    Promise 僅支援 Manifest V3 以上版本，其他平台就必須使用回呼。

活動

onDeviceStateListChanged

chrome.networking.onc.onDeviceStateListChanged.addListener(
  callback: function,
)

如果裝置清單已變更或裝置狀態屬性發生變更，就會觸發這個事件。

參數

  • 回呼

    功能

    callback 參數如下所示： 

    ()=>void

onNetworkListChanged

chrome.networking.onc.onNetworkListChanged.addListener(
  callback: function,
)

當網路清單變更時觸發。傳送目前所有網路的 GUID 完整清單。

參數

  • 回呼

    功能

    callback 參數如下所示： 

    (changes: string[])=>void

    • 變更

      string[]

onNetworksChanged

chrome.networking.onc.onNetworksChanged.addListener(
  callback: function,
)

屬性發生變更時觸發。傳送屬性變更的網路 GUID 清單。

參數

  • 回呼

    功能

    callback 參數如下所示： 

    (changes: string[])=>void

    • 變更

      string[]

onPortalDetectionCompleted

chrome.networking.onc.onPortalDetectionCompleted.addListener(
  callback: function,
)

完成網路的入口網站偵測時觸發。傳送網路的 GUID，以及對應的網頁認證入口狀態。

參數