chrome.networking.onc

説明

chrome.networking.onc API は、ネットワーク接続（モバイル、イーサネット、VPN、Wi-Fi）の構成に使用されます。この API は、自動起動された ChromeOS キオスク セッションで使用できます。

ネットワーク接続の構成は、Open Network Configuration（ONC）仕様に従って指定します。

注: ほとんどの辞書プロパティと列挙型の値では、JavaScript の lowerCamelCase 表記法ではなく、ONC 仕様に一致するように UpperCamelCase を使用しています。

権限

networking.onc

対象

Chrome 59 以降 ChromeOS のみ

型

ActivationStateType

列挙型

「有効」

「有効化中」

「NotActivated」

「PartiallyActivated」

CaptivePortalStatus

列挙型

「不明」

[オフライン]

[オンライン]

[Portal]

「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

    number（省略可）

    現在のネットワークの電波強度。

  • SupportNetworkScan

    ブール値（省略可）

    モバイル ネットワークがスキャンをサポートしているかどうか。

CellularProviderProperties

プロパティ

  • コード

    文字列

    モバイル ネットワーク ID: ネットワークの MCC（モバイル カントリー コード）と MNC（モバイル ネットワーク コード）を単純に連結したものです。

  • 国

    文字列（省略可）

    2 文字の国コード。

  • 名前

    文字列

    運転手の名前。

CellularStateProperties

プロパティ

CertificatePattern

プロパティ

  • EnrollmentURI

    string[] 省略可

    このパターンに一致する証明書が見つからない場合にユーザーをリダイレクトする URI のリスト。

  • 発行元

    IssuerSubjectPattern（省略可）

    設定されている場合、X.509 発行元の設定を照合するパターン。

  • IssuerCARef

    string[] 省略可

    証明書発行元の CA 証明書のリスト。このパターンに一致するには、証明書がこれらのいずれかによって署名されている必要があります。

  • 件名

    IssuerSubjectPattern（省略可）

    設定されている場合、X.509 サブジェクトの設定を照合するパターン。

ClientCertificateType

列挙型

"Ref"

[パターン]

ConnectionStateType

列挙型

「接続済み」

「接続中」

「NotConnected」

DeviceStateProperties

プロパティ

  • SIMLockStatus

    SIMLockStatus 省略可

    Chrome 62 以降

    Type = Cellular で SIMPresent = True の場合の SIM ロック ステータス。

  • SIMPresent

    ブール値（省略可）

    Chrome 62 以降

    デバイスタイプがモバイルの場合、SIM の存在状態に設定します。

  • スキャン

    ブール値（省略可）

    デバイスが有効かどうかを設定します。デバイスが現在スキャン中の場合は true。

  • デバイスの現在の状態。

  • タイプ

    NetworkType

    デバイスに関連付けられているネットワーク タイプ（モバイル、イーサネット、Wi-Fi）。

DeviceStateType

列挙型

「未初期化」
デバイスは使用可能だが初期化されていない。

「無効」
デバイスは初期化されていますが、有効になっていません。

「有効化中」
有効な状態がリクエストされていますが、完了していません。

[有効]
デバイスが有効になっています。

「禁止」
デバイスが禁止されています。

EAPProperties

プロパティ

  • AnonymousIdentity

    文字列（省略可）

  • ClientCertPKCS11Id

    文字列（省略可）

    Chrome 60 以降
  • ClientCertPattern

    CertificatePattern 省略可

  • ClientCertProvisioningProfileId

    文字列（省略可）

    Chrome 93 以降
  • ClientCertRef

    文字列（省略可）

  • ClientCertType

    ClientCertificateType

  • ID

    文字列（省略可）

  • 内部

    文字列（省略可）

  • 外部

    文字列（省略可）

    外側の 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

    number（省略可）

    ルーティング プレフィックス。

  • SearchDomains

    string[] 省略可

    Chrome 76 以降

    名前解決用の文字列の配列。詳細については、onc_spec.md をご覧ください。

  • タイプ

    文字列（省略可）

    IP 構成タイプ。IPv4 または IPv6 のいずれかです。

  • WebProxyAutoDiscoveryUrl

    文字列（省略可）

    DHCP 経由で報告された、ウェブプロキシ自動検出の URL。

IPConfigType

列挙型

「DHCP」

「静的」

IssuerSubjectPattern

プロパティ

  • CommonName

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの共通名と照合する値。

  • 地区

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの共通ロケーションと照合する値。

  • 組織

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの組織と照合する値。少なくとも 1 つの組織が値と一致している必要があります。

  • OrganizationalUnit

    文字列（省略可）

    設定されている場合、証明書のサブジェクトの組織部門と照合する値。少なくとも 1 つの組織部門が値と一致している必要があります。

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

プロパティ

  • 有効

    number（省略可）

    ネットワーク構成マネージャー（Shill など）で現在使用されているアクティブな値。

  • DeviceEditable

    ブール値（省略可）

    プロパティの DevicePolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーセットの推奨プロパティ値）。デフォルトは false です。

  • DevicePolicy

    number（省略可）

    デバイス ポリシーによって提供されるプロパティ値。

  • 発効

    文字列（省略可）

    有効なプロパティ値が決定されたソース。

  • SharedSetting

    number（省略可）

    デバイスのすべてのユーザーに設定される値。DeviceEditiable が true の場合にのみ指定します。

  • UserEditable

    ブール値（省略可）

    プロパティの UserPolicy が存在し、プロパティの編集が許可されているかどうか（つまり、ポリシーで推奨されるプロパティ値が設定されているかどうか）。デフォルトは false です。

  • UserPolicy

    number（省略可）

    ユーザー ポリシーによって指定されたプロパティ値。

  • UserSetting

    number（省略可）

    ログインしたユーザーが設定したプロパティ値。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

プロパティ

  • FTPProxy

    ProxyLocation（省略可）

    FTP プロキシの設定。

  • HTTPProxy

    ProxyLocation（省略可）

    HTTP プロキシの設定。

  • SOCKS

    ProxyLocation（省略可）

    SOCKS プロキシの設定。

  • SecureHTTPProxy

    ProxyLocation（省略可）

    安全な HTTP プロキシの設定。

NetworkConfigProperties

プロパティ

NetworkFilter

プロパティ

  • 構成済み

    ブール値（省略可）

    true の場合、構成済み（保存済み）のネットワークのみが含まれます。デフォルトは「false」です。

  • limit

    number（省略可）

    返されるネットワークの最大数。指定しない場合のデフォルトは 1,000 です。上限なしの場合は 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 構成タイプ。

  • 優先度

    number（省略可）

    ネットワークの優先度。

  • ProxySettings

    ProxySettings（省略可）

    ネットワークのプロキシ設定。

  • RestrictedConnectivity

    ブール値（省略可）

    接続されているネットワークの場合、インターネットへのネットワーク接続が制限されているかどうか（ネットワークがポータルの背後にある場合や、モバイル ネットワークが有効になっていない場合など）。

  • SavedIPConfig

    IPConfigProperties 省略可

    静的 IP 構成を適用する前に DHCP サーバーから受信した IP 構成。

  • ソース

    文字列（省略可）

    ネットワークが構成されているかどうかと、その方法を示します。次の値があります。

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

    「None」は拡張機能のコード生成と競合するため、SourceType 列挙型ではなく文字列を「Source」に使用する必要があります。

  • StaticIPConfig

    IPConfigProperties 省略可

    ネットワークの静的 IP 構成。

  • TrafficCounterResetTime

    number（省略可）

    Chrome 125 以降

    トラフィック カウンタが最後にリセットされた日時。

  • タイプ

    NetworkType

    ネットワークの種類。

  • VPN

    VPNProperties（省略可）

    VPN ネットワークの場合は、ネットワーク VPN プロパティ。

  • Wi-Fi

    WiFiProperties（省略可）

    Wi-Fi ネットワークの場合は、ネットワークの Wi-Fi プロパティ。

NetworkStateProperties

プロパティ

NetworkType

列挙型

[すべて]

[モバイル]

[イーサネット]

[テザリング]

[VPN]

[ワイヤレス]

[Wi-Fi]

PaymentPortal

プロパティ

  • メソッド

    文字列

    支払いポータルに使用する HTTP メソッド。

  • PostData

    文字列（省略可）

    決済ポータルに送信する POST データ。Method が POST でない場合は無視されます。

  • URL

    文字列（省略可）

    決済ポータルの URL。

ProxyLocation

プロパティ

  • ホスト

    文字列

    プロキシの IP アドレス ホスト。

  • ポート

    数値

    プロキシに使用するポート。

ProxySettings

プロパティ

  • ExcludeDomains

    string[] 省略可

    手動プロキシ設定が除外されるドメインとホスト。

  • 手動

    ManualProxySettings（省略可）

    手動プロキシ設定 - Manual プロキシ設定にのみ使用されます。

  • PAC

    文字列（省略可）

    プロキシ自動設定ファイルの URL。

  • タイプ

    ProxySettingsType

    プロキシ設定のタイプ。

ProxySettingsType

列挙型

「直接」

[手動]

「PAC」

「WPAD」

SIMLockStatus

プロパティ

  • LockEnabled

    ブール値

    SIM ロックが有効かどうか。

  • LockType

    文字列

    SIM ロックのステータス - 有効な値は 'sim-pin'、'sim-puk'、'' です。

  • RetriesLeft

    number（省略可）

    SIM のロック解除に PUK が必要になるまでの PIN ロックの試行回数。

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 ネットワークに必須です。

  • 頻度

    number（省略可）

    Wi-Fi サービスの動作周波数（MHz）。接続されているネットワークの場合は、ネットワークが接続されている現在の周波数。それ以外の場合は、利用可能な最適な BSS の周波数。

  • FrequencyList

    number[] 省略可

    Wi-Fi ネットワークで最近検出されたすべての動作周波数を含みます。

  • HexSSID

    文字列（省略可）

    ネットワーク SSID の 16 進数エンコード コピー。

  • HiddenSSID

    ブール値（省略可）

    ネットワーク SSID をブロードキャストするかどうか。

  • パスフレーズ

    文字列（省略可）

    Chrome 66 以降

    WEP/WPA/WPA2 接続のパスフレーズ。このプロパティは設定のみ可能です。getProperties によって返されるプロパティには、この値は含まれません。

  • RoamThreshold

    number（省略可）

    非推奨で、無視されます。

  • SSID

    文字列（省略可）

    ネットワークの SSID。

  • セキュリティ

    文字列（省略可）

    ネットワーク セキュリティの種類。

  • SignalStrength

    number（省略可）

    ネットワークの電波強度。

WiFiStateProperties

プロパティ

WiMAXProperties

プロパティ

  • AutoConnect

    ブール値（省略可）

    ネットワークを自動的に接続するかどうか。

  • EAP

    EAPProperties 省略可

    ネットワーク EAP プロパティ。

メソッド

createNetwork()

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

プロパティから新しいネットワーク構成を作成します。一致する構成済みネットワークがすでに存在する場合、この操作は失敗します。そうでない場合は、新しいネットワークの GUID を返します。

パラメータ

  • 共有

    ブール値

    true の場合は、このネットワーク構成を他のユーザーと共有します。

    このオプションは Chrome のウェブ UI にのみ公開されます。* アプリから呼び出される場合は、false のみが許可される値です。

  • プロパティ

    NetworkConfigProperties

    新しいネットワークを構成するプロパティ。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    (result: string) => void

    • 件の結果

      文字列

戻り値

  • Promise<string>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

disableNetworkType()

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

指定したネットワーク タイプに一致するデバイスをすべて無効にします。enableNetworkType のメモを参照。

パラメータ

  • networkType

    NetworkType

    無効にするネットワークのタイプ。

enableNetworkType()

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

指定したネットワーク タイプに一致するすべてのデバイスを有効にします。なお、このタイプは複数のネットワーク タイプを表す場合があります（例: 「ワイヤレス」）。

パラメータ

  • networkType

    NetworkType

    有効にするネットワークのタイプ。

forgetNetwork()

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

GUID networkGuid のネットワークで構成されているプロパティをすべて消去して、ネットワーク設定を削除します。識別子（Wi-Fi の SSID やセキュリティなど）が一致する他のネットワークも含まれる場合があります。このような構成が存在しない場合、エラーが設定され、オペレーションは失敗します。

キオスク セッションでは、この方法で共有ネットワーク構成を削除できません。

パラメータ

  • networkGuid

    文字列

    削除するネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getCaptivePortalStatus()

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

「networkGuid」に一致するネットワークのキャプティブ ポータルのステータスを返します。

パラメータ

  • networkGuid

    文字列

    キャプティブ ポータルのステータスを取得するネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    (result: CaptivePortalStatus) => void

戻り値

  • Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getDeviceStates()

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

使用可能なネットワーキング デバイスの状態を返します。

パラメータ

戻り値

  • Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getGlobalPolicy()

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

グローバル ポリシーのプロパティを取得します。これらのプロパティは、セッション中に変更されることは想定されていません。

パラメータ

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    (result: GlobalPolicy) => void

戻り値

  • Promise<GlobalPolicy>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getManagedProperties()

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

ID が networkGuid のネットワークの統合プロパティを、ユーザー設定、共有設定、ユーザー ポリシー、デバイス ポリシー、現在アクティブな設定のソースから取得します。

パラメータ

  • networkGuid

    文字列

    プロパティを取得するネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    (result: ManagedProperties) => void

戻り値

  • Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getNetworks()

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

getState によって提供されるプロパティが同じネットワーク オブジェクトのリストを返します。フィルタを使用して、返されるネットワークのタイプを指定し、ネットワークの数を制限できます。ネットワークは優先度に基づいてシステムによって並べ替えられ、接続済みまたは接続中のネットワークが最初に表示されます。

パラメータ

戻り値

  • Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getProperties()

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

ID が networkGuid のネットワークのすべてのプロパティを取得します。ネットワークのすべてのプロパティ（読み取り専用値と読み取り/書き込み値）が含まれます。

パラメータ

  • networkGuid

    文字列

    プロパティを取得するネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    (result: NetworkProperties) => void

戻り値

  • Chrome 125 以降

    Promise は Manifest 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 などの追加プロパティが用意されています。

パラメータ

  • networkGuid

    文字列

    プロパティを取得するネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    (result: NetworkStateProperties) => void

戻り値

  • 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 のネットワークのプロパティを設定します。これは、構成済みのネットワーク（Source != None）でのみ有効です。構成されていない公開ネットワークには、代わりに createNetwork を使用する必要があります。キオスク セッションでは、共有ネットワークでこのメソッドを呼び出すと失敗します。

パラメータ

  • networkGuid

    文字列

    プロパティを設定するネットワークの GUID。

  • プロパティ

    NetworkConfigProperties

    設定するプロパティ。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

startConnect()

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

networkGuid を使用してネットワークへの接続を開始します。

パラメータ

  • networkGuid

    文字列

    接続先のネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<void>

    Chrome 125 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

startDisconnect()

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

networkGuid を使用してネットワークからの切断を開始します。

パラメータ

  • networkGuid

    文字列

    切断するネットワークの GUID。

  • callback

    function 省略可

    callback パラメータは次のようになります。 

    () => void

戻り値

  • Promise<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 と対応するキャプティブ ポータルのステータスを送信します。

パラメータ