chrome.networking.onc

說明

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

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

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

權限

networking.onc

可用性

Chrome 59 以上版本 僅適用於 ChromeOS

類型

ActivationStateType

列舉

「已啟用」

「啟用」

「NotActivated」

「PartiallyActivated」

CaptivePortalStatus

列舉

「Unknown」

「離線」

「線上」

「入口」

「ProxyAuthRequired」

CellularProperties

屬性

  • ActivationState

    ActivationStateType optional

    電信業者帳戶啟用狀態。

  • ActivationType

    字串 選填

    行動網路啟用類型。

  • AllowRoaming

    布林值 選填

    網路是否允許漫遊。

  • AutoConnect

    布林值 選填

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

  • 家庭

    字串 選填

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

  • FirmwareRevision

    字串 選填

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

  • FoundNetworks

    FoundNetworkProperties[] optional

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

  • HardwareRevision

    字串 選填

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

  • HomeProvider

    CellularProviderProperties optional

    目前安裝在數據機中的 SIM 卡發卡機構資訊。

  • 製造商

    字串 選填

    行動數據機製造商。

  • ModelID

    字串 選填

    行動數據機型號 ID。

  • NetworkTechnology

    字串 選填

    數據機註冊的網路，以及目前使用的網路技術。

  • PaymentPortal

    PaymentPortal 選填

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

  • RoamingState

    字串 選填

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

  • SIMLockStatus

    SIMLockStatus optional

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

  • SIMPresent

    布林值 選填

    是否有 SIM 卡。

  • 掃描

    布林值 選填

    Chrome 63 以上版本

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

  • ServingOperator

    CellularProviderProperties optional

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

  • SignalStrength

    號碼 選填

    目前的網路訊號強度。

  • SupportNetworkScan

    布林值 選填

    行動網路是否支援掃描。

CellularProviderProperties

屬性

  • 程式碼

    字串

    行動網路 ID，由網路的 MCC (行動裝置國家/地區代碼) 和 MNC (行動網路代碼) 簡單串連而成。

  • 國家/地區

    字串 選填

    雙字母國家/地區代碼。

  • 名稱

    字串

    營運商名稱。

CellularStateProperties

屬性

CertificatePattern

屬性

  • EnrollmentURI

    字串陣列 選用

    如果找不到符合這個模式的憑證，使用者可前往的 URI 清單。

  • 核發機構

    IssuerSubjectPattern optional

    如果設定這個選項，系統會根據這個模式比對 X.509 簽發者設定。

  • IssuerCARef

    字串陣列 選用

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

  • 主旨

    IssuerSubjectPattern optional

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

ClientCertificateType

列舉

「Ref」

「模式」

ConnectionStateType

列舉

「已連線」

「連線中」

「NotConnected」

DeviceStateProperties

屬性

  • SIMLockStatus

    SIMLockStatus optional

    Chrome 62 以上版本

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

  • SIMPresent

    布林值 選填

    Chrome 62 以上版本

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

  • 掃描

    布林值 選填

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

  • 裝置目前的狀態。

  • 類型

    NetworkType

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

DeviceStateType

列舉

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

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

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

「已啟用」
裝置已啟用。

「禁止」
裝置遭到禁止。

EAPProperties

屬性

  • AnonymousIdentity

    字串 選填

  • ClientCertPKCS11Id

    字串 選填

    Chrome 60 以上版本
  • ClientCertPattern

    CertificatePattern optional

  • ClientCertProvisioningProfileId

    字串 選填

    Chrome 93 以上版本
  • ClientCertRef

    字串 選填

  • ClientCertType

    ClientCertificateType

  • 身分識別

    字串 選填

  • 內部

    字串 選填

  • 外部

    字串 選填

    外部 EAP 類型。ONC 規定必須提供，但從 Shill 翻譯時可能不會提供。

  • 密碼

    字串 選填

  • SaveCredentials

    布林值 選填

  • ServerCAPEMs

    字串陣列 選用

  • ServerCARefs

    字串陣列 選用

  • SubjectMatch

    ManagedDOMString optional

    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

    字串陣列 選用

    Chrome 86 以上版本

    已封鎖的聯播網清單。禁止連線至遭封鎖的網路。如要解除封鎖網路，請指定明確的網路設定。預設為空白清單。

IPConfigProperties

屬性

  • ExcludedRoutes

    字串陣列 選用

    Chrome 76 以上版本

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

  • 閘道

    字串 選填

    用於 IP 設定的閘道位址。

  • IPAddress

    字串 選填

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

  • IncludedRoutes

    字串陣列 選用

    Chrome 76 以上版本

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

  • NameServers

    字串陣列 選用

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

  • RoutingPrefix

    號碼 選填

    路徑前置字元。

  • SearchDomains

    字串陣列 選用

    Chrome 76 以上版本

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

  • 類型

    字串 選填

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

  • WebProxyAutoDiscoveryUrl

    字串 選填

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

IPConfigType

列舉

「DHCP」

「Static」

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

屬性

  • 有效

    字串陣列 選用

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

  • DeviceEditable

    布林值 選填

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

  • DevicePolicy

    字串陣列 選用

    裝置政策提供的屬性值。

  • 有效

    字串 選填

    系統判斷有效屬性值的來源。

  • SharedSetting

    字串陣列 選用

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

  • UserEditable

    布林值 選填

    資源是否有 UserPolicy，以及是否允許編輯資源 (即政策設定建議的屬性值)。預設值為 false。

  • UserPolicy

    字串陣列 選用

    使用者政策提供的值。

  • UserSetting

    字串陣列 選用

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

ManagedEthernetProperties

屬性

ManagedIPConfigProperties

屬性

ManagedIPConfigType

屬性

  • 有效

    IPConfigType optional

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

  • DeviceEditable

    布林值 選填

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

  • DevicePolicy

    IPConfigType optional

    裝置政策提供的屬性值。

  • 有效

    字串 選填

    系統判斷有效屬性值的來源。

  • SharedSetting

    IPConfigType optional

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

  • UserEditable

    布林值 選填

    資源是否有 UserPolicy，以及是否允許編輯資源 (即政策設定建議的屬性值)。預設值為 false。

  • UserPolicy

    IPConfigType optional

    使用者政策提供的值。

  • UserSetting

    IPConfigType optional

    登入使用者設定的屬性值。只有在 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 選用

    網路目前的連線狀態。

  • ErrorState

    字串 選填

    最後記錄的網路錯誤狀態。

  • 乙太網路

    EthernetProperties optional

    乙太網路的乙太網路屬性。

  • GUID

    字串

    網路 GUID。

  • IPAddressConfigType

    IPConfigType optional

    網路的 IP 位址設定類型。

  • IPConfigs

    IPConfigProperties[] optional

    網路的 IP 設定。

  • MacAddress

    字串 選填

    網路的 MAC 位址。

  • 計量付費

    布林值 選填

    Chrome 85 以上版本

    網路是否為計量付費。

  • 名稱

    字串 選填

    方便使用者辨識的網路名稱。

  • NameServersConfigType

    IPConfigType optional

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

  • 優先順序

    號碼 選填

    網路優先順序。

  • ProxySettings

    ProxySettings 選用

    網路的 Proxy 設定。

  • RestrictedConnectivity

    布林值 選填

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

  • SavedIPConfig

    IPConfigProperties optional

    從 DHCP 伺服器收到的 IP 設定 (套用靜態 IP 設定前)。

  • 來源

    字串 選填

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

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

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

  • StaticIPConfig

    IPConfigProperties optional

    網路的靜態 IP 設定。

  • TrafficCounterResetTime

    號碼 選填

    Chrome 125 以上版本

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

  • 類型

    NetworkType

    網路類型。

  • VPN

    VPNProperties optional

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

  • Wi-Fi

    WiFiProperties optional

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

NetworkStateProperties

屬性

NetworkType

列舉

「全部」

「行動網路」

「乙太網路」

「Tether」

「VPN」

「無線」

「Wi-Fi」

PaymentPortal

屬性

  • 方法

    字串

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

  • PostData

    字串 選填

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

  • 網址

    字串 選填

    付款入口網址。

ProxyLocation

屬性

  • 主機

    字串

    Proxy IP 位址主機。

  • 通訊埠

    數字

    Proxy 使用的通訊埠。

ProxySettings

屬性

  • ExcludeDomains

    字串陣列 選用

    手動 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」，這不能是列舉。傳遞至 setProperties 的 NetworkConfigProperties 為選用項目，可用於僅設定特定屬性。

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 的網頁使用者介面。* 應用程式呼叫時，唯一允許的值是 false。

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

  • callback

    函式 選用

    callback 參數如下： 

    (result: string) => void

    • 結果

      字串

傳回

  • Promise<string>

    Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

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

傳回

  • Promise<void>

    Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getCaptivePortalStatus()

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

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

參數

傳回

  • Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getDeviceStates()

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

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

參數

傳回

  • Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getGlobalPolicy()

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

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

參數

傳回

  • Promise<GlobalPolicy>

    Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getManagedProperties()

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

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

參數

傳回

  • Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getNetworks()

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

傳回具有 getState 提供相同屬性的網路物件清單。系統會提供篩選器，指定要傳回的網路類型，並限制網路數量。系統會根據優先順序排序網路，並優先列出已連線或正在連線的網路。

參數

傳回

  • Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getProperties()

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

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

參數

傳回

  • Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getState()

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

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

參數

傳回

  • Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

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。在資訊站工作階段中，對共用網路呼叫這個方法會失敗。

參數

  • networkGuid

    字串

    要設定屬性的網路 GUID。

  • 要設定的屬性。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

startConnect()

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

使用 networkGuid 啟動網路連線。

參數

  • networkGuid

    字串

    要連線的網路 GUID。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

startDisconnect()

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

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

參數

  • networkGuid

    字串

    要中斷連線的網路 GUID。

  • callback

    函式 選用

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 125 以上版本

    只有資訊清單 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

    • 變更

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

參數