NetworkConfiguration provides an abstraction of one or more access point configurations. More...
| Import Statement: | import ArcGIS.AppFramework.Networking 1.0 |
Properties
- bearerClass : BearerClass
- bearerType : BearerType
- bearerTypeFamily : BearerType
- bearerTypeName : string
- configurationType : ConfigurationType
- connectTimeout : int
- identifier : string
- name : string
- purpose : Purpose
- roamingAvailable : bool
- state : ConfigurationState
- valid : bool
Detailed Description
The NetworkConfiguration component encapsulates a single access point or service network. In most cases a single access point configuration can be mapped to one network interface, however a single network interface may not always map to only one access point configuration. Multiple configurations for the same network device may enable multiple access points.
Instantiate the NetworkConfiguration component with this code sample, after which the properties can be used:
property var networkConfig : Networking.configurations[0]
Be aware that this component is likely to change in future releases. Redesign is still ongoing.
Enumerations
ConfigurationType enumeration
This enum describes the potential types of network configuration. Informs the configurationType property.
| Name | Value |
|---|---|
| NetworkConfiguration.TypeInternetAccessPoint | 0 |
| NetworkConfiguration.TypeServiceNetwork | 1 |
| NetworkConfiguration.TypeUserChoice | 2 |
| NetworkConfiguration.TypeInvalid | 3 |
Purpose enumeration
This enum describes the potential purposes of a network configuration. It informs the purpose property.
| Name | Value |
|---|---|
| NetworkConfiguration.PurposeUnknown | 0 |
| NetworkConfiguration.PurposePublic | 1 |
| NetworkConfiguration.PurposePrivate | 2 |
| NetworkConfiguration.PurposeServiceSpecific | 3 |
ConfigurationState enumeration
This enum describes the current state of the configuration. Informs the state property.
| Name | Value |
|---|---|
| NetworkConfiguration.StateUndefined | 1 |
| NetworkConfiguration.StateDefined | 2 |
| NetworkConfiguration.StateDiscovered | 6 |
| NetworkConfiguration.StateActive | 14 |
BearerClass enumeration
This enum describes the overall class of bearer used. Informs the bearerClass property.
| Name | Value |
|---|---|
| NetworkConfiguration.BearerClassUnknown | 0 |
| NetworkConfiguration.BearerClassEthernet | 1 |
| NetworkConfiguration.BearerClassWIFI | 2 |
| NetworkConfiguration.BearerClassBluetooth | 3 |
| NetworkConfiguration.BearerClassMobileData | 4 |
BearerType enumeration
Specifies the bearer used by this configuration. Informs the bearerType and bearerTypeFamily properties.
| Name | Value |
|---|---|
| NetworkConfiguration.BearerUnknown | 0 |
| NetworkConfiguration.BearerEthernet | 1 |
| NetworkConfiguration.BearerWLAN | 2 |
| NetworkConfiguration.Bearer2G | 3 |
| NetworkConfiguration.BearerCDMA2000 | 4 |
| NetworkConfiguration.BearerWCDMA | 5 |
| NetworkConfiguration.BearerHSPA | 6 |
| NetworkConfiguration.BearerBluetooth | 7 |
| NetworkConfiguration.BearerWiMAX | 8 |
| NetworkConfiguration.BearerEVDO | 9 |
| NetworkConfiguration.BearerLTE | 10 |
| NetworkConfiguration.Bearer3G | 11 |
| NetworkConfiguration.Bearer4G | 12 |
Property Documentation
The overall class of the bearer used. Informed by the BearerClass enum.
Returns the type of bearer used by this configuration. Informed by the BearerType enum.
Text { text:networkConfig.bearerType.toString() }
Returns the bearer type family used by this configuration. Informed by the BearerType enum.
Text { text:networkConfig.bearerTypeFamily.toString() }
Returns the type of bearer used by the network configuration as a string. Uses the same names as the BearerType enum, and will produce the same type of bearer as the bearerType property.
Text { text:networkConfig.bearerTypeName }
Returns the type of the configuration being used. Informed by the ConfigurationType enum.
A configuration can represent a single access point configuration, or a set of access point configurations; such a set is called a service network. A configuration that is based on a service network can potentially support roaming of network services.
The connect timeout for this configuration. This allows control of the timeout used by AbstractSocket to establish a connection.
Returns the unique, platform-specific identifier for this network configuration. If this is not available, returns an empty string.
Returns the purpose of this configuration. This property may be used to programatically determine the purpose of a configuration. This information is usually a part of the access point or service network metadata. Informed by the Purpose enum.
Returns true if this configuration supports roaming. Otherwise, returns false.
Returns the current state of the configuration. Informed by the ConfigurationState enum.
Text { text:networkConfig.state }
Returns true if this configuration is valid.
Text { text:networkConfig.valid }