chrome.networking.onc

説明

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

ネットワーク接続構成は、オープン ネットワーク構成（ONC）仕様に従って指定されます。

NOTE: ほとんどの辞書プロパティと列挙値は、JavaScript の lowerCamelCase 規則ではなく、ONC 仕様に合わせて UpperCamelCase を使用します。

権限

networking.onc

対象

Chrome 59 以降 ChromeOS のみ

型

ActivationStateType

列挙型

「有効」

「有効化中」

「NotActivated」

「PartiallyActivated」

CaptivePortalStatus

列挙型

「不明」

「オフライン」

「オンライン」

「ポータル」

"ProxyAuthRequired"

CellularProperties

プロパティ

  • ActivationState

    ActivationStateType 省略可

    携帯通信会社のアカウントの有効化状態。

  • ActivationType

    文字列 省略可

    モバイル ネットワークの有効化タイプ。

  • AllowRoaming

    boolean 省略可

    ネットワークでローミングが許可されているかどうか。

  • AutoConnect

    boolean 省略可

    モバイル ネットワークに自動的に接続するかどうか（圏内の場合）。

  • 家族向け

    文字列 省略可

    モバイル デバイスのテクノロジー ファミリー - CDMA または GSM。

  • FirmwareRevision

    文字列 省略可

    モバイル モデムに読み込まれているファームウェアのリビジョン。

  • FoundNetworks

    FoundNetworkProperties[] 省略可

    最新のネットワーク スキャンで検出されたネットワークのリスト。

  • HardwareRevision

    文字列 省略可

    モバイル モデムのハードウェア リビジョン。

  • HomeProvider

    CellularProviderProperties 省略可

    モデムに現在インストールされている SIM カードを発行した事業者に関する情報。

  • メーカー

    文字列 省略可

    モバイル モデムのメーカー。

  • ModelID

    文字列 省略可

    モバイル モデムのモデル ID。

  • NetworkTechnology

    文字列 省略可

    モデムがネットワークに登録されている場合、現在使用されているネットワーク テクノロジー。

  • PaymentPortal

    PaymentPortal 省略可

    ユーザーがモバイルデータ プランの登録や変更に使用できるオンライン決済ポータル。

  • RoamingState

    文字列 省略可

    現在のネットワークにおけるモバイル モデムのローミング状態。

  • SIMLockStatus

    SIMLockStatus 省略可

    GSM ファミリー ネットワークの SIM ロックの状態。

  • SIMPresent

    boolean 省略可

    SIM カードが挿入されているかどうか。

  • スキャン

    boolean 省略可

    Chrome 63 以降

    モバイル ネットワークのスキャンが進行中の場合は true。

  • ServingOperator

    CellularProviderProperties 省略可

    モデムが現在登録されているネットワークのオペレーターに関する情報。

  • SignalStrength

    number 省略可

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

  • SupportNetworkScan

    boolean 省略可

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

CellularProviderProperties

プロパティ

  • コード

    文字列

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

  • 国

    文字列 省略可

    2 文字の国コード。

  • 名前

    文字列

    オペレーター名。

CellularStateProperties

プロパティ

CertificatePattern

プロパティ

  • EnrollmentURI

    string[] 省略可

    このパターンに一致する証明書が見つからない場合にユーザーを誘導できる URI のリスト。

  • 発行元

    IssuerSubjectPattern 省略可

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

  • IssuerCARef

    string[] 省略可

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

  • 件名

    IssuerSubjectPattern 省略可

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

ClientCertificateType

列挙型

「Ref」

"Pattern"

ConnectionStateType

列挙型

「接続済み」

「接続中」

"NotConnected"

DeviceStateProperties

プロパティ

  • SIMLockStatus

    SIMLockStatus 省略可

    Chrome 62 以降

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

  • SIMPresent

    boolean 省略可

    Chrome 62 以降

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

  • スキャン

    boolean 省略可

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

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

  • タイプ

    NetworkType

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

DeviceStateType

列挙型

「未初期化」
デバイスは利用可能ですが、初期化されていません。

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

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

「有効」
デバイスは有効です。

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

EAPProperties

プロパティ

  • AnonymousIdentity

    文字列 省略可

  • ClientCertPKCS11Id

    文字列 省略可

    Chrome 60 以降
  • ClientCertPattern

    CertificatePattern 省略可

  • ClientCertProvisioningProfileId

    文字列 省略可

    Chrome 93 以降
  • ClientCertRef

    文字列 省略可

  • ClientCertType

    ClientCertificateType

  • ID

    文字列 省略可

  • 内部

    文字列 省略可

  • 外部

    文字列 省略可

    外部 EAP タイプ。ONC で必須ですが、Shill からの変換時に提供されない場合があります。

  • パスワード

    文字列 省略可

  • SaveCredentials

    boolean 省略可

  • ServerCAPEMs

    string[] 省略可

  • ServerCARefs

    string[] 省略可

  • SubjectMatch

    ManagedDOMString 省略可

    Chrome 60 以降
  • UseProactiveKeyCaching

    boolean 省略可

  • UseSystemCAs

    boolean 省略可

EthernetProperties

プロパティ

  • 認証

    文字列 省略可

    イーサネット ネットワークで使用される認証。有効な値は None と 8021X です。

  • AutoConnect

    boolean 省略可

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

  • EAP

    EAPProperties 省略可

    ネットワークの EAP 設定。8021X 認証に必要です。

EthernetStateProperties

プロパティ

FoundNetworkProperties

プロパティ

  • LongName

    文字列 省略可

    ネットワーク オペレーターの長い形式の名前。

  • NetworkId

    文字列

    ネットワーク ID。

  • ShortName

    文字列 省略可

    携帯通信会社の短い形式の名前。

  • ステータス

    文字列

    ネットワークの可用性。

  • テクノロジー

    文字列

    ネットワークで使用されるアクセス技術。

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 をご覧ください。

  • ゲートウェイ

    文字列 省略可

    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

プロパティ

  • 有効

    boolean 省略可

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

  • DeviceEditable

    boolean 省略可

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

  • DevicePolicy

    boolean 省略可

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

  • 発効

    文字列 省略可

    有効なプロパティ値の決定元。

  • SharedSetting

    boolean 省略可

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

  • UserEditable

    boolean 省略可

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

  • UserPolicy

    boolean 省略可

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

  • UserSetting

    boolean 省略可

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedCellularProperties

プロパティ

ManagedDOMString

プロパティ

  • 有効

    文字列 省略可

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

  • DeviceEditable

    boolean 省略可

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

  • DevicePolicy

    文字列 省略可

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

  • 発効

    文字列 省略可

    有効なプロパティ値の決定元。

  • SharedSetting

    文字列 省略可

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

  • UserEditable

    boolean 省略可

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

  • UserPolicy

    文字列 省略可

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

  • UserSetting

    文字列 省略可

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedDOMStringList

プロパティ

  • 有効

    string[] 省略可

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

  • DeviceEditable

    boolean 省略可

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

  • DevicePolicy

    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 省略可

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

  • 発効

    文字列 省略可

    有効なプロパティ値の決定元。

  • SharedSetting

    IPConfigType 省略可

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

  • UserEditable

    boolean 省略可

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

  • UserPolicy

    IPConfigType 省略可

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

  • UserSetting

    IPConfigType 省略可

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedLong

プロパティ

  • 有効

    number 省略可

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

  • DeviceEditable

    boolean 省略可

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

  • DevicePolicy

    number 省略可

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

  • 発効

    文字列 省略可

    有効なプロパティ値の決定元。

  • SharedSetting

    number 省略可

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

  • UserEditable

    boolean 省略可

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

  • UserPolicy

    number 省略可

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

  • UserSetting

    number 省略可

    ログイン ユーザーが設定したプロパティ値。UserEditable が true の場合にのみ指定します。

ManagedManualProxySettings

プロパティ

ManagedProperties

プロパティ

ManagedProxyLocation

プロパティ

ManagedProxySettings

プロパティ

ManagedProxySettingsType

プロパティ

  • 有効

    ProxySettingsType 省略可

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

  • DeviceEditable

    boolean 省略可

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

  • DevicePolicy

    ProxySettingsType 省略可

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

  • 発効

    文字列 省略可

    有効なプロパティ値の決定元。

  • SharedSetting

    ProxySettingsType 省略可

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

  • UserEditable

    boolean 省略可

    プロパティの 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

プロパティ

  • 構成済み

    boolean 省略可

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

  • limit

    number 省略可

    返されるネットワークの最大数。指定しない場合、デフォルトは 1,000 です。制限なしの場合は 0 を使用します。

  • networkType

    NetworkType

    返されるネットワークのタイプ。

  • 表示

    boolean 省略可

    true の場合、表示可能な（物理的に接続されているか、範囲内にある）ネットワークのみが含まれます。デフォルトは「false」です。

NetworkProperties

プロパティ

  • モバイル

    CellularProperties 省略可

    モバイル ネットワークの場合は、モバイル ネットワークのプロパティ。

  • 接続性の向上

    boolean 省略可

    ネットワークが接続可能かどうか。

  • ConnectionState

    ConnectionStateType 省略可

    ネットワークの現在の接続状態。

  • ErrorState

    文字列 省略可

    最後に記録されたネットワーク エラー状態。

  • イーサネット

    EthernetProperties 省略可

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

  • GUID

    文字列

    ネットワーク GUID。

  • IPAddressConfigType

    IPConfigType 省略可

    ネットワークの IP アドレス構成タイプ。

  • IPConfigs

    IPConfigProperties[] 省略可

    ネットワークの IP 構成。

  • MacAddress

    文字列 省略可

    ネットワークの MAC アドレス。

  • 従量制

    boolean 省略可

    Chrome 85 以降

    ネットワークが従量制かどうか。

  • 名前

    文字列 省略可

    ユーザー フレンドリーなネットワーク名。

  • NameServersConfigType

    IPConfigType 省略可

    ネットワークで使用されるネームサーバーの IP 構成タイプ。

  • 優先度

    number 省略可

    ネットワークの優先度。

  • ProxySettings

    ProxySettings 省略可

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

  • RestrictedConnectivity

    boolean 省略可

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

  • 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

    boolean 省略可

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

  • ホスト

    文字列 省略可

    VPN ホスト。

  • タイプ

    文字列 省略可

    VPN の種類。「L2TP-IPSec」のため、これは列挙型にできません。これは、setProperties に渡される NetworkConfigProperties のオプションです。setProperties は、特定のプロパティのみを設定するために使用できます。

VPNStateProperties

プロパティ

WiFiProperties

プロパティ

  • AllowGatewayARPPolling

    boolean 省略可

    Chrome 131 以降、非推奨

    M131 で削除されました。現在、アクティブな ARP ポーリングはありません。

  • AutoConnect

    boolean 省略可

    圏内に入ったときに Wi-Fi ネットワークに自動的に接続するかどうか。

  • BSSID

    文字列 省略可

    関連付けられているアクセス ポイントの BSSID。

  • EAP

    EAPProperties 省略可

    ネットワークの EAP プロパティ。WEP-8021X ネットワークと WPA-EAP ネットワークに必要です。

  • 頻度

    number 省略可

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

  • FrequencyList

    number[] 省略可

    Wi-Fi ネットワークで最近確認されたすべての動作周波数が含まれます。

  • HexSSID

    文字列 省略可

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

  • HiddenSSID

    boolean 省略可

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

  • パスフレーズ

    文字列 省略可

    Chrome 66 以降

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

  • RoamThreshold

    number 省略可

    非推奨となり、無視されます。

  • SSID

    文字列 省略可

    ネットワーク SSID。

  • セキュリティ

    文字列 省略可

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

  • SignalStrength

    number 省略可

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

WiFiStateProperties

プロパティ

WiMAXProperties

プロパティ

  • AutoConnect

    boolean 省略可

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

  • EAP

    EAPProperties 省略可

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

メソッド

createNetwork()

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

プロパティから新しいネットワーク構成を作成します。一致する構成済みネットワークがすでに存在する場合、この処理は失敗します。それ以外の場合は、新しいネットワークの 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,
): void

指定したネットワーク タイプに一致するデバイスを無効にします。enableNetworkType の注をご覧ください。

パラメータ

  • networkType

    NetworkType

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

enableNetworkType()

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

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

パラメータ

  • networkType

    NetworkType

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

forgetNetwork()

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

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,
): Promise<CaptivePortalStatus>

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

パラメータ

  • networkGuid

    文字列

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

  • callback

    function 省略可

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

    (result: CaptivePortalStatus) => void

戻り値

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

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

パラメータ

  • callback

    function 省略可

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

    (result: GlobalPolicy) => void

戻り値

  • Promise<GlobalPolicy>

    Chrome 125 以降

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

getManagedProperties()

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

ユーザー設定、共有設定、ユーザー ポリシー、デバイス ポリシー、現在有効な設定のソースから、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,
): Promise<NetworkStateProperties[]>

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

パラメータ

戻り値

  • Chrome 125 以降

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

getProperties()

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

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,
): Promise<NetworkStateProperties>

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,
): void

ネットワーク サブシステムが新しいネットワークをスキャンし、getVisibleNetworks から返されたリストを更新するようリクエストします。これはリクエストにすぎず、ネットワーク サブシステムはこれを無視できます。リストが更新されると、onNetworkListChanged イベントが発生します。

パラメータ

  • networkType

    NetworkType 省略可

    Chrome 63 以降

    指定すると、そのタイプに固有のスキャンがリクエストされます。モバイルの場合、サポートされていればモバイル ネットワーク スキャンがリクエストされます。

setProperties()

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

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,
): Promise<void>

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

パラメータ

  • networkGuid

    文字列

    接続するネットワークの GUID。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 125 以降

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

startDisconnect()

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

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

パラメータ

  • callback

    関数

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

    (networkGuid: string, status: CaptivePortalStatus) => void