# Print output for @column tags ?>
public
class
ApnSetting
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.telephony.data.ApnSetting |
An Access Point Name (APN) configuration for a carrier data connection.
The APN provides configuration to connect a cellular network device to an IP data network. A
carrier uses the name, type and other configuration in an APNSetting
to decide which IP
address to assign, any security methods to apply, and how the device might be connected to
private networks.
Use ApnSetting.Builder
to create new instances.
Nested classes | |
---|---|
class |
ApnSetting.Builder
Provides a convenient way to set the fields of a |
Constants | |
---|---|
int |
AUTH_TYPE_CHAP
Authentication type for CHAP. |
int |
AUTH_TYPE_NONE
No authentication type. |
int |
AUTH_TYPE_PAP
Authentication type for PAP. |
int |
AUTH_TYPE_PAP_OR_CHAP
Authentication type for PAP or CHAP. |
int |
MVNO_TYPE_GID
MVNO type for group identifier level 1. |
int |
MVNO_TYPE_ICCID
MVNO type for ICCID. |
int |
MVNO_TYPE_IMSI
MVNO type for IMSI. |
int |
MVNO_TYPE_SPN
MVNO type for service provider name. |
int |
PROTOCOL_IP
Internet protocol. |
int |
PROTOCOL_IPV4V6
Virtual PDP type introduced to handle dual IP stack UE capability. |
int |
PROTOCOL_IPV6
Internet protocol, version 6. |
int |
PROTOCOL_NON_IP
Transfer of Non-IP data to external packet data network. |
int |
PROTOCOL_PPP
Point to point protocol. |
int |
PROTOCOL_UNSTRUCTURED
Transfer of Unstructured data to the Data Network via N6. |
int |
TYPE_CBS
APN type for CBS. |
int |
TYPE_DEFAULT
APN type for default data traffic. |
int |
TYPE_DUN
APN type for DUN traffic. |
int |
TYPE_EMERGENCY
APN type for Emergency PDN. |
int |
TYPE_FOTA
APN type for accessing the carrier's FOTA portal, used for over the air updates. |
int |
TYPE_HIPRI
APN type for HiPri traffic. |
int |
TYPE_IA
APN type for IA Initial Attach APN. |
int |
TYPE_IMS
APN type for IMS. |
int |
TYPE_MCX
APN type for MCX (Mission Critical Service) where X can be PTT/Video/Data |
int |
TYPE_MMS
APN type for MMS traffic. |
int |
TYPE_SUPL
APN type for SUPL assisted GPS. |
int |
TYPE_XCAP
APN type for XCAP. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<ApnSetting> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
String
|
getApnName()
Returns the name of the APN. |
int
|
getApnTypeBitmask()
Returns the bitmask of APN types. |
int
|
getAuthType()
Returns the authentication type of the APN. |
int
|
getCarrierId()
Returns the carrier id for this APN. |
String
|
getEntryName()
Gets the human-readable name that describes the APN. |
int
|
getId()
Returns the unique database id for this entry. |
InetAddress
|
getMmsProxyAddress()
This method is deprecated.
use |
String
|
getMmsProxyAddressAsString()
Returns the MMS proxy address of the APN. |
int
|
getMmsProxyPort()
Returns the MMS proxy port of the APN. |
Uri
|
getMmsc()
Returns the MMSC Uri of the APN. |
int
|
getMvnoType()
Returns the MVNO match type for this APN. |
int
|
getNetworkTypeBitmask()
Returns a bitmask describing the Radio Technologies(Network Types) which this APN may use. |
String
|
getOperatorNumeric()
Returns the numeric operator ID for the APN. |
String
|
getPassword()
Returns the APN password of the APN. |
int
|
getProtocol()
Returns the protocol to use to connect to this APN. |
InetAddress
|
getProxyAddress()
This method is deprecated.
use |
String
|
getProxyAddressAsString()
Returns the proxy address of the APN. |
int
|
getProxyPort()
Returns the proxy address of the APN. |
int
|
getRoamingProtocol()
Returns the protocol to use to connect to this APN while the device is roaming. |
String
|
getUser()
Returns the APN username of the APN. |
boolean
|
isEnabled()
Returns the current status of APN. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
public static final int AUTH_TYPE_CHAP
Authentication type for CHAP.
Constant Value: 2 (0x00000002)
public static final int AUTH_TYPE_NONE
No authentication type.
Constant Value: 0 (0x00000000)
public static final int AUTH_TYPE_PAP
Authentication type for PAP.
Constant Value: 1 (0x00000001)
public static final int AUTH_TYPE_PAP_OR_CHAP
Authentication type for PAP or CHAP.
Constant Value: 3 (0x00000003)
public static final int MVNO_TYPE_GID
MVNO type for group identifier level 1.
Constant Value: 2 (0x00000002)
public static final int MVNO_TYPE_ICCID
MVNO type for ICCID.
Constant Value: 3 (0x00000003)
public static final int MVNO_TYPE_IMSI
MVNO type for IMSI.
Constant Value: 1 (0x00000001)
public static final int MVNO_TYPE_SPN
MVNO type for service provider name.
Constant Value: 0 (0x00000000)
public static final int PROTOCOL_IP
Internet protocol.
Constant Value: 0 (0x00000000)
public static final int PROTOCOL_IPV4V6
Virtual PDP type introduced to handle dual IP stack UE capability.
Constant Value: 2 (0x00000002)
public static final int PROTOCOL_IPV6
Internet protocol, version 6.
Constant Value: 1 (0x00000001)
public static final int PROTOCOL_NON_IP
Transfer of Non-IP data to external packet data network.
Constant Value: 4 (0x00000004)
public static final int PROTOCOL_PPP
Point to point protocol.
Constant Value: 3 (0x00000003)
public static final int PROTOCOL_UNSTRUCTURED
Transfer of Unstructured data to the Data Network via N6.
Constant Value: 5 (0x00000005)
public static final int TYPE_CBS
APN type for CBS.
Constant Value: 128 (0x00000080)
public static final int TYPE_DEFAULT
APN type for default data traffic.
Constant Value: 17 (0x00000011)
public static final int TYPE_DUN
APN type for DUN traffic.
Constant Value: 8 (0x00000008)
public static final int TYPE_EMERGENCY
APN type for Emergency PDN. This is not an IA apn, but is used for access to carrier services in an emergency call situation.
Constant Value: 512 (0x00000200)
public static final int TYPE_FOTA
APN type for accessing the carrier's FOTA portal, used for over the air updates.
Constant Value: 32 (0x00000020)
public static final int TYPE_HIPRI
APN type for HiPri traffic.
Constant Value: 16 (0x00000010)
public static final int TYPE_IA
APN type for IA Initial Attach APN.
Constant Value: 256 (0x00000100)
public static final int TYPE_IMS
APN type for IMS.
Constant Value: 64 (0x00000040)
public static final int TYPE_MCX
APN type for MCX (Mission Critical Service) where X can be PTT/Video/Data
Constant Value: 1024 (0x00000400)
public static final int TYPE_MMS
APN type for MMS traffic.
Constant Value: 2 (0x00000002)
public static final int TYPE_SUPL
APN type for SUPL assisted GPS.
Constant Value: 4 (0x00000004)
public static final int TYPE_XCAP
APN type for XCAP.
Constant Value: 2048 (0x00000800)
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
public int getApnTypeBitmask ()
Returns the bitmask of APN types.
Apn types are usage categories for an APN entry. One APN entry may support multiple APN types, eg, a single APN may service regular internet traffic ("default") as well as MMS-specific connections.
The bitmask of APN types is calculated from APN types defined in ApnSetting
.
Returns | |
---|---|
int |
a bitmask describing the types of the APN
Value is either 0 or a combination of TYPE_DEFAULT , TYPE_MMS , TYPE_SUPL , TYPE_DUN , TYPE_HIPRI , TYPE_FOTA , TYPE_IMS , TYPE_CBS , TYPE_IA , TYPE_EMERGENCY , TYPE_MCX , and TYPE_XCAP |
public int getAuthType ()
Returns the authentication type of the APN.
Returns | |
---|---|
int |
authentication type
Value is AUTH_TYPE_NONE , AUTH_TYPE_PAP , AUTH_TYPE_CHAP , or AUTH_TYPE_PAP_OR_CHAP |
public int getCarrierId ()
Returns the carrier id for this APN.
Returns | |
---|---|
int |
the carrier id |
See also:
public String getEntryName ()
Gets the human-readable name that describes the APN.
Returns | |
---|---|
String |
the entry name for the APN |
public int getId ()
Returns the unique database id for this entry.
Returns | |
---|---|
int |
the unique database id |
public InetAddress getMmsProxyAddress ()
This method is deprecated.
use getMmsProxyAddressAsString()
instead.
Gets the MMS proxy address configured for the APN. The MMS proxy address might be an IP
address or hostname. This method returns null
if system networking (typically DNS)
isn’t available to resolve a hostname value—values set as IP addresses don’t have this
restriction. This is a known problem and will be addressed in a future release.
Returns | |
---|---|
InetAddress |
the MMS proxy address or null if DNS isn’t available to resolve a hostname |
public String getMmsProxyAddressAsString ()
Returns the MMS proxy address of the APN.
Returns | |
---|---|
String |
MMS proxy address. |
public int getMmsProxyPort ()
Returns the MMS proxy port of the APN.
Returns | |
---|---|
int |
MMS proxy port |
public int getMvnoType ()
Returns the MVNO match type for this APN.
Returns | |
---|---|
int |
the MVNO match type
Value is MVNO_TYPE_SPN , MVNO_TYPE_IMSI , MVNO_TYPE_GID , or MVNO_TYPE_ICCID |
See also:
public int getNetworkTypeBitmask ()
Returns a bitmask describing the Radio Technologies(Network Types) which this APN may use.
NetworkType bitmask is calculated from NETWORK_TYPE defined in TelephonyManager
.
Examples of Network Types include TelephonyManager#NETWORK_TYPE_UNKNOWN
,
TelephonyManager#NETWORK_TYPE_GPRS
, TelephonyManager#NETWORK_TYPE_EDGE
.
Returns | |
---|---|
int |
a bitmask describing the Radio Technologies(Network Types) |
public String getOperatorNumeric ()
Returns the numeric operator ID for the APN. Numeric operator ID is defined as
Telephony.Carriers.MCC
+
Telephony.Carriers.MNC
.
Returns | |
---|---|
String |
the numeric operator ID |
public String getPassword ()
Returns the APN password of the APN.
Returns | |
---|---|
String |
APN password |
public int getProtocol ()
Returns the protocol to use to connect to this APN.
Protocol is one of the PDP_type
values in TS 27.007 section 10.1.1.
Returns | |
---|---|
int |
the protocol
Value is PROTOCOL_IP , PROTOCOL_IPV6 , PROTOCOL_IPV4V6 , PROTOCOL_PPP , PROTOCOL_NON_IP , or PROTOCOL_UNSTRUCTURED |
See also:
public InetAddress getProxyAddress ()
This method is deprecated.
use getProxyAddressAsString()
instead.
Gets the HTTP proxy address configured for the APN. The proxy address might be an IP address
or hostname. This method returns null
if system networking (typically DNS) isn’t
available to resolve a hostname value—values set as IP addresses don’t have this restriction.
This is a known problem and will be addressed in a future release.
Returns | |
---|---|
InetAddress |
the HTTP proxy address or null if DNS isn’t available to resolve a hostname |
public String getProxyAddressAsString ()
Returns the proxy address of the APN.
Returns | |
---|---|
String |
proxy address. |
public int getProxyPort ()
Returns the proxy address of the APN.
Returns | |
---|---|
int |
proxy address. |
public int getRoamingProtocol ()
Returns the protocol to use to connect to this APN while the device is roaming.
Roaming protocol is one of the PDP_type
values in TS 27.007 section 10.1.1.
Returns | |
---|---|
int |
the roaming protocol
Value is PROTOCOL_IP , PROTOCOL_IPV6 , PROTOCOL_IPV4V6 , PROTOCOL_PPP , PROTOCOL_NON_IP , or PROTOCOL_UNSTRUCTURED |
public boolean isEnabled ()
Returns the current status of APN.
true
: enabled APN.
false
: disabled APN.
Returns | |
---|---|
boolean |
the current status |
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |