chrome.networking.onc

說明

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

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

NOTE：大多數字典屬性和列舉值都使用 UpperCamelCase 來符合 ONC 規格，而非 JavaScript lowerCamelCase 慣例。

權限

networking.onc

可用性

Chrome 59 以上版本 僅適用於 ChromeOS

類型

ActivationStateType

列舉

「已啟用」

「啟用」

"NotActivated"

"PartiallyActivated"

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，由網路的 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 以上版本

    SIM 卡鎖定狀態 (如果 Type = Cellular 且 SIMPresent = True)。

  • SIMPresent

    布林值 選填

    Chrome 62 以上版本

    如果裝置類型為行動網路，請設為 SIM 卡存在狀態。

  • 掃描

    布林值 選填

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

  • 裝置目前的狀態。

  • 類型

    NetworkType

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

DeviceStateType

列舉

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

「Disabled」
裝置已初始化，但未啟用。

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

「已啟用」
裝置已啟用。

「Prohibited」
裝置已遭禁止。

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

    字串 選填

    透過 DHCP 回報的網路 Proxy 自動探索網址。

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

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

    數字 選填

    Chrome 125 以上版本

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

  • 類型

    NetworkType

    網路類型。

  • VPN

    VPNProperties 選用

    如果是 VPN 網路，則為網路 VPN 屬性。

  • Wi-Fi

    WiFiProperties 選用

    如果是 Wi-Fi 網路，則為網路 Wi-Fi 屬性。

NetworkStateProperties

屬性

NetworkType

列舉

「全部」

「行動網路」

「乙太網路」

「Tether」

「VPN」

「無線」

「Wi-Fi」

PaymentPortal

屬性

  • 方法

    字串

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

  • PostData

    字串 選填

    要傳送至付款入口網站的 POST 資料。除非 Method 為 POST，否則會遭到忽略。

  • 網址

    字串 選填

    付款入口網站網址。

ProxyLocation

屬性

  • 主機

    字串

    Proxy IP 位址主機。

  • 通訊埠

    數字

    Proxy 要使用的通訊埠。

ProxySettings

屬性

  • ExcludeDomains

    string[] 選填

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

  • 手動

    ManualProxySettings 選用

    手動 Proxy 設定：僅用於 Manual Proxy 設定。

  • 政治行動委員會

    字串 選填

    Proxy 自動設定檔的網址。

  • Proxy 設定類型。

ProxySettingsType

列舉

「直接」

「手動」

"PAC"

"WPAD"

SIMLockStatus

屬性

  • LockEnabled

    布林值

    是否啟用 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

    布林值 選填

    自 Chrome 131 起淘汰

    已在 M131 中移除。目前沒有進行中的 ARP 輪詢。

  • 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

屬性

WiMAXProperties

屬性

  • AutoConnect

    布林值 選填

    是否應自動連線至網路。

  • EAP

    EAPProperties 選填

    網路 EAP 屬性。

方法

createNetwork()

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

根據屬性建立新的網路設定。如果已有相符的設定網路，這項操作就會失敗。否則傳回新網路的 GUID。

參數

  • 已分享

    布林值

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

    這個選項只會顯示在 Chrome 的網頁 UI 中。* 應用程式呼叫時，只能使用 false 值。

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

  • callback

    函式 選填

    callback 參數如下： 

    (result: string) => void

    • 結果

      字串

傳回

  • Promise<string>

    Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

disableNetworkType()

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

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

參數

enableNetworkType()

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

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

參數

forgetNetwork()

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

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

在 Kiosk 工作階段中，這個方法無法清除共用網路設定。

參數

  • networkGuid

    字串

    要清除的網路 GUID。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getCaptivePortalStatus()

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

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

參數

傳回

  • Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getDeviceStates()

Promise 
chrome.networking.onc.getDeviceStates(
  callback?: function,
): Promise<DeviceStateProperties[]>

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

參數

傳回

  • Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getGlobalPolicy()

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

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

參數

傳回

  • 承諾<GlobalPolicy>

    Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getManagedProperties()

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

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

參數

傳回

  • Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getNetworks()

Promise 
chrome.networking.onc.getNetworks(
  filter: NetworkFilter,
  callback?: function,
): Promise<NetworkStateProperties[]>

傳回網路物件清單，其中包含 getState 提供的相同屬性。您可以使用篩選器指定傳回的網路類型，並限制網路數量。系統會依優先順序排列網路，優先列出已連線或正在連線的網路。

參數

傳回

  • Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getProperties()

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

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

參數

傳回

  • Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

getState()

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

取得 ID 為 networkGuid 的網路快取唯讀屬性。這個函式的效能比 getProperties 更高，後者需要來回查詢網路子系統。系統會傳回所有網路的下列屬性：GUID、Type、Name、WiFi.Security。系統會為可見網路提供額外屬性：ConnectionState、ErrorState、WiFi.SignalStrength、Cellular.NetworkTechnology、Cellular.ActivationState、Cellular.RoamingState。

參數

傳回

  • Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

requestNetworkScan()

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

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

參數

  • networkType

    NetworkType 選填

    Chrome 63 以上版本

    如果提供，則會要求掃描特定類型。如果是行動網路，系統會要求掃描行動網路 (如果支援)。

setProperties()

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

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

參數

  • networkGuid

    字串

    要設定屬性的網路 GUID。

  • 要設定的屬性。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

startConnect()

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

使用 networkGuid 啟動與網路的連線。

參數

  • networkGuid

    字串

    要連線的網路 GUID。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

startDisconnect()

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

開始中斷與 networkGuid 網路的連線。

參數

  • networkGuid

    字串

    要中斷連線的網路 GUID。

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

    Promise 僅適用於 Manifest V3 以上版本，其他平台則須使用回呼。

事件

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

    • 變更

      string[]

onNetworksChanged

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

當任何網路的屬性變更時，就會觸發這個事件。傳送屬性已變更的網路 GUID 清單。

參數

  • callback

    函式

    callback 參數如下： 

    (changes: string[]) => void

    • 變更

      string[]

onPortalDetectionCompleted

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

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

參數