chrome.networking.onc

Properties

• ActivationState

  ActivationStateType optional

  Carrier account activation state.

• ActivationType

  string optional

  The cellular network activation type.

• AllowRoaming

  boolean optional

  Whether roaming is allowed for the network.

• AutoConnect

  boolean optional

  Whether the cellular network should be connected automatically (when in range).

• Family

  string optional

  Cellular device technology family - CDMA or GSM.

• FirmwareRevision

  string optional

  The firmware revision loaded in the cellular modem.

• FoundNetworks

  FoundNetworkProperties[] optional

  The list of networks found during the most recent network scan.

• HardwareRevision

  string optional

  The cellular modem hardware revision.

• HomeProvider

  CellularProviderProperties optional

  Information about the operator that issued the SIM card currently installed in the modem.

• Manufacturer

  string optional

  The cellular modem manufacturer.

• ModelID

  string optional

  The cellular modem model ID.

• NetworkTechnology

  string optional

  If the modem is registered on a network, the network technology currently in use.

• PaymentPortal

  PaymentPortal optional

  Online payment portal a user can use to sign-up for or modify a mobile data plan.

• RoamingState

  string optional

  The roaming state of the cellular modem on the current network.

• SIMLockStatus

  SIMLockStatus optional

  The state of SIM lock for GSM family networks.

• SIMPresent

  boolean optional

  Whether a SIM card is present.

• Scanning

  boolean optional

  True when a cellular network scan is in progress.

• ServingOperator

  CellularProviderProperties optional

  Information about the operator on whose network the modem is currently registered.

• SignalStrength

  number optional

  The current network signal strength.

• SupportNetworkScan

  boolean optional

  Whether the cellular network supports scanning.

Properties

• Code

  string

  Cellular network ID as a simple concatenation of the network's MCC (Mobile Country Code) and MNC (Mobile Network Code).

• Country

  string optional

  The two-letter country code.

• Name

  string

  The operator name.

Properties

• ActivationState

  ActivationStateType optional

  See CellularProperties.ActivationState.

• NetworkTechnology

  string optional

  See CellularProperties.NetworkTechnology.

• RoamingState

  string optional

  See CellularProperties.RoamingState.

• SIMPresent

  boolean optional

  See CellularProperties.SIMPresent.

• SignalStrength

  number optional

  See CellularProperties.SignalStrength.

Properties

• EnrollmentURI

  string[] optional

  List of URIs to which the user can be directed in case no certificates that match this pattern are found.

• Issuer

  IssuerSubjectPattern optional

  If set, pattern against which X.509 issuer settings should be matched.

• IssuerCARef

  string[] optional

  List of certificate issuer CA certificates. A certificate must be signed by one of them in order to match this pattern.

• Subject

  IssuerSubjectPattern optional

  If set, pattern against which X.509 subject settings should be matched.

Properties

• SIMLockStatus

  SIMLockStatus optional

  The SIM lock status if Type = Cellular and SIMPresent = True.

• SIMPresent

  boolean optional

  Set to the SIM present state if the device type is Cellular.

• Scanning

  boolean optional

  Set if the device is enabled. True if the device is currently scanning.

• State

  DeviceStateType

  The current state of the device.

• Type

  NetworkType

  The network type associated with the device (Cellular, Ethernet or WiFi).

Properties

• AnonymousIdentity

  string optional
• ClientCertPKCS11Id

  string optional
• ClientCertPattern

  CertificatePattern optional
• ClientCertRef

  string optional
• ClientCertType

  ClientCertificateType
• Identity

  string optional
• Inner

  string optional
• Outer

  string optional

  The outer EAP type. Required by ONC, but may not be provided when translating from Shill.

• Password

  string optional
• SaveCredentials

  boolean optional
• ServerCAPEMs

  string[] optional
• ServerCARefs

  string[] optional
• SubjectMatch

  ManagedDOMString optional
• UseProactiveKeyCaching

  boolean optional
• UseSystemCAs

  boolean optional

Properties

• Authentication

  string optional

  The authentication used by the Ethernet network. Possible values are None and 8021X.

• AutoConnect

  boolean optional

  Whether the Ethernet network should be connected automatically.

• EAP

  EAPProperties optional

  Network's EAP settings. Required for 8021X authentication.

Properties

• Authentication

  string

  See EthernetProperties.Authentication.

Properties

• LongName

  string optional

  The network operator's long-format name.

• NetworkId

  string

  Network ID.

• ShortName

  string optional

  The network operator's short-format name.

• Status

  string

  Network availability.

• Technology

  string

  Access technology used by the network.

Properties

• AllowOnlyPolicyNetworksToAutoconnect

  boolean optional

  If true, only policy networks may auto connect. Defaults to false.

• AllowOnlyPolicyNetworksToConnect

  boolean optional

  If true, only policy networks may be connected to and no new networks may be added or configured. Defaults to false.

• AllowOnlyPolicyNetworksToConnectIfAvailable

  boolean optional

  If true and a managed network is available in the visible network list, only policy networks may be connected to and no new networks may be added or configured. Defaults to false.

• BlockedHexSSIDs

  string[] optional

  List of blocked networks. Connections to blocked networks are prohibited. Networks can be unblocked again by specifying an explicit network configuration. Defaults to an empty list.

Properties

• ExcludedRoutes

  string[] optional

  Array of IP blocks in CIDR notation, see onc_spec.md for details.

• Gateway

  string optional

  Gateway address used for the IP configuration.

• IPAddress

  string optional

  The IP address for a connection. Can be IPv4 or IPv6 address, depending on value of Type.

• IncludedRoutes

  string[] optional

  Array of IP blocks in CIDR notation, see onc_spec.md for details.

• NameServers

  string[] optional

  Array of addresses used for name servers.

• RoutingPrefix

  number optional

  The routing prefix.

• SearchDomains

  string[] optional

  Array of strings for name resolution, see onc_spec.md for details.

• Type

  string optional

  The IP configuration type. Can be IPv4 or IPv6.

• WebProxyAutoDiscoveryUrl

  string optional

  The URL for WEb Proxy Auto-Discovery, as reported over DHCP.

Properties

• CommonName

  string optional

  If set, the value against which to match the certificate subject's common name.

• Locality

  string optional

  If set, the value against which to match the certificate subject's common location.

• Organization

  string optional

  If set, the value against which to match the certificate subject's organizations. At least one organization should match the value.

• OrganizationalUnit

  string optional

  If set, the value against which to match the certificate subject's organizational units. At least one organizational unit should match the value.

Properties

• Active

  boolean optional

  The active value currently used by the network configuration manager (e.g. Shill).

• DeviceEditable

  boolean optional

  Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• DevicePolicy

  boolean optional

  The property value provided by the device policy.

• Effective

  string optional

  The source from which the effective property value was determined.

• SharedSetting

  boolean optional

  The value set for all users of the device. Only provided if |DeviceEditiable| is true.

• UserEditable

  boolean optional

  Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• UserPolicy

  boolean optional

  The property value provided by the user policy.

• UserSetting

  boolean optional

  The property value set by the logged in user. Only provided if |UserEditable| is true.

Properties

• ActivationState

  ActivationStateType optional

  See CellularProperties.ActivationState.

• ActivationType

  string optional

  See CellularProperties.ActivationType.

• AllowRoaming

  boolean optional

  See CellularProperties.AllowRoaming.

• AutoConnect

  ManagedBoolean optional

  See CellularProperties.AutoConnect.

• Family

  string optional

  See CellularProperties.Family.

• FirmwareRevision

  string optional

  See CellularProperties.FirmwareRevision.

• FoundNetworks

  FoundNetworkProperties[] optional

  See CellularProperties.FoundNetworks.

• HardwareRevision

  string optional

  See CellularProperties.HardwareRevision.

• HomeProvider

  CellularProviderProperties[] optional

  See CellularProperties.HomeProvider.

• Manufacturer

  string optional

  See CellularProperties.Manufacturer.

• ModelID

  string optional

  See CellularProperties.ModelID.

• NetworkTechnology

  string optional

  See CellularProperties.NetworkTechnology.

• PaymentPortal

  PaymentPortal optional

  See CellularProperties.PaymentPortal.

• RoamingState

  string optional

  See CellularProperties.RoamingState.

• SIMLockStatus

  SIMLockStatus optional

  See CellularProperties.SIMLockStatus.

• SIMPresent

  boolean optional

  See CellularProperties.SIMPresent.

• Scanning

  boolean optional

  See CellularProperties.Scanning.

• ServingOperator

  CellularProviderProperties optional

  See CellularProperties.ServingOperator.

• SignalStrength

  number optional

  See CellularProperties.SignalStrength.

• SupportNetworkScan

  boolean optional

  See CellularProperties.SupportNetworkScan.

Properties

• Active

  string optional

  The active value currently used by the network configuration manager (e.g. Shill).

• DeviceEditable

  boolean optional

  Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• DevicePolicy

  string optional

  The property value provided by the device policy.

• Effective

  string optional

  The source from which the effective property value was determined.

• SharedSetting

  string optional

  The value set for all users of the device. Only provided if |DeviceEditiable| is true.

• UserEditable

  boolean optional

  Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• UserPolicy

  string optional

  The property value provided by the user policy.

• UserSetting

  string optional

  The property value set by the logged in user. Only provided if |UserEditable| is true.

Properties

• Active

  string[] optional

  The active value currently used by the network configuration manager (e.g. Shill).

• DeviceEditable

  boolean optional

  Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• DevicePolicy

  string[] optional

  The property value provided by the device policy.

• Effective

  string optional

  The source from which the effective property value was determined.

• SharedSetting

  string[] optional

  The value set for all users of the device. Only provided if |DeviceEditiable| is true.

• UserEditable

  boolean optional

  Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• UserPolicy

  string[] optional

  The property value provided by the user policy.

• UserSetting

  string[] optional

  The property value set by the logged in user. Only provided if |UserEditable| is true.

Properties

• Authentication

  ManagedDOMString optional

  See EthernetProperties.Authentication.

• AutoConnect

  ManagedBoolean optional

  See EthernetProperties.AutoConnect.

Properties

• Gateway

  ManagedDOMString optional

  See IPConfigProperties.Gateway.

• IPAddress

  ManagedDOMString optional

  See IPConfigProperties.IPAddress.

• NameServers

  ManagedDOMStringList optional

  See IPConfigProperties.NameServers.

• RoutingPrefix

  ManagedLong optional

  See IPConfigProperties.RoutingPrefix.

• Type

  ManagedDOMString optional

  See IPConfigProperties.Type.

• WebProxyAutoDiscoveryUrl

  ManagedDOMString optional

  See IPConfigProperties.WebProxyAutoDiscoveryUrl.

Properties

• Active

  IPConfigType optional

  The active value currently used by the network configuration manager (e.g. Shill).

• DeviceEditable

  boolean optional

  Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• DevicePolicy

  IPConfigType optional

  The property value provided by the device policy.

• Effective

  string optional

  The source from which the effective property value was determined.

• SharedSetting

  IPConfigType optional

  The value set for all users of the device. Only provided if |DeviceEditiable| is true.

• UserEditable

  boolean optional

  Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• UserPolicy

  IPConfigType optional

  The property value provided by the user policy.

• UserSetting

  IPConfigType optional

  The property value set by the logged in user. Only provided if |UserEditable| is true.

Properties

• Active

  number optional

  The active value currently used by the network configuration manager (e.g. Shill).

• DeviceEditable

  boolean optional

  Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• DevicePolicy

  number optional

  The property value provided by the device policy.

• Effective

  string optional

  The source from which the effective property value was determined.

• SharedSetting

  number optional

  The value set for all users of the device. Only provided if |DeviceEditiable| is true.

• UserEditable

  boolean optional

  Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• UserPolicy

  number optional

  The property value provided by the user policy.

• UserSetting

  number optional

  The property value set by the logged in user. Only provided if |UserEditable| is true.

Properties

• FTPProxy

  ManagedProxyLocation optional

  See ManualProxySettings.FTPProxy.

• HTTPProxy

  ManagedProxyLocation optional

  See ManualProxySettings.HTTPProxy.

• SOCKS

  ManagedProxyLocation optional

  See ManualProxySettings.SOCKS.

• SecureHTTPProxy

  ManagedProxyLocation optional

  See ManualProxySettings.SecureHTTPProxy.

Properties

• Cellular

  ManagedCellularProperties optional

  See NetworkProperties.Cellular.

• Connectable

  boolean optional

  See NetworkProperties.Connectable.

• ConnectionState

  ConnectionStateType optional

  See NetworkProperties.ConnectionState.

• ErrorState

  string optional

  See NetworkProperties.ErrorState.

• Ethernet

  ManagedEthernetProperties optional

  See NetworkProperties.Ethernet.

• GUID

  string

  See NetworkProperties.GUID.

• IPAddressConfigType

  ManagedIPConfigType optional

  See NetworkProperties.IPAddressConfigType.

• IPConfigs

  IPConfigProperties[] optional

  See NetworkProperties.IPConfigs.

• MacAddress

  string optional

  See NetworkProperties.MacAddress.

• Metered

  ManagedBoolean optional

  See NetworkProperties.Metered.

• Name

  ManagedDOMString optional

  See NetworkProperties.Name.

• NameServersConfigType

  ManagedIPConfigType optional

  See NetworkProperties.NameServersConfigType.

• Priority

  ManagedLong optional

  See NetworkProperties.Priority.

• ProxySettings

  ManagedProxySettings optional

  See NetworkProperties.ProxySettings.

• RestrictedConnectivity

  boolean optional

  See NetworkProperties.RestrictedConnectivity.

• SavedIPConfig

  IPConfigProperties optional

  See NetworkProperties.SavedIPConfig.

• Source

  string optional

  See NetworkProperties.Source.

• StaticIPConfig

  ManagedIPConfigProperties optional

  See NetworkProperties.StaticIPConfig.

• Type

  NetworkType

  See NetworkProperties.Type.

• VPN

  ManagedVPNProperties optional

  See NetworkProperties.VPN.

• WiFi

  ManagedWiFiProperties optional

  See NetworkProperties.WiFi.

Properties

• Host

  ManagedDOMString

  See ProxyLocation.Host.

• Port

  ManagedLong

  See ProxyLocation.Port.

Properties

• ExcludeDomains

  ManagedDOMStringList optional

  See ProxySettings.ExcludeDomains.

• Manual

  ManagedManualProxySettings optional

  See ProxySettings.Manual.

• PAC

  ManagedDOMString optional

  See ProxySettings.PAC.

• Type

  ManagedProxySettingsType

  See ProxySettings.Type.

Properties

• Active

  ProxySettingsType optional

  The active value currently used by the network configuration manager (e.g. Shill).

• DeviceEditable

  boolean optional

  Whether a DevicePolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• DevicePolicy

  ProxySettingsType optional

  The property value provided by the device policy.

• Effective

  string optional

  The source from which the effective property value was determined.

• SharedSetting

  ProxySettingsType optional

  The value set for all users of the device. Only provided if |DeviceEditiable| is true.

• UserEditable

  boolean optional

  Whether a UserPolicy for the property exists and allows the property to be edited (i.e. the policy set recommended property value). Defaults to false.

• UserPolicy

  ProxySettingsType optional

  The property value provided by the user policy.

• UserSetting

  ProxySettingsType optional

  The property value set by the logged in user. Only provided if |UserEditable| is true.

Properties

• ExtensionID

  ManagedDOMString

  See ThirdPartyVPNProperties.ExtensionID.

• ProviderName

  string optional

  See ThirdPartyVPNProperties.ProviderName.

Properties

• AutoConnect

  ManagedBoolean optional

  See VPNProperties.AutoConnect.

• Host

  ManagedDOMString optional

  See VPNProperties.Host.

• Type

  ManagedDOMString optional

  See VPNProperties.Type.

Properties

• AllowGatewayARPPolling

  ManagedBoolean optional

  See WiFiProperties.AllowGatewayARPPolling.

• AutoConnect

  ManagedBoolean optional

  See WiFiProperties.AutoConnect.

• BSSID

  string optional

  See WiFiProperties.BSSID.

• Frequency

  number optional

  See WiFiProperties.Frequency.

• FrequencyList

  number[] optional

  See WiFiProperties.FrequencyList.

• HexSSID

  ManagedDOMString optional

  See WiFiProperties.HexSSID.

• HiddenSSID

  ManagedBoolean optional

  See WiFiProperties.HiddenSSID.

• RoamThreshold

  ManagedLong optional

  Deprecated, ignored. See WiFiProperties.RoamThreshold.

• SSID

  ManagedDOMString optional

  See WiFiProperties.SSID.

• Security

  ManagedDOMString

  See WiFiProperties.Security.

• SignalStrength

  number optional

  See WiFiProperties.SignalStrength.

• TetheringState

  string optional

  See WiFiProperties.TetheringState.

Properties

• FTPProxy

  ProxyLocation optional

  Settings for FTP proxy.

• HTTPProxy

  ProxyLocation optional

  Settings for HTTP proxy.

• SOCKS

  ProxyLocation optional

  Settings for SOCKS proxy.

• SecureHTTPProxy

  ProxyLocation optional

  Settings for secure HTTP proxy.

Properties

• Cellular

  CellularProperties optional

  See NetworkProperties.Cellular.

• Ethernet

  EthernetProperties optional

  See NetworkProperties.Ethernet.

• GUID

  string optional

  See NetworkProperties.GUID.

• IPAddressConfigType

  IPConfigType optional

  See NetworkProperties.IPAddressConfigType.

• Name

  string optional

  See NetworkProperties.Name.

• NameServersConfigType

  IPConfigType optional

  See NetworkProperties.NameServersConfigType.

• Priority

  number optional

  See NetworkProperties.Priority.

• Type

  NetworkType optional

  See NetworkProperties.Type.

• VPN

  VPNProperties optional

  See NetworkProperties.VPN.

• WiFi

  WiFiProperties optional

  See NetworkProperties.WiFi.

• WiMAX

  WiMAXProperties optional

  Deprecated.

Properties

• configured

  boolean optional

  If true, only include configured (saved) networks. Defaults to 'false'.

• limit

  number optional

  Maximum number of networks to return. Defaults to 1000 if unspecified. Use 0 for no limit.

• networkType

  NetworkType

  The type of networks to return.

• visible

  boolean optional

  If true, only include visible (physically connected or in-range) networks. Defaults to 'false'.

Properties

• Cellular

  CellularProperties optional

  For cellular networks, cellular network properties.

• Connectable

  boolean optional

  Whether the network is connectable.

• ConnectionState

  ConnectionStateType optional

  The network's current connection state.

• ErrorState

  string optional

  The last recorded network error state.

• Ethernet

  EthernetProperties optional

  For Ethernet networks, the Ethernet network properties.

• GUID

  string

  The network GUID.

• IPAddressConfigType

  IPConfigType optional

  The network's IP address configuration type.

• IPConfigs

  IPConfigProperties[] optional

  The network's IP configuration.

• MacAddress

  string optional

  The network's MAC address.

• Metered

  boolean optional

  Whether the network is metered.

• Name

  string optional

  A user friendly network name.

• NameServersConfigType

  IPConfigType optional

  The IP configuration type for the name servers used by the network.

• Priority

  number optional

  The network priority.

• ProxySettings

  ProxySettings optional

  The network's proxy settings.

• RestrictedConnectivity

  boolean optional

  For a connected network, whether the network connectivity to the Internet is limited, e.g. if the network is behind a portal, or a cellular network is not activated.

• SavedIPConfig

  IPConfigProperties optional

  IP configuration that was received from the DHCP server before applying static IP configuration.

• Source

  string optional

  Indicates whether and how the network is configured. Possible values are:

  • Device
  • DevicePolicy
  • User
  • UserPolicy
  • None

  'None' conflicts with extension code generation so we must use a string for 'Source' instead of a SourceType enum.

• StaticIPConfig

  IPConfigProperties optional

  The network's static IP configuration.

• Type

  NetworkType

  The network type.

• VPN

  VPNProperties optional

  For VPN networks, the network VPN properties.

• WiFi

  WiFiProperties optional

  For WiFi networks, the network WiFi properties.

Properties

• Cellular

  CellularStateProperties optional

  See NetworkProperties.Cellular.

• Connectable

  boolean optional

  See NetworkProperties.Connectable.

• ConnectionState

  ConnectionStateType optional

  See NetworkProperties.ConnectionState.

• ErrorState

  string optional

  See NetworkProperties.ErrorState.

• Ethernet

  EthernetStateProperties optional

  See NetworkProperties.Ethernet.

• GUID

  string

  See NetworkProperties.GUID.

• Name

  string optional

  See NetworkProperties.Name.

• Priority

  number optional

  See NetworkProperties.Priority.

• Source

  string optional

  See NetworkProperties.Source.

• Type

  NetworkType

  See NetworkProperties.Type.

• VPN

  VPNStateProperties optional

  See NetworkProperties.VPN.

• WiFi

  WiFiStateProperties optional

  See NetworkProperties.WiFi.

Properties

• Method

  string

  The HTTP method to use for the payment portal.

• PostData

  string optional

  The post data to send to the payment portal. Ignored unless Method is POST.

• Url

  string optional

  The payment portal URL.

Properties

• Host

  string

  The proxy IP address host.

• Port

  number

  The port to use for the proxy.

Properties

• ExcludeDomains

  string[] optional

  Domains and hosts for which manual proxy settings are excluded.

• Manual

  ManualProxySettings optional

  Manual proxy settings - used only for Manual proxy settings.

• PAC

  string optional

  URL for proxy auto-configuration file.

• Type

  ProxySettingsType

  The type of proxy settings.

Properties

• LockEnabled

  boolean

  Whether SIM lock is enabled.

• LockType

  string

  The status of SIM lock - possible values are 'sim-pin', 'sim-puk' and ''.

• RetriesLeft

  number optional

  Number of PIN lock tries allowed before PUK is required to unlock the SIM.

Properties

• ExtensionID

  string

  ID of the third-party VPN provider extension.

• ProviderName

  string optional

  The VPN provider name.

Properties

• AutoConnect

  boolean optional

  Whether the VPN network should be connected automatically.

• Host

  string optional

  The VPN host.

• Type

  string optional

  The VPN type. This cannot be an enum because of 'L2TP-IPSec'. This is optional for NetworkConfigProperties which is passed to setProperties which may be used to set only specific properties.

Properties

• Type

  string

  See VPNProperties.Type.

Properties

• AllowGatewayARPPolling

  boolean optional

  Whether ARP polling of default gateway is allowed. Defaults to true.

• AutoConnect

  boolean optional

  Whether the WiFi network should be connected automatically when in range.

• BSSID

  string optional

  The BSSID of the associated access point..

• EAP

  EAPProperties optional

  The network EAP properties. Required for WEP-8021X and WPA-EAP networks.

• Frequency

  number optional

  The WiFi service operating frequency in MHz. For connected networks, the current frequency on which the network is connected. Otherwise, the frequency of the best available BSS.

• FrequencyList

  number[] optional

  Contains all operating frequency recently seen for the WiFi network.

• HexSSID

  string optional

  HEX-encoded copy of the network SSID.

• HiddenSSID

  boolean optional

  Whether the network SSID will be broadcast.

• Passphrase

  string optional

  The passphrase for WEP/WPA/WPA2 connections. This property can only be set - properties returned by getProperties will not contain this value.

• RoamThreshold

  number optional

  Deprecated, ignored.

• SSID

  string optional

  The network SSID.

• Security

  string optional

  The network security type.

• SignalStrength

  number optional

  The network signal strength.

• TetheringState

  string optional

  The tethering state associated with the connection.

Properties

• BSSID

  string optional

  See WiFiProperties.BSSID.

• Frequency

  number optional

  See WiFiProperties.Frequency.

• HexSSID

  string optional

  See WiFiProperties.HexSSID.

• SSID

  string optional

  See WiFiProperties.SSID.

• Security

  string

  See WiFiProperties.Security.

• SignalStrength

  number optional

  See WiFiProperties.SignalStrength.

• TetheringState

  string optional

  See WiFiProperties.TetheringState.

Properties

• AutoConnect

  boolean optional

  Whether the network should be connected automatically.

• EAP

  EAPProperties optional

  The network EAP properties.

Enum

Enum

Enum

Enum

Enum

Enum

Enum

Enum

Parameters

• shared

  boolean

  If true, share this network configuration with other users.

  This option is exposed only to Chrome's Web UI. When called by apps, false is the only allowed value.

• properties

  NetworkConfigProperties

  The properties to configure the new network with.

• callback

  function

  Called with the GUID for the new network configuration once the network has been created.

  The callback parameter should be a function that looks like this:

  (result: string) => {...}

  • result

    string

Parameters

• networkType

  NetworkType

  The type of network to disable.

Parameters

• networkType

  NetworkType

  The type of network to enable.

Parameters

• networkGuid

  string

  The GUID of the network to forget.

• callback

  function

  Called when the operation has completed.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• networkGuid

  string

  The GUID of the network to get captive portal status for.

• callback

  function

  A callback function that returns the results of the query for network captive portal status.

  The callback parameter should be a function that looks like this:

  (result: CaptivePortalStatus) => {...}

  • result

    CaptivePortalStatus

Parameters

• callback

  function

  Called with a list of devices and their state.

  The callback parameter should be a function that looks like this:

  (result: DeviceStateProperties[]) => {...}

  • result

    DeviceStateProperties[]

Parameters

• callback

  function

  The callback parameter should be a function that looks like this:

  (result: GlobalPolicy) => {...}

  • result

    GlobalPolicy

Parameters

• networkGuid

  string

  The GUID of the network to get properties for.

• callback

  function

  Called with the managed network properties when received.

  The callback parameter should be a function that looks like this:

  (result: ManagedProperties) => {...}

  • result

    ManagedProperties

Parameters

• filter

  NetworkFilter

  Describes which networks to return.

• callback

  function

  Called with a dictionary of networks and their state properties when received.

  The callback parameter should be a function that looks like this:

  (result: NetworkStateProperties[]) => {...}

  • result

    NetworkStateProperties[]

Parameters

• networkGuid

  string

  The GUID of the network to get properties for.

• callback

  function

  Called with the network properties when received.

  The callback parameter should be a function that looks like this:

  (result: NetworkProperties) => {...}

  • result

    NetworkProperties

Parameters

• networkGuid

  string

  The GUID of the network to get properties for.

• callback

  function

  Called immediately with the network state properties.

  The callback parameter should be a function that looks like this:

  (result: NetworkStateProperties) => {...}

  • result

    NetworkStateProperties

Parameters

• networkType

  NetworkType

  If provided, requests a scan specific to the type. For Cellular a mobile network scan will be requested if supported.

Parameters

• networkGuid

  string

  The GUID of the network to set properties for.

• properties

  NetworkConfigProperties

  The properties to set.

• callback

  function

  Called when the operation has completed.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• networkGuid

  string

  The GUID of the network to connect to.

• callback

  function

  Called when the connect request has been sent. Note: the connection may not have completed. Observe onNetworksChanged to be notified when a network state changes. If the connect request immediately failed (e.g. the network is unconfigured), runtime.lastError will be set with a failure reason.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• networkGuid

  string

  The GUID of the network to disconnect from.

• callback

  function

  Called when the disconnect request has been sent. See note for startConnect.

  The callback parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (changes: string[]) => {...}

  • changes

    string[]

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (changes: string[]) => {...}

  • changes

    string[]

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (networkGuid: string, status: CaptivePortalStatus) => {...}

  • networkGuid

    string
  • status

    CaptivePortalStatus