ApnSetting

Kotlin |Java

open class ApnSetting : Parcelable

kotlin.Any
↳	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.

Summary

Nested classes
open	`Builder` Provides a convenient way to set the fields of a `ApnSetting` when creating a new instance.

Constants
static Int	`AUTH_TYPE_CHAP` Authentication type for CHAP.
static Int	`AUTH_TYPE_NONE` Authentication is not required.
static Int	`AUTH_TYPE_PAP` Authentication type for PAP.
static Int	`AUTH_TYPE_PAP_OR_CHAP` Authentication type for PAP or CHAP.
static Int	`MVNO_TYPE_GID` MVNO type for group identifier level 1.
static Int	`MVNO_TYPE_ICCID` MVNO type for ICCID.
static Int	`MVNO_TYPE_IMSI` MVNO type for IMSI.
static Int	`MVNO_TYPE_SPN` MVNO type for service provider name.
static Int	`PROTOCOL_IP` Internet protocol.
static Int	`PROTOCOL_IPV4V6` Virtual PDP type introduced to handle dual IP stack UE capability.
static Int	`PROTOCOL_IPV6` Internet protocol, version 6.
static Int	`PROTOCOL_NON_IP` Transfer of Non-IP data to external packet data network.
static Int	`PROTOCOL_PPP` Point to point protocol.
static Int	`PROTOCOL_UNSTRUCTURED` Transfer of Unstructured data to the Data Network via N6.
static Int	`TYPE_BIP` APN type for BIP.
static Int	`TYPE_CBS` APN type for CBS.
static Int	`TYPE_DEFAULT` APN type for default data traffic.
static Int	`TYPE_DUN` APN type for DUN traffic.
static Int	`TYPE_EMERGENCY` APN type for Emergency PDN.
static Int	`TYPE_ENTERPRISE` APN type for ENTERPRISE.
static Int	`TYPE_FOTA` APN type for accessing the carrier's FOTA portal, used for over the air updates.
static Int	`TYPE_HIPRI` APN type for HiPri traffic.
static Int	`TYPE_IA` APN type for IA Initial Attach APN.
static Int	`TYPE_IMS` APN type for IMS.
static Int	`TYPE_MCX` APN type for MCX (Mission Critical Service) where X can be PTT/Video/Data
static Int	`TYPE_MMS` APN type for MMS traffic.
static Int	`TYPE_OEM_PAID` APN type for OEM_PAID networks (Automotive PANS)
static Int	`TYPE_OEM_PRIVATE` APN type for OEM_PRIVATE networks (Automotive PANS)
static Int	`TYPE_RCS` APN type for RCS (Rich Communication Services).
static Int	`TYPE_SUPL` APN type for SUPL assisted GPS.
static Int	`TYPE_VSIM` APN type for VSIM.
static Int	`TYPE_XCAP` APN type for XCAP.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
open String!	`getApnName()` Returns the name of the APN.
open Int	`getApnTypeBitmask()` Returns the bitmask of APN types.
open Int	`getAuthType()` Returns the authentication type of the APN.
open Int	`getCarrierId()` Returns the carrier id for this APN.
open String!	`getEntryName()` Gets the human-readable name that describes the APN.
open Int	`getId()` Returns the unique database id for this entry.
open InetAddress!	`getMmsProxyAddress()` Gets the MMS proxy address configured for the APN.
open String!	`getMmsProxyAddressAsString()` Returns the MMS proxy address of the APN.
open Int	`getMmsProxyPort()` Returns the MMS proxy port of the APN.
open Uri!	`getMmsc()` Returns the MMSC Uri of the APN.
open Int	`getMtuV4()` Returns the default MTU (Maximum Transmission Unit) size in bytes of the IPv4 routes brought up by this APN setting.
open Int	`getMtuV6()` Returns the MTU size of the IPv6 mobile interface to which the APN connected.
open Int	`getMvnoType()` Returns the MVNO match type for this APN.
open Int	`getNetworkTypeBitmask()` Returns a bitmask describing the Radio Technologies (Network Types) which this APN may use.
open String!	`getOperatorNumeric()` Returns the numeric operator ID for the APN.
open String!	`getPassword()` Returns the APN password of the APN.
open Int	`getProfileId()` Returns the profile id to which the APN saved in modem.
open Int	`getProtocol()` Returns the protocol to use to connect to this APN.
open InetAddress!	`getProxyAddress()` Gets the HTTP proxy address configured for the APN.
open String!	`getProxyAddressAsString()` Returns the proxy address of the APN.
open Int	`getProxyPort()` Returns the proxy address of the APN.
open Int	`getRoamingProtocol()` Returns the protocol to use to connect to this APN while the device is roaming.
open String!	`getUser()` Returns the APN username of the APN.
open Int	`hashCode()` Returns a hash code value for the object.
open Boolean	`isAlwaysOn()` Returns whether User Plane resources have to be activated during every transition from CM-IDLE mode to CM-CONNECTED state for this APN See 3GPP TS 23.
open Boolean	`isEnabled()` Returns the current status of APN.
open Boolean	`isPersistent()` Returns if the APN setting is persistent on the modem.
open String	`toString()` Returns the string representation of ApnSetting.
open Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ApnSetting!>	`CREATOR`

Constants

AUTH_TYPE_CHAP

Added in API level 28

static val AUTH_TYPE_CHAP: Int

Authentication type for CHAP.

Value: 2

AUTH_TYPE_NONE

Added in API level 28

static val AUTH_TYPE_NONE: Int

Authentication is not required.

Value: 0

AUTH_TYPE_PAP

Added in API level 28

static val AUTH_TYPE_PAP: Int

Authentication type for PAP.

Value: 1

AUTH_TYPE_PAP_OR_CHAP

Added in API level 28

static val AUTH_TYPE_PAP_OR_CHAP: Int

Authentication type for PAP or CHAP.

Value: 3

MVNO_TYPE_GID

Added in API level 28

static val MVNO_TYPE_GID: Int

MVNO type for group identifier level 1.

Value: 2

MVNO_TYPE_ICCID

Added in API level 28

static val MVNO_TYPE_ICCID: Int

MVNO type for ICCID.

Value: 3

MVNO_TYPE_IMSI

Added in API level 28

static val MVNO_TYPE_IMSI: Int

MVNO type for IMSI.

Value: 1

MVNO_TYPE_SPN

Added in API level 28

static val MVNO_TYPE_SPN: Int

MVNO type for service provider name.

Value: 0

PROTOCOL_IP

Added in API level 28

static val PROTOCOL_IP: Int

Internet protocol.

Value: 0

PROTOCOL_IPV4V6

Added in API level 28

static val PROTOCOL_IPV4V6: Int

Virtual PDP type introduced to handle dual IP stack UE capability.

Value: 2

PROTOCOL_IPV6

Added in API level 28

static val PROTOCOL_IPV6: Int

Internet protocol, version 6.

Value: 1

PROTOCOL_NON_IP

Added in API level 29

static val PROTOCOL_NON_IP: Int

Transfer of Non-IP data to external packet data network.

Value: 4

ApnSetting

Summary

Constants

AUTH_TYPE_CHAP

AUTH_TYPE_NONE

AUTH_TYPE_PAP

AUTH_TYPE_PAP_OR_CHAP

MVNO_TYPE_GID

MVNO_TYPE_ICCID

MVNO_TYPE_IMSI

MVNO_TYPE_SPN

PROTOCOL_IP

PROTOCOL_IPV4V6

PROTOCOL_IPV6

PROTOCOL_NON_IP

PROTOCOL_PP