PreciseDataConnectionState
class PreciseDataConnectionState : Parcelable
| kotlin.Any | |
| ↳ | android.telephony.PreciseDataConnectionState |
Contains precise data connection state. The following data connection information is included in returned PreciseDataConnectionState:
- Data connection state.
- Network type of the connection.
- APN types.
- APN.
- The properties of the network link.
- Data connection fail cause.
Summary
| Constants | |
|---|---|
| static Int |
Failure. |
| static Int |
In progress. |
| static Int |
Not Requested. |
| static Int |
Success. |
| static Int |
Unsupported. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int | |
| Boolean | |
| ApnSetting? |
Return the APN Settings for this data connection. |
| Int |
getId() |
| Int |
Returns the cause code generated by the most recent state change. |
| LinkProperties? |
Get the properties of the network link |
| Int |
Get the network type associated with this data connection. |
| Int |
Returns the network validation state. |
| Int |
getState() |
| Int | |
| Int |
hashCode() |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(out: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PreciseDataConnectionState!> | |
Constants
NETWORK_VALIDATION_FAILURE
static val NETWORK_VALIDATION_FAILURE: Int
Failure. The Failure status is used when network validation has been completed for the data network and the result is failure.
Value: 4
NETWORK_VALIDATION_IN_PROGRESS
static val NETWORK_VALIDATION_IN_PROGRESS: Int
In progress. The in progress state is used when the network validation process for the data network is in progress. This state is followed by either success or failure.
Value: 2
NETWORK_VALIDATION_NOT_REQUESTED
static val NETWORK_VALIDATION_NOT_REQUESTED: Int
Not Requested. The not requested status is used when the data network supports the network validation function, but no network validation is being performed yet.
Value: 1
NETWORK_VALIDATION_SUCCESS
static val NETWORK_VALIDATION_SUCCESS: Int
Success. The Success status is used when network validation has been completed for the data network and the result is successful.
Value: 3
NETWORK_VALIDATION_UNSUPPORTED
static val NETWORK_VALIDATION_UNSUPPORTED: Int
Unsupported. The unsupported state is used when the data network cannot support the network validation function for the current data connection state.
Value: 0
Public methods
describeContents
fun describeContents(): Int
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
equals
fun equals(other: Any?): Boolean
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getApnSetting
fun getApnSetting(): ApnSetting?
Return the APN Settings for this data connection.
| Return | |
|---|---|
ApnSetting? |
the ApnSetting that was used to configure this data connection. Note that a data connection cannot be established without a valid ApnSetting. The return value would never be null even though it has Nullable annotation. |
getId
fun getId(): Int
| Return | |
|---|---|
Int |
The unique id of the data connection Note this is the id assigned by the data service. The id remains the same for data connection handover between AccessNetworkConstants#TRANSPORT_TYPE_WLAN and AccessNetworkConstants#TRANSPORT_TYPE_WWAN |
getLastCauseCode
fun getLastCauseCode(): Int
Returns the cause code generated by the most recent state change. Return the cause code for the most recent change in getState. In the event of an error, this cause code will be non-zero.
getLinkProperties
fun getLinkProperties(): LinkProperties?
Get the properties of the network link LinkProperties.
| Return | |
|---|---|
LinkProperties? |
This value may be null. |
getNetworkType
fun getNetworkType(): Int
Get the network type associated with this data connection.
getNetworkValidationStatus
fun getNetworkValidationStatus(): Int
Returns the network validation state.
getState
fun getState(): Int
| Return | |
|---|---|
Int |
The high-level state of this data connection. Value is android.telephony.TelephonyManager#DATA_UNKNOWN, android.telephony.TelephonyManager#DATA_DISCONNECTED, android.telephony.TelephonyManager#DATA_CONNECTING, android.telephony.TelephonyManager#DATA_CONNECTED, or android.telephony.TelephonyManager#DATA_SUSPENDED |
getTransportType
fun getTransportType(): Int
| Return | |
|---|---|
Int |
The transport type of this data connection. Value is android.telephony.AccessNetworkConstants.TRANSPORT_TYPE_INVALID, android.telephony.AccessNetworkConstants#TRANSPORT_TYPE_WWAN, or android.telephony.AccessNetworkConstants#TRANSPORT_TYPE_WLAN |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
This value cannot be null. |
writeToParcel
fun writeToParcel(
out: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
The Parcel in which the object should be written. This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
out |
Parcel: This value cannot be null. |