chrome.networking.onc

說明

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

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

注意：大多數字典屬性和列舉值都會使用大寫駝峰式名稱，以符合 ONC 規格，而非 JavaScript 的 lowerCamelCase 慣例。

權限

networking.onc

可用性

Chrome 59 以上版本 (僅限 ChromeOS)

類型

ActivationStateType

列舉

「已啟用」

「Activating」

「NotActivated」

"PartiallyActivated"

CaptivePortalStatus

列舉

「Unknown」

「離線」

"Online"

「Portal」

"ProxyAuthRequired"

CellularProperties

屬性

  • ActivationState

    ActivationStateType 選填

    電信業者帳戶啟用狀態。

  • ActivationType

    string 選填

    行動網路啟用類型。

  • AllowRoaming

    boolean 選填

    網路是否允許漫遊。

  • AutoConnect

    boolean 選填

    是否要在行動網路範圍內自動連線。

  • 家庭

    string 選填

    行動裝置技術系列 - CDMA 或 GSM。

  • FirmwareRevision

    string 選填

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

  • FoundNetworks

    FoundNetworkProperties[] 選填

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

  • HardwareRevision

    string 選填

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

  • HomeProvider

    CellularProviderProperties 選填

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

  • 製造商

    string 選填

    行動數據機製造商。

  • ModelID

    string 選填

    行動數據機型號 ID。

  • NetworkTechnology

    string 選填

    如果數據機已註冊至網路，則為目前使用的網路技術。

  • PaymentPortal

    PaymentPortal 選填

    使用者可透過這個線上付款入口網站，註冊或修改行動數據方案。

  • RoamingState

    string 選填

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

  • SIMLockStatus

    SIMLockStatus 選填

    GSM 系列網路的 SIM 卡鎖定狀態。

  • SIMPresent

    boolean 選填

    是否有 SIM 卡。

  • 掃描

    boolean 選填

    Chrome 63 以上版本

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

  • ServingOperator

    CellularProviderProperties 選填

    目前註冊在哪個網路上的電信業者資訊。

  • SignalStrength

    號碼 選填

    目前的網路訊號強度。

  • SupportNetworkScan

    boolean 選填

    行動網路是否支援掃描。

CellularProviderProperties

屬性

  • 程式碼

    字串

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

  • 國家/地區

    string 選填

    國家/地區代碼 (由兩個英文字母組成)。

  • 名稱

    字串

    運算子名稱。

CellularStateProperties

屬性

CertificatePattern

屬性

  • EnrollmentURI

    string[] 選填

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

  • 核發單位

    IssuerSubjectPattern 選填

    如果已設定，則系統會根據這個模式比對 X.509 發出者設定。

  • IssuerCARef

    string[] 選填

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

  • 主旨

    IssuerSubjectPattern 選填

    如果已設定，則系統會根據這個模式比對 X.509 主體設定。

ClientCertificateType

列舉

「Ref」

「Pattern」

ConnectionStateType

列舉

「已連線」

「Connecting」

「NotConnected」

DeviceStateProperties

屬性

  • SIMLockStatus

    SIMLockStatus 選填

    Chrome 62 以上版本

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

  • SIMPresent

    boolean 選填

    Chrome 62 以上版本

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

  • 掃描

    boolean 選填

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

  • 裝置目前的狀態。

  • 類型

    NetworkType

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

DeviceStateType

列舉

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

「已停用」
裝置已完成初始化，但未啟用。

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

「已啟用」
裝置已啟用。

「禁止」
裝置遭禁止。

EAPProperties

屬性

  • AnonymousIdentity

    string 選填

  • ClientCertPKCS11Id

    string 選填

    Chrome 60 以上版本
  • ClientCertPattern

    CertificatePattern 選填

  • ClientCertProvisioningProfileId

    string 選填

    Chrome 93 以上版本
  • ClientCertRef

    string 選填

  • ClientCertType

    ClientCertificateType

  • 身分識別

    string 選填

  • 內部

    string 選填

  • 外部

    string 選填

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

  • 密碼

    string 選填

  • SaveCredentials

    boolean 選填

  • ServerCAPEMs

    string[] 選填

  • ServerCARefs

    string[] 選填

  • SubjectMatch

    ManagedDOMString 選填

    Chrome 60 以上版本
  • UseProactiveKeyCaching

    boolean 選填

  • UseSystemCAs

    boolean 選填

EthernetProperties

屬性

  • 驗證

    string 選填

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

  • AutoConnect

    boolean 選填

    是否要自動連線至乙太網路。

  • EAP

    EAPProperties 選填

    網路的 EAP 設定。這是 8021X 驗證的必要條件。

EthernetStateProperties

屬性

FoundNetworkProperties

屬性

  • LongName

    string 選填

    網路業者的長格式名稱。

  • NetworkId

    字串

    網路 ID。

  • ShortName

    string 選填

    網路業者的簡短名稱。

  • 狀態

    字串

    網路可用性。

  • 科技

    字串

    存取網路使用的技術。

GlobalPolicy

屬性

  • AllowOnlyPolicyNetworksToAutoconnect

    boolean 選填

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

  • AllowOnlyPolicyNetworksToConnect

    boolean 選填

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

  • AllowOnlyPolicyNetworksToConnectIfAvailable

    boolean 選填

    Chrome 70 以上版本

    如果為 True，且可見網路清單中含有受管理的網路，則只能連線至政策網路，無法新增或設定新網路。預設值為 false。

  • BlockedHexSSIDs

    string[] 選填

    Chrome 86 以上版本

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

IPConfigProperties

屬性

  • ExcludedRoutes

    string[] 選填

    Chrome 76 以上版本

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

  • 閘道

    string 選填

    用於 IP 設定的閘道位址。

  • IPAddress

    string 選填

    連線的 IP 位址。可以是 IPv4 或 IPv6 位址，取決於 Type 的值。

  • IncludedRoutes

    string[] 選填

    Chrome 76 以上版本

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

  • NameServers

    string[] 選填

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

  • RoutingPrefix

    號碼 選填

    路徑前置字串。

  • SearchDomains

    string[] 選填

    Chrome 76 以上版本

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

  • 類型

    string 選填

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

  • WebProxyAutoDiscoveryUrl

    string 選填

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

IPConfigType

列舉

「DHCP」

「Static」

IssuerSubjectPattern

屬性

  • CommonName

    string 選填

    如果已設定，則會與憑證主體的通用名稱比對。

  • 縣市

    string 選填

    如果已設定，則會與憑證主體的常用位置相符。

  • 機構

    string 選填

    如果已設定，則會與憑證主體的機構相符。至少應有一個機構與該值相符。

  • OrganizationalUnit

    string 選填

    如果已設定，則會與憑證主體的機構單位進行比對。至少應有一個機構單位與該值相符。

ManagedBoolean

屬性

  • 有效

    boolean 選填

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

  • DeviceEditable

    boolean 選填

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

  • DevicePolicy

    boolean 選填

    裝置政策提供的屬性值。

  • 有效

    string 選填

    系統判斷有效資源值的來源。

  • SharedSetting

    boolean 選填

    為裝置上所有使用者設定的值。只有在 DeviceEditiable 為 true 時才會提供。

  • UserEditable

    boolean 選填

    屬性是否已設有 UserPolicy，且允許編輯該屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    boolean 選填

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

  • UserSetting

    boolean 選填

    登入使用者設定的屬性值。只有在 UserEditable 為 true 時才會提供。

ManagedCellularProperties

屬性

ManagedDOMString

屬性

  • 有效

    string 選填

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

  • DeviceEditable

    boolean 選填

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

  • DevicePolicy

    string 選填

    裝置政策提供的屬性值。

  • 有效

    string 選填

    系統判斷有效資源值的來源。

  • SharedSetting

    string 選填

    為裝置上所有使用者設定的值。只有在 DeviceEditiable 為 true 時才會提供。

  • UserEditable

    boolean 選填

    屬性是否已設有 UserPolicy，且允許編輯該屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    string 選填

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

  • UserSetting

    string 選填

    登入使用者設定的屬性值。只有在 UserEditable 為 true 時才會提供。

ManagedDOMStringList

屬性

  • 有效

    string[] 選填

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

  • DeviceEditable

    boolean 選填

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

  • DevicePolicy

    string[] 選填

    裝置政策提供的屬性值。

  • 有效

    string 選填

    系統判斷有效資源值的來源。

  • SharedSetting

    string[] 選填

    為裝置上所有使用者設定的值。只有在 DeviceEditiable 為 true 時才會提供。

  • UserEditable

    boolean 選填

    屬性是否已設有 UserPolicy，且允許編輯該屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    string[] 選填

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

  • UserSetting

    string[] 選填

    登入使用者設定的屬性值。只有在 UserEditable 為 true 時才會提供。

ManagedEthernetProperties

屬性

ManagedIPConfigProperties

屬性

ManagedIPConfigType

屬性

  • 有效

    IPConfigType 選填

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

  • DeviceEditable

    boolean 選填

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

  • DevicePolicy

    IPConfigType 選填

    裝置政策提供的屬性值。

  • 有效

    string 選填

    系統判斷有效資源值的來源。

  • SharedSetting

    IPConfigType 選填

    為裝置上所有使用者設定的值。只有在 DeviceEditiable 為 true 時才會提供。

  • UserEditable

    boolean 選填

    屬性是否已設有 UserPolicy，且允許編輯該屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    IPConfigType 選填

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

  • UserSetting

    IPConfigType 選填

    登入使用者設定的屬性值。只有在 UserEditable 為 true 時才會提供。

ManagedLong

屬性

  • 有效

    號碼 選填

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

  • DeviceEditable

    boolean 選填

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

  • DevicePolicy

    號碼 選填

    裝置政策提供的屬性值。

  • 有效

    string 選填

    系統判斷有效資源值的來源。

  • SharedSetting

    號碼 選填

    為裝置上所有使用者設定的值。只有在 DeviceEditiable 為 true 時才會提供。

  • UserEditable

    boolean 選填

    屬性是否已設有 UserPolicy，且允許編輯該屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    號碼 選填

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

  • UserSetting

    號碼 選填

    登入使用者設定的屬性值。只有在 UserEditable 為 true 時才會提供。

ManagedManualProxySettings

屬性

ManagedProperties

屬性

ManagedProxyLocation

屬性

ManagedProxySettings

屬性

ManagedProxySettingsType

屬性

  • 有效

    ProxySettingsType 選用

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

  • DeviceEditable

    boolean 選填

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

  • DevicePolicy

    ProxySettingsType 選用

    裝置政策提供的屬性值。

  • 有效

    string 選填

    系統判斷有效資源值的來源。

  • SharedSetting

    ProxySettingsType 選用

    為裝置上所有使用者設定的值。只有在 DeviceEditiable 為 true 時才會提供。

  • UserEditable

    boolean 選填

    屬性是否已設有 UserPolicy，且允許編輯該屬性 (即政策設定的建議屬性值)。預設值為 false。

  • UserPolicy

    ProxySettingsType 選用

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

  • UserSetting

    ProxySettingsType 選用

    登入使用者設定的屬性值。只有在 UserEditable 為 true 時才會提供。

ManagedThirdPartyVPNProperties

屬性

ManagedVPNProperties

屬性

ManagedWiFiProperties

屬性

ManualProxySettings

屬性

NetworkConfigProperties

屬性

NetworkFilter

屬性

  • 已設定

    boolean 選填

    如果為 true，則只會納入已設定 (儲存) 的網路。預設值為「false」。

  • 限制

    號碼 選填

    要傳回的網路數量上限。如未指定，預設值為 1000。如要無限制，請使用 0。

  • networkType

    NetworkType

    要傳回的網路類型。

  • 顯示

    boolean 選填

    如果為 true，則只會納入可見的 (實際連線或在範圍內) 網路。預設值為「false」。

NetworkProperties

屬性

  • 行動網路

    CellularProperties 選填

    行動網路：行動網路屬性。

  • 可連結

    boolean 選填

    網路是否可連線。

  • ConnectionState

    ConnectionStateType 選用

    網路目前的連線狀態。

  • ErrorState

    string 選填

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

  • 乙太網路

    EthernetProperties 選填

    乙太網路：乙太網路屬性。

  • GUID

    字串

    網路 GUID。

  • IPAddressConfigType

    IPConfigType 選填

    網路的 IP 位址設定類型。

  • IPConfigs

    IPConfigProperties[] 選用

    網路的 IP 設定。

  • MacAddress

    string 選填

    網路的 MAC 位址。

  • 計量付費

    boolean 選填

    Chrome 85 以上版本

    網路是否計量。

  • 名稱

    string 選填

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

  • NameServersConfigType

    IPConfigType 選填

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

  • 優先順序

    號碼 選填

    網路優先順序。

  • ProxySettings

    ProxySettings 選填

    網路的 Proxy 設定。

  • RestrictedConnectivity

    boolean 選填

    連線網路：網路連線至網際網路是否受限，例如網路是否透過網頁認證入口連線，或是行動網路未啟用。

  • SavedIPConfig

    IPConfigProperties 選填

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

  • 來源

    string 選填

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

    • 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

列舉

「全部」

「行動網路」

「Ethernet」

"Tether"

"VPN"

"Wireless"

「WiFi」

PaymentPortal

屬性

  • 方法

    字串

    要用於付款入口的 HTTP 方法。

  • PostData

    string 選填

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

  • 網址

    string 選填

    付款入口網址。

ProxyLocation

屬性

  • 主機

    字串

    Proxy IP 位址主機。

  • 通訊埠

    數字

    Proxy 使用的通訊埠。

ProxySettings

屬性

  • ExcludeDomains

    string[] 選填

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

  • 手動

    ManualProxySettings 選用

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

  • 政治行動委員會

    string 選填

    Proxy 自動設定檔案的網址。

  • Proxy 設定的類型。

ProxySettingsType

列舉

「直接」

「手動」

"PAC"

"WPAD"

SIMLockStatus

屬性

  • LockEnabled

    布林值

    是否啟用 SIM 卡鎖定功能。

  • LockType

    字串

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

  • RetriesLeft

    號碼 選填

    允許輸入 PIN 碼的次數，如果超過次數上限，就必須使用 PUK 碼才能解鎖 SIM 卡。

ThirdPartyVPNProperties

屬性

  • ExtensionID

    字串

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

  • ProviderName

    string 選填

    VPN 供應商名稱。

VPNProperties

屬性

  • AutoConnect

    boolean 選填

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

  • 主機

    string 選填

    VPN 主機。

  • 類型

    string 選填

    VPN 類型。由於有「L2TP-IPSec」，因此無法使用列舉。對於傳遞至 setProperties 的 NetworkConfigProperties，這項屬性為選用，可用於只設定特定屬性。

VPNStateProperties

屬性

WiFiProperties

屬性

  • AllowGatewayARPPolling

    boolean 選填

    自 Chrome 131 版起已淘汰

    已在 M131 中移除。目前沒有任何有效的 ARP 輪詢。

  • AutoConnect

    boolean 選填

    是否要在 Wi-Fi 網路範圍內自動連線。

  • BSSID

    string 選填

    關聯存取點的 BSSID。

  • EAP

    EAPProperties 選填

    網路 EAP 屬性。必須用於 WEP-8021X 和 WPA-EAP 網路。

  • 頻率

    號碼 選填

    Wi-Fi 服務的運作頻率 (以 MHz 為單位)。如果是已連線的網路，則為目前連線的頻率。否則，為可用的最佳 BSS 頻率。

  • FrequencyList

    number[] 選填

    包含 Wi-Fi 網路最近的所有作業頻率。

  • HexSSID

    string 選填

    網路 SSID 的 16 進位編碼副本。

  • HiddenSSID

    boolean 選填

    是否要播送網路 SSID。

  • 通關密語

    string 選填

    Chrome 66 以上版本

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

  • RoamThreshold

    號碼 選填

    已淘汰，會遭到忽略。

  • SSID

    string 選填

    網路 SSID。

  • 安全性

    string 選填

    網路安全性類型。

  • SignalStrength

    號碼 選填

    網路訊號強度。

WiFiStateProperties

屬性

WiMAXProperties

屬性

  • AutoConnect

    boolean 選填

    是否應自動連線至網路。

  • EAP

    EAPProperties 選填

    網路 EAP 屬性。

方法

createNetwork()

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

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

參數

  • 已分享

    布林值

    如果是 true，請與其他使用者分享這項網路設定。

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

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

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (result: string) => void

    • 結果

      字串

傳回

  • Promise<string>

    Chrome 125 以上版本

    承諾僅支援資訊清單 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 和 Security)。如果不存在這類設定，系統會設定錯誤，且作業會失敗。

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

參數

  • networkGuid

    字串

    要清除的網路 GUID。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getCaptivePortalStatus()

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

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

參數

  • networkGuid

    字串

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

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (result: CaptivePortalStatus) => void

傳回

  • Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getDeviceStates()

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

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

參數

傳回

  • Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getGlobalPolicy()

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

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

參數

傳回

  • Promise<GlobalPolicy>

    Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getManagedProperties()

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

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

參數

  • networkGuid

    字串

    要取得屬性的聯播網 GUID。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (result: ManagedProperties) => void

傳回

  • Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getNetworks()

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

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

參數

傳回

  • Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getProperties()

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

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

參數

  • networkGuid

    字串

    要取得屬性的聯播網 GUID。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (result: NetworkProperties) => void

傳回

  • Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getState()

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

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

參數

傳回

  • Chrome 125 以上版本

    承諾僅支援資訊清單 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 的網路屬性。這項設定僅適用於已設定的聯播網 (Source != None)。未設定的公開網路應改用 createNetwork。在資訊亭工作階段中，在共用網路上呼叫這個方法會失敗。

參數

  • networkGuid

    字串

    要設定屬性的聯播網 GUID。

  • 要設定的屬性。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

startConnect()

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

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

參數

  • networkGuid

    字串

    要連線的網路 GUID。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

startDisconnect()

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

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

參數

  • networkGuid

    字串

    要中斷連線的網路 GUID。

  • 回呼

    函式 選填

    callback 參數如下所示： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    承諾僅支援資訊清單 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 和相應的網頁認證入口狀態。

參數