ArcGIS for Developers

NetworkConfiguration QML Type

NetworkConfiguration provides an abstraction of one or more access point configurations. More...

Import Statement: import ArcGIS.AppFramework.Networking 1.0

Properties

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]

Enumerations

ConfigurationType enumeration

This enum describes the potential types of network configuration. Informs the configurationType property.

NameValue
NetworkConfiguration.TypeInternetAccessPoint0
NetworkConfiguration.TypeServiceNetwork1
NetworkConfiguration.TypeUserChoice2
NetworkConfiguration.TypeInvalid3

Purpose enumeration

This enum describes the potential purposes of a network configuration. It informs the purpose property.

NameValue
NetworkConfiguration.PurposeUnknown0
NetworkConfiguration.PurposePublic1
NetworkConfiguration.PurposePrivate2
NetworkConfiguration.PurposeServiceSpecific3

ConfigurationState enumeration

Returns the current state of the configuration.

NameValue
NetworkConfiguration.StateUndefined1
NetworkConfiguration.StateDefined2
NetworkConfiguration.StateDiscovered6
NetworkConfiguration.StateActive14

BearerClass enumeration

NameValue
NetworkConfiguration.BearerClassUnknown0
NetworkConfiguration.BearerClassEthernet1
NetworkConfiguration.BearerClassWIFI2
NetworkConfiguration.BearerClassBluetooth3
NetworkConfiguration.BearerClassMobileData4

BearerType enumeration

Specifies the bearer used by this configuration.

NameValue
NetworkConfiguration.BearerUnknown0
NetworkConfiguration.BearerEthernet1
NetworkConfiguration.BearerWLAN2
NetworkConfiguration.Bearer2G3
NetworkConfiguration.BearerCDMA20004
NetworkConfiguration.BearerWCDMA5
NetworkConfiguration.BearerHSPA6
NetworkConfiguration.BearerBluetooth7
NetworkConfiguration.BearerWiMAX8
NetworkConfiguration.BearerEVDO9
NetworkConfiguration.BearerLTE10
NetworkConfiguration.Bearer3G11
NetworkConfiguration.Bearer4G12

Property Documentation

[read-only] bearerClass : BearerClass


[read-only] bearerType : BearerType

Returns the type of bearer used by this configuration.

Text {
    text:networkConfig.bearerType.toString()
}

[read-only] bearerTypeFamily : BearerType

Returns the bearer type family used by this configuration.

Text {
    text:networkConfig.bearerTypeFamily.toString()
}

[read-only] bearerTypeName : string

Returns the type of bearer used by the network configuration as a string.

Text {
    text:networkConfig.bearerTypeName
}

[read-only] configurationType : ConfigurationType

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.


connectTimeout : int

The connect timeout for this configuration. This allows control of the timeout used by AbstractSocket to establish a connection.


[read-only] identifier : string

Returns the unique, platform-specific identifier for this network configuration. If this is not available, returns an empty string.


[read-only] name : string

Returns the name of this configuration.

Text {
    text:networkConfig.name
}

[read-only] purpose : Purpose

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.


[read-only] roamingAvailable : bool

Returns true if this configuration supports roaming. Otherwise, returns false.


[read-only] state : ConfigurationState

Returns the current state of the configuration.

Text {
    text:networkConfig.state
}

[read-only] valid : bool

Returns true if this configuration is valid.

Text {
    text:networkConfig.valid
}