chrome.networking.onc

說明

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

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

注意：大部分的字典屬性和列舉值都會使用 UpperCamelCase 以符合 ONC 規格，而非使用 JavaScript 的 LowerCamelCase 慣例。

權限

networking.onc

可用性

Chrome 59 以上版本 僅適用於 ChromeOS

類型

ActivationStateType

列舉

「已啟用」

「啟用中」

「未啟用」

"PartiallyActivated"

CaptivePortalStatus

列舉

「不明」

「離線」

「線上」

"入口網站"

「ProxyAuthRequired」

CellularProperties

屬性

  • ActivationState

    ActivationStateType 選用

    電信業者帳戶啟用狀態。

  • ActivationType

    string optional

    行動網路啟用類型。

  • AllowRoaming

    布林值 選填

    是否允許網路使用漫遊服務。

  • AutoConnect

    布林值 選填

    手機是否在網路範圍內自動連線。

  • 家庭

    string optional

    行動數據裝置技術系列：CDMA 或 GSM。

  • FirmwareRevision

    string optional

    行動網路數據機載入的韌體修訂版本。

  • FoundNetworks

    FoundNetworkProperties[] 選用

    在最近一次網路掃描期間找到的網路清單。

  • HardwareRevision

    string optional

    行動網路數據機硬體修訂版本。

  • HomeProvider

    CellularProviderProperties 選用

    核發 SIM 卡目前安裝在數據機中的業者相關資訊。

  • 製造商

    string optional

    行動網路數據機製造商。

  • ModelID

    string optional

    行動網路數據機型號 ID。

  • NetworkTechnology

    string optional

    如果數據機在網路中註冊，表示目前使用的網路技術。

  • PaymentPortal

    PaymentPortal 選用

    使用者可透過線上付款入口網站申請或修改行動數據方案。

  • RoamingState

    string optional

    目前網路上行動網路數據機的漫遊狀態。

  • SIMLockStatus

    SIMLockStatus 選用

    GSM 家庭網路的 SIM 卡鎖定狀態。

  • SIMPresent

    布林值 選填

    無論是否有 SIM 卡。

  • 掃描中

    布林值 選填

    Chrome 63 以上版本

    如果正在執行行動網路掃描作業，則為 True。

  • ServingOperator

    CellularProviderProperties 選用

    數據機目前所註冊網路的業者相關資訊。

  • SignalStrength

    編號 選填

    目前的網路訊號強度。

  • SupportNetworkScan

    布林值 選填

    行動網路是否支援掃描功能。

CellularProviderProperties

屬性

  • 程式碼

    字串

    行動網路 ID 是網路的 MCC (行動國家/地區代碼) 和 MNC (行動網路代碼) 的簡單串連。

  • 國家/地區

    string optional

    雙字母的國家/地區代碼。

  • 名稱

    字串

    運算子名稱。

CellularStateProperties

屬性

CertificatePattern

屬性

  • EnrollmentURI

    string[] 選填

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

  • 核發單位

    IssuerSubjectPattern (選用)

    如果已設定，應比對 X.509 核發者設定的模式。

  • IssuerCARef

    string[] 選填

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

  • 主旨

    IssuerSubjectPattern (選用)

    如果已設定模式，應比對 X.509 主體設定。

ClientCertificateType

列舉

「參考」

"圖案"

ConnectionStateType

列舉

「已連線」

「連線中」

「未連線」

DeviceStateProperties

屬性

  • SIMLockStatus

    SIMLockStatus 選用

    Chrome 62 以上版本

    如果類型 = Cellular 和 SIMPresent = True 時的 SIM 卡鎖定狀態。

  • SIMPresent

    布林值 選填

    Chrome 62 以上版本

    如果裝置類型為「行動網路」，設定 SIM 卡目前狀態。

  • 掃描中

    布林值 選填

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

  • 裝置目前的狀態。

  • 類型

    NetworkType

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

DeviceStateType

列舉

「UnInitialed」(未初始化)
裝置可以使用，但尚未初始化。

"Disabled"
裝置已初始化，但尚未啟用。

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

"已啟用"
裝置已啟用。

「禁止」
禁止使用裝置。

EAPProperties

屬性

  • AnonymousIdentity

    string optional

  • ClientCertPKCS11 ID

    string optional

    Chrome 60 以上版本
  • ClientCertPattern

    CertificatePattern (選用)

  • ClientCertProvisioningProfileId

    string optional

    Chrome 93 以上版本
  • ClientCertRef

    string optional

  • ClientCertType

    ClientCertificateType

  • 身分識別

    string optional

  • 內部

    string optional

  • 外部

    string optional

    外部 EAP 類型。ONC 要求提供，但從 Shill 翻譯時可能不會提供。

  • 密碼

    string optional

  • SaveCredentials

    布林值 選填

  • ServerCAPEMs

    string[] 選填

  • ServerCARefs

    string[] 選填

  • SubjectMatch

    ManagedDOMString 選用

    Chrome 60 以上版本
  • UseProactiveKeyCaching

    布林值 選填

  • UseSystemCAs

    布林值 選填

EthernetProperties

屬性

  • 驗證

    string optional

    乙太網路使用的驗證方式。可能的值為 None 和 8021X。

  • AutoConnect

    布林值 選填

    是否應自動連線乙太網路。

  • EAP

    EAPProperties 選用

    網路的 EAP 設定需要 8021X 驗證。

EthernetStateProperties

屬性

FoundNetworkProperties

屬性

  • LongName

    string optional

    網路業者的長格式名稱。

  • NetworkId

    字串

    聯播網 ID。

  • ShortName

    string optional

    網路業者的簡短格式名稱。

  • 狀態

    字串

    是否連上網路。

  • 科技

    字串

    存取「網路」採用的技術。

GlobalPolicy

屬性

  • AllowOnlyPolicyNetworksToAutoconnect

    布林值 選填

    如果設為 True，則只有政策網路可以自動連線。預設值為 false。

  • AllowOnlyPolicyNetworksToConnect

    布林值 選填

    如果設為 true，則只能連線至政策網路，並且無法新增或設定新的網路。預設值為 false。

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    布林值 選填

    Chrome 70 以上版本

    如果值為 true，且受管理的網路出現在可見網路清單中，則只能連線至政策網路，且不得新增或設定新的網路。預設值為 false。

  • BlockedHexSSIDs

    string[] 選填

    Chrome 86 以上版本

    封鎖的聯播網清單。禁止連線至已封鎖的網路。只要指定明確的網路設定，即可再次解除封鎖網路。預設為空白清單。

IPConfigProperties

屬性

  • ExcludedRoutes

    string[] 選填

    Chrome 76 以上版本

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

  • 閘道

    string optional

    用於 IP 設定的閘道位址。

  • IPAddress

    string optional

    連線的 IP 位址。可以是 IPv4 或 IPv6 位址，視 Type 的值而定。

  • IncludedRoutes

    string[] 選填

    Chrome 76 以上版本

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

  • NameServers

    string[] 選填

    名稱伺服器使用的位址陣列。

  • RoutingPrefix

    編號 選填

    轉送前置字串。

  • SearchDomains

    string[] 選填

    Chrome 76 以上版本

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

  • 類型

    string optional

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

  • WebProxyAutoDiscoveryUrl

    string optional

    WEb Proxy 自動探索的網址 (由 DHCP 回報)。

IPConfigType

列舉

「DHCP」

「靜態」

IssuerSubjectPattern

屬性

  • CommonName

    string optional

    如果已設定，要比對憑證主體共同名稱的值。

  • 縣市

    string optional

    如果已設定此值，用於比對憑證主體共同位置的值。

  • 機構

    string optional

    已設定時，要比對憑證主體機構的值。至少須有一個機構與這個值相符。

  • OrganizationalUnit

    string optional

    已設定時，要用於與憑證主體機構單位相符的值。至少要有一個機構單位與其值相符。

ManagedBoolean

屬性

  • 有效

    布林值 選填

    網路設定管理員 (例如 Shill) 目前使用的有效值。

  • DeviceEditable

    布林值 選填

    屬性是否存在 DevicePolicy，且允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • DevicePolicy

    布林值 選填

    裝置政策提供的屬性值。

  • 有效

    string optional

    有效屬性值的來源。

  • SharedSetting

    布林值 選填

    您為裝置所有使用者設定的值。僅在 DeviceEditiable 為 true 時提供。

  • UserEditable

    布林值 選填

    屬性是否存在 UserPolicy，並允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    布林值 選填

    使用者政策提供的屬性值。

  • UserSetting

    布林值 選填

    登入使用者設定的屬性值。僅在 UserEditable 為 true 時提供。

ManagedCellularProperties

屬性

ManagedDOMString

屬性

  • 有效

    string optional

    網路設定管理員 (例如 Shill) 目前使用的有效值。

  • DeviceEditable

    布林值 選填

    屬性是否存在 DevicePolicy，且允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • DevicePolicy

    string optional

    裝置政策提供的屬性值。

  • 有效

    string optional

    有效屬性值的來源。

  • SharedSetting

    string optional

    您為裝置所有使用者設定的值。僅在 DeviceEditiable 為 true 時提供。

  • UserEditable

    布林值 選填

    屬性是否存在 UserPolicy，並允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    string optional

    使用者政策提供的屬性值。

  • UserSetting

    string optional

    登入使用者設定的屬性值。僅在 UserEditable 為 true 時提供。

ManagedDOMStringList

屬性

  • 有效

    string[] 選填

    網路設定管理員 (例如 Shill) 目前使用的有效值。

  • DeviceEditable

    布林值 選填

    屬性是否存在 DevicePolicy，且允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • DevicePolicy

    string[] 選填

    裝置政策提供的屬性值。

  • 有效

    string optional

    有效屬性值的來源。

  • SharedSetting

    string[] 選填

    您為裝置所有使用者設定的值。僅在 DeviceEditiable 為 true 時提供。

  • UserEditable

    布林值 選填

    屬性是否存在 UserPolicy，並允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    string[] 選填

    使用者政策提供的屬性值。

  • UserSetting

    string[] 選填

    登入使用者設定的屬性值。僅在 UserEditable 為 true 時提供。

ManagedEthernetProperties

屬性

ManagedIPConfigProperties

屬性

ManagedIPConfigType

屬性

  • 有效

    IPConfigType 選用

    網路設定管理員 (例如 Shill) 目前使用的有效值。

  • DeviceEditable

    布林值 選填

    屬性是否存在 DevicePolicy，且允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • DevicePolicy

    IPConfigType 選用

    裝置政策提供的屬性值。

  • 有效

    string optional

    有效屬性值的來源。

  • SharedSetting

    IPConfigType 選用

    您為裝置所有使用者設定的值。僅在 DeviceEditiable 為 true 時提供。

  • UserEditable

    布林值 選填

    屬性是否存在 UserPolicy，並允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    IPConfigType 選用

    使用者政策提供的屬性值。

  • UserSetting

    IPConfigType 選用

    登入使用者設定的屬性值。僅在 UserEditable 為 true 時提供。

ManagedLong

屬性

  • 有效

    編號 選填

    網路設定管理員 (例如 Shill) 目前使用的有效值。

  • DeviceEditable

    布林值 選填

    屬性是否存在 DevicePolicy，且允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • DevicePolicy

    編號 選填

    裝置政策提供的屬性值。

  • 有效

    string optional

    有效屬性值的來源。

  • SharedSetting

    編號 選填

    您為裝置所有使用者設定的值。僅在 DeviceEditiable 為 true 時提供。

  • UserEditable

    布林值 選填

    屬性是否存在 UserPolicy，並允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    編號 選填

    使用者政策提供的屬性值。

  • UserSetting

    編號 選填

    登入使用者設定的屬性值。僅在 UserEditable 為 true 時提供。

ManagedManualProxySettings

屬性

ManagedProperties

屬性

ManagedProxyLocation

屬性

ManagedProxySettings

屬性

ManagedProxySettingsType

屬性

  • 有效

    ProxySettingsType optional

    網路設定管理員 (例如 Shill) 目前使用的有效值。

  • DeviceEditable

    布林值 選填

    屬性是否存在 DevicePolicy，且允許編輯屬性 (即政策設定的建議屬性值)。預設值為 false。

  • DevicePolicy

    ProxySettingsType optional

    裝置政策提供的屬性值。

  • 有效

    string 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

    string optional

    上次記錄的網路錯誤狀態。

  • 乙太網路

    EthernetProperties 選用

    如果是乙太網路，就是乙太網路屬性。

  • GUID

    字串

    網路 GUID。

  • IPAddressConfigType

    IPConfigType 選用

    網路的 IP 位址設定類型，

  • IPConfigs

    IPConfigProperties[] 選用

    網路的 IP 設定。

  • MacAddress

    string optional

    網路的 MAC 位址。

  • 計量付費

    布林值 選填

    Chrome 85 以上版本

    網路是否採用計量付費。

  • 名稱

    string optional

    使用者容易閱讀的網路名稱。

  • NameServersConfigType

    IPConfigType 選用

    網路所用名稱伺服器的 IP 設定類型。

  • 優先順序

    編號 選填

    網路優先順序。

  • ProxySettings

    ProxySettings 選用

    網路的 Proxy 設定。

  • RestrictedConnectivity

    布林值 選填

    如果是已連線的網路，是否有網際網路連線是受限的，例如網路連線時，或是行動網路未啟用

  • SavedIPConfig

    IPConfigProperties 選用

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

  • 來源

    string optional

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

    • 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」

「無線」

「WiFi」

PaymentPortal

屬性

  • 方法

    字串

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

  • PostData

    string optional

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

  • 網址

    string optional

    付款入口網站網址。

ProxyLocation

屬性

  • 主機

    字串

    Proxy IP 位址主機。

  • 通訊埠

    數字

    Proxy 要使用的通訊埠。

ProxySettings

屬性

  • ExcludeDomains

    string[] 選填

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

  • 手動

    ManualProxySettings 選用

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

  • 政治行動委員會

    string optional

    Proxy 自動設定檔的網址。

  • Proxy 設定類型。

ProxySettingsType

列舉

「直接」

「手動」

「PAC」

「WPAD」

SIMLockStatus

屬性

  • LockEnabled

    布林值

    是否啟用 SIM 卡鎖定。

  • LockType

    字串

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

  • RetriesLeft

    編號 選填

    你必須輸入 PIN 碼鎖定次數上限，才能使用 PUK 解鎖 SIM 卡。

ThirdPartyVPNProperties

屬性

  • ExtensionID

    字串

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

  • ProviderName

    string optional

    VPN 供應商名稱。

VPNProperties

屬性

  • AutoConnect

    布林值 選填

    是否應自動連線 VPN 網路。

  • 主機

    string optional

    VPN 主機。

  • 類型

    string optional

    VPN 類型，因「L2TP-IPSec」而並非列舉。對於傳遞到 setProperties 的 NetworkConfigProperties，此屬性只能用來設定特定屬性。

VPNStateProperties

屬性

WiFiProperties

屬性

  • AllowGatewayARPPolling

    布林值 選填

    是否允許針對預設閘道輪詢 ARP。預設為 true。

  • AutoConnect

    布林值 選填

    進入有效範圍時，是否要自動連上 Wi-Fi 網路。

  • BSSID

    string optional

    相關存取點的 BSSID。

  • EAP

    EAPProperties 選用

    網路 EAP 屬性。「WEP-8021X」和「WPA-EAP」網路的必要項目。

  • 頻率

    編號 選填

    Wi-Fi 服務運作頻率 (MHz)。針對連線的網路，此為目前網路連線的頻率。否則為最佳 BSS 和頻率。

  • FrequencyList

    number[] 選填

    包含 Wi-Fi 網路近期偵測到的所有作業頻率。

  • HexSSID

    string optional

    網路 SSID 的十六進位編碼副本，

  • HiddenSSID

    布林值 選填

    是否要播送網路 SSID。

  • 通關密語

    string optional

    Chrome 66 以上版本

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

  • RoamThreshold

    編號 選填

    已淘汰，已忽略。

  • SSID

    string optional

    網路 SSID。

  • 安全性

    string optional

    網路安全性類型。

  • SignalStrength

    編號 選填

    網路訊號強度。

WiFiStateProperties

屬性

WiMAXProperties

屬性

  • AutoConnect

    布林值 選填

    是否應自動連線網路。

  • EAP

    EAPProperties 選用

    網路 EAP 屬性。

方法

createNetwork()

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

從屬性建立新的網路設定。如果已有相符的設定網路，則失敗。否則會傳回新網路的 GUID。

參數

  • 已分享

    布林值

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

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

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

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (result: string) => void

    • 結果

      字串

傳回

  • 承諾<字串>

    Chrome 125 以上版本

    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

傳回

  • 承諾<void>

    Chrome 125 以上版本

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

getCaptivePortalStatus()

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

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

參數

  • networkGuid

    字串

    要取得網頁認證入口狀態的網路 GUID。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (result: CaptivePortalStatus) => void

傳回

  • Promise&lt;CaptivePortalStatus&gt;

    Chrome 125 以上版本

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

getDeviceStates()

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

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

參數

傳回

  • Promise&lt;DeviceStateProperties[]&gt;

    Chrome 125 以上版本

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

getGlobalPolicy()

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

取得全域政策屬性。這些資源在工作階段中不會變更。

參數

傳回

  • Promise&lt;GlobalPolicy&gt;

    Chrome 125 以上版本

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

getManagedProperties()

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

從以下來源取得網路的 ID 為 networkGuid 的合併屬性：使用者設定、共用設定、使用者政策、裝置政策和目前使用中的設定。

參數

傳回

  • Promise&lt;ManagedProperties&gt;

    Chrome 125 以上版本

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

getNetworks()

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

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

參數

傳回

  • Promise&lt;NetworkStateProperties[]&gt;

    Chrome 125 以上版本

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

getProperties()

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

使用 ID 為 networkGuid 的網路所有屬性，包括網路的所有屬性 (唯讀和讀取/寫入值)。

參數

傳回

  • Promise&lt;NetworkProperties&gt;

    Chrome 125 以上版本

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

getState()

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

使用 ID 為 networkGuid 的網路快取唯讀屬性，這個級別的效能會比 getProperties 來得高，因為這需要往返時間才能查詢網路子系統。系統會針對所有網路傳回下列屬性：GUID、類型、名稱、Wi-Fi.Security。為可見網路提供了其他屬性：ConnectionState、ErrorState、Wi-SignalStrength、Cellular.NetworkTechnology、Cellular.ActivationState、Cellular.RoamingState。

參數

傳回

  • Promise&lt;NetworkStateProperties&gt;

    Chrome 125 以上版本

    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 的網路屬性。這只適用於已設定的網路 (來源 != None)。未設定的可見網路應改用 createNetwork。在資訊站工作階段中，無法透過共用網路呼叫這個方法。

參數

  • networkGuid

    字串

    要設定屬性的網路 GUID。

  • 要設定的屬性。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

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

startConnect()

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

使用 networkGuid 連線至網路，

參數

  • networkGuid

    字串

    要連線的網路 GUID。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

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

startDisconnect()

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

使用 networkGuid 開始中斷網路連線。

參數

  • networkGuid

    字串

    要中斷連線的網路 GUID。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • 承諾<void>

    Chrome 125 以上版本

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

活動

onDeviceStateListChanged

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

裝置清單變更或任何裝置狀態屬性變更時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    () => void

onNetworkListChanged

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

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

參數

  • 回呼

    函式

    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 和對應的網頁認證入口狀態。

參數