Added in API level 30

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

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

ApnSetting?

Return the APN Settings for this data connection.

Int

Int

Returns the cause code generated by the most recent state change.

LinkProperties?

Get the properties of the network link LinkProperties.

Int

Get the network type associated with this data connection.

Int

Returns the network validation state.

Int

Int

Int

Returns a hash code value for the object.

String

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

Added in API level 35
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

Added in API level 35
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

Added in API level 35
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

Added in API level 35
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

Added in API level 35
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

Added in API level 30
fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 30
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

Added in API level 30
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

Added in API level 31
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

Added in API level 30
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.

Return
Int Value is one of the following:

getLinkProperties

Added in API level 30
fun getLinkProperties(): LinkProperties?

Get the properties of the network link LinkProperties.

Return
LinkProperties? This value may be null.

getNetworkType

Added in API level 30
fun getNetworkType(): Int

Get the network type associated with this data connection.

Return
Int The current/latest (radio) bearer technology that carries this data connection. For a variety of reasons, the network type can change during the life of the data connection, and this information is not reliable unless the physical link is currently active; (there is currently no mechanism to know whether the physical link is active at any given moment). Thus, this value is generally correct but may not be relied-upon to represent the status of the radio bearer at any given moment.
Value is one of the following:

getNetworkValidationStatus

Added in API level 35
fun getNetworkValidationStatus(): Int

Returns the network validation state.

Return
Int the network validation status of the data call.
Value is one of the following:

getTransportType

Added in API level 31
fun getTransportType(): Int
Return
Int The transport type of this data connection.
Value is one of the following:

hashCode

Added in API level 30
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

toString

Added in API level 30
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

writeToParcel

Added in API level 30
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 the following:
out Parcel: This value cannot be null.

Properties

CREATOR

Added in API level 30
static val CREATOR: Parcelable.Creator<PreciseDataConnectionState!>