chrome.networking.onc

説明

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

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

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

権限

networking.onc

可用性

Chrome 59 以降 ChromeOS のみ

型

ActivationStateType

列挙型

CaptivePortalStatus

列挙型

CellularProperties

プロパティ

  • ActivationState

    ActivationStateType 省略可

    携帯通信会社のアカウントの有効化ステータス。

  • ActivationType

    string（省略可）

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

  • AllowRoaming

    ブール値（省略可）

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

  • AutoConnect

    ブール値（省略可）

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

  • 家族向け

    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

    ブール値（省略可）

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

  • スキャン

    ブール値（省略可）

    Chrome 63 以降

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

  • ServingOperator

    CellularProviderProperties 省略可

    現在モデムが登録されているネットワークの事業者に関する情報。

  • SignalStrength

    number（省略可）

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

  • SupportNetworkScan

    ブール値（省略可）

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

CellularProviderProperties

プロパティ

  • コード

    文字列

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

  • 国

    string（省略可）

    2 文字の国コード。

  • 名前

    文字列

    演算子名。

CellularStateProperties

プロパティ

CertificatePattern

プロパティ

  • EnrollmentURI

    string[] 省略可

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

  • 発行元

    IssuerSubjectPattern 省略可

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

  • IssuerCARef

    string[] 省略可

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

  • 対象

    IssuerSubjectPattern 省略可

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

ClientCertificateType

列挙型

ConnectionStateType

列挙型

DeviceStateProperties

プロパティ

  • SIMLockStatus

    SIMLockStatus（省略可）

    Chrome 62 以降

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

  • SIMPresent

    ブール値（省略可）

    Chrome 62 以降

    デバイスの種類がモバイルの場合、SIM の状態に設定されます。

  • スキャン

    ブール値（省略可）

    デバイスが有効な場合に設定します。デバイスが現在スキャンしている場合は true。

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

  • タイプ

    NetworkType

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

DeviceStateType

列挙型

"Uninitiald"
デバイスは使用できますが、初期化されていません。

"Disabled"
デバイスは初期化されていますが、有効ではありません。

"有効"
有効状態がリクエストされましたが、完了していません。

"有効"
デバイスは有効です。

"Prohibited"
デバイスは禁止されています。

EAPProperties

プロパティ

  • AnonymousIdentity

    string（省略可）

  • ClientCertPKCS11Id

    string（省略可）

    Chrome 60 以降
  • ClientCertPattern

    CertificatePattern 省略可

  • ClientCertProvisioningProfileId

    string（省略可）

    Chrome 93 以降
  • ClientCertRef

    string（省略可）

  • ClientCertType

    ClientCertificateType

  • ID

    string（省略可）

  • 内部結合

    string（省略可）

  • 外側

    string（省略可）

    外部 EAP タイプ。ONC では必須ですが、Shill から翻訳する場合は指定されないことがあります。

  • パスワード

    string（省略可）

  • SaveCredentials

    ブール値（省略可）

  • ServerCAPEMs

    string[] 省略可

  • ServerCARefs

    string[] 省略可

  • SubjectMatch

    ManagedDOMString 省略可

    Chrome 60 以降
  • UseProactiveKeyCaching

    ブール値（省略可）

  • UseSystemCAs

    ブール値（省略可）

EthernetProperties

プロパティ

  • エネルギー効率比率（EER）

    string（省略可）

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

  • AutoConnect

    ブール値（省略可）

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

  • EAP

    EAPProperties 省略可

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

EthernetStateProperties

プロパティ

FoundNetworkProperties

プロパティ

  • LongName

    string（省略可）

    ネットワーク事業者の長い形式の名前。

  • NetworkId

    文字列

    ネットワーク ID。

  • ShortName

    string（省略可）

    ネットワーク事業者の短い形式の名前。

  • ステータス

    文字列

    ネットワークの可用性。

  • テクノロジー

    文字列

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

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

  • ゲートウェイ

    string（省略可）

    IP 構成に使用されるゲートウェイ アドレス。

  • IPAddress

    string（省略可）

    接続の IP アドレス。Type の値に応じて、IPv4 アドレスまたは IPv6 アドレスになります。

  • IncludedRoutes

    string[] 省略可

    Chrome 76 以降

    CIDR 表記の IP ブロックの配列。詳細については、onc_spec.md をご覧ください。

  • NameServers

    string[] 省略可

    ネームサーバーに使用されるアドレスの配列。

  • RoutingPrefix

    number（省略可）

    ルーティング接頭辞。

  • SearchDomains

    string[] 省略可

    Chrome 76 以降

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

  • タイプ

    string（省略可）

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

  • WebProxyAutoDiscoveryUrl

    string（省略可）

    DHCP 経由で報告される WEb プロキシ自動検出の URL。

IPConfigType

列挙型

IssuerSubjectPattern

プロパティ

  • CommonName

    string（省略可）

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

  • 地域区分

    string（省略可）

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

  • 組織

    string（省略可）

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

  • OrganizationalUnit

    string（省略可）

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

ManagedBoolean

プロパティ

  • アクティブ

    ブール値（省略可）

    ネットワーク設定マネージャーが現在使用しているアクティブな値（例: Shill）。

  • DeviceEditable

    ブール値（省略可）

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

  • DevicePolicy

    ブール値（省略可）

    デバイス ポリシーが提供するプロパティ値。

  • 発効

    string（省略可）

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

  • SharedSetting

    ブール値（省略可）

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

  • UserEditable

    ブール値（省略可）

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

  • UserPolicy

    ブール値（省略可）

    ユーザー ポリシーで指定されたプロパティ値。

  • UserSetting

    ブール値（省略可）

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

ManagedCellularProperties

プロパティ

ManagedDOMString

プロパティ

  • アクティブ

    string（省略可）

    ネットワーク設定マネージャーが現在使用しているアクティブな値（例: Shill）。

  • DeviceEditable

    ブール値（省略可）

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

  • DevicePolicy

    string（省略可）

    デバイス ポリシーが提供するプロパティ値。

  • 発効

    string（省略可）

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

  • SharedSetting

    string（省略可）

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

  • UserEditable

    ブール値（省略可）

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

  • UserPolicy

    string（省略可）

    ユーザー ポリシーで指定されたプロパティ値。

  • UserSetting

    string（省略可）

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

ManagedDOMStringList

プロパティ

  • アクティブ

    string[] 省略可

    ネットワーク設定マネージャーが現在使用しているアクティブな値（例: Shill）。

  • DeviceEditable

    ブール値（省略可）

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

  • DevicePolicy

    string[] 省略可

    デバイス ポリシーが提供するプロパティ値。

  • 発効

    string（省略可）

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

  • SharedSetting

    string[] 省略可

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

  • UserEditable

    ブール値（省略可）

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

  • UserPolicy

    string[] 省略可

    ユーザー ポリシーで指定されたプロパティ値。

  • UserSetting

    string[] 省略可

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

ManagedEthernetProperties

プロパティ

ManagedIPConfigProperties

プロパティ

ManagedIPConfigType

プロパティ

  • アクティブ

    IPConfigType 省略可

    ネットワーク設定マネージャーが現在使用しているアクティブな値（例: Shill）。

  • DeviceEditable

    ブール値（省略可）

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

  • DevicePolicy

    IPConfigType 省略可

    デバイス ポリシーが提供するプロパティ値。

  • 発効

    string（省略可）

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

  • SharedSetting

    IPConfigType 省略可

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

  • UserEditable

    ブール値（省略可）

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

  • UserPolicy

    IPConfigType 省略可

    ユーザー ポリシーで指定されたプロパティ値。

  • UserSetting

    IPConfigType 省略可

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

ManagedLong

プロパティ

  • アクティブ

    number（省略可）

    ネットワーク設定マネージャーが現在使用しているアクティブな値（例: Shill）。

  • DeviceEditable

    ブール値（省略可）

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

  • DevicePolicy

    number（省略可）

    デバイス ポリシーが提供するプロパティ値。

  • 発効

    string（省略可）

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

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

    デバイス ポリシーが提供するプロパティ値。

  • 発効

    string（省略可）

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

  • 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」です。

  • 上限

    number（省略可）

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

  • networkType

    NetworkType

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

  • 表示

    ブール値（省略可）

    true の場合、可視（物理的に接続された、または範囲内）のネットワークのみを含めます。デフォルトは「false」です。

NetworkProperties

プロパティ

  • モバイル

    CellularProperties 省略可

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

  • 接続性の向上

    ブール値（省略可）

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

  • ConnectionState

    ConnectionStateType 省略可

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

  • ErrorState

    string（省略可）

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

  • イーサネット

    EthernetProperties 省略可

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

  • GUID

    文字列

    ネットワーク GUID。

  • IPAddressConfigType

    IPConfigType 省略可

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

  • IPConfigs

    IPConfigProperties[] 省略可

    ネットワークの IP 構成。

  • MacAddress

    string（省略可）

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

  • 従量制

    ブール値（省略可）

    Chrome 85 以降

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

  • 名前

    string（省略可）

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

  • NameServersConfigType

    IPConfigType 省略可

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

  • 優先度

    number（省略可）

    ネットワーク優先度。

  • ProxySettings

    ProxySettings 省略可

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

  • RestrictedConnectivity

    ブール値（省略可）

    接続ネットワークの場合、インターネットへのネットワーク接続が制限されているかどうか（たとえば、ネットワークがポータルの背後にあるか、モバイル ネットワークがアクティブになっていないか）。

  • SavedIPConfig

    IPConfigProperties 省略可

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

  • ソース

    string（省略可）

    ネットワークが構成されているかどうかと、その構成方法を表します。指定できる値は次のとおりです。

    • Device
    • DevicePolicy
    • User
    • UserPolicy
    • None

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

  • StaticIPConfig

    IPConfigProperties 省略可

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

  • TrafficCounterResetTime

    number（省略可）

    保留中

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

  • タイプ

    NetworkType

    ネットワークの種類。

  • VPN

    VPNProperties（省略可）

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

  • WiFi

    WiFiProperties（省略可）

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

NetworkStateProperties

プロパティ

NetworkType

列挙型

PaymentPortal

プロパティ

  • メソッド

    文字列

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

  • PostData

    string（省略可）

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

  • URL

    string（省略可）

    お支払いポータルの URL。

ProxyLocation

プロパティ

  • ホスト

    文字列

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

  • ポート

    数値

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

ProxySettings

プロパティ

  • ExcludeDomains

    string[] 省略可

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

  • 手動

    ManualProxySettings 省略可

    手動プロキシ設定 - Manual のプロキシ設定でのみ使用します。

  • PAC

    string（省略可）

    プロキシの自動構成ファイルの URL。

  • タイプ

    ProxySettingsType

    プロキシ設定のタイプ。

ProxySettingsType

列挙型

SIMLockStatus

プロパティ

  • LockEnabled

    boolean

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

  • LockType

    文字列

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

  • RetriesLeft

    number（省略可）

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

ThirdPartyVPNProperties

プロパティ

  • ExtensionID

    文字列

    サードパーティ VPN プロバイダの拡張機能の ID。

  • ProviderName

    string（省略可）

    VPN プロバイダ名。

VPNProperties

プロパティ

  • AutoConnect

    ブール値（省略可）

    VPN ネットワークを自動的に接続するかどうかを指定します。

  • ホスト

    string（省略可）

    VPN ホスト。

  • タイプ

    string（省略可）

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

VPNStateProperties

プロパティ

WiFiProperties

プロパティ

  • AllowGatewayARPPolling

    ブール値（省略可）

    デフォルト ゲートウェイの ARP ポーリングを許可するかどうか。デフォルトは true です。

  • AutoConnect

    ブール値（省略可）

    範囲内にある場合に Wi-Fi ネットワークを自動的に接続するかどうかを指定します。

  • BSSID

    string（省略可）

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

  • EAP

    EAPProperties 省略可

    ネットワーク EAP のプロパティ。WEP-8021X ネットワークと WPA-EAP ネットワークの場合は必須です。

  • 周波数

    number（省略可）

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

  • FrequencyList

    number[] 省略可

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

  • HexSSID

    string（省略可）

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

  • HiddenSSID

    ブール値（省略可）

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

  • パスフレーズ

    string（省略可）

    Chrome 66 以降

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

  • RoamThreshold

    number（省略可）

    非推奨、無視されました。

  • SSID

    string（省略可）

    ネットワーク SSID。

  • セキュリティ

    string（省略可）

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

  • SignalStrength

    number（省略可）

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

WiFiStateProperties

プロパティ

WiMAXProperties

プロパティ

  • AutoConnect

    ブール値（省略可）

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

  • EAP

    EAPProperties 省略可

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

Methods

createNetwork()

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

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

パラメータ

  • 共有

    boolean

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

    このオプションは Chrome のウェブ UI にのみ公開されます*。アプリによって呼び出される場合、指定できる値は false のみです。

  • プロパティ

    NetworkConfigProperties

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

  • callback

    関数（省略可）

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

    (result: string)=>void

    • 件の結果

      文字列

戻り値

  • Promise<文字列>

    保留中

    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

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    保留中

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

getCaptivePortalStatus()

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

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

パラメータ

  • networkGuid

    文字列

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

  • callback

    関数（省略可）

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

    (result: CaptivePortalStatus)=>void

戻り値

  • 保留中

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

getDeviceStates()

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

利用可能なネットワーク デバイスの状態を返します。

パラメータ

戻り値

  • 保留中

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

getGlobalPolicy()

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

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

パラメータ

  • callback

    関数（省略可）

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

    (result: GlobalPolicy)=>void

戻り値

  • Promise<GlobalPolicy>

    保留中

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

getManagedProperties()

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

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

パラメータ

  • networkGuid

    文字列

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

  • callback

    関数（省略可）

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

    (result: ManagedProperties)=>void

戻り値

  • 保留中

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

getNetworks()

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

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

パラメータ

戻り値

  • 保留中

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

getProperties()

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

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

パラメータ

  • networkGuid

    文字列

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

  • callback

    関数（省略可）

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

    (result: NetworkProperties)=>void

戻り値

  • 保留中

    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

    関数（省略可）

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

    (result: NetworkStateProperties)=>void

戻り値

  • 保留中

    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。

  • プロパティ

    NetworkConfigProperties

    設定するプロパティ。

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    保留中

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

startConnect()

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

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

パラメータ

  • networkGuid

    文字列

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

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    保留中

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

startDisconnect()

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

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

パラメータ

  • networkGuid

    文字列

    接続解除元のネットワークの GUID。

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    保留中

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

パラメータ