Added in API level 30

TelephonyDisplayInfo


class TelephonyDisplayInfo : Parcelable
kotlin.Any
   ↳ android.telephony.TelephonyDisplayInfo

TelephonyDisplayInfo contains telephony-related information used for display purposes only. This information is provided in accordance with carrier policy and branding preferences; it is not necessarily a precise or accurate representation of the current state and should be treated accordingly. To be notified of changes in TelephonyDisplayInfo, use android.telephony.TelephonyManager#registerTelephonyCallback with a TelephonyCallback that implements TelephonyCallback.DisplayInfoListener. Override the onDisplayInfoChanged() method to handle the broadcast.

Summary

Constants
static Int

Override network type when the device is connected to advanced pro TelephonyManager#NETWORK_TYPE_LTE cellular network.

static Int

Override network type when the device is connected to TelephonyManager#NETWORK_TYPE_LTE cellular network and is using carrier aggregation.

static Int

No override.

static Int

Override network type when the device is connected NR cellular network and the data rate is higher than the generic 5G date rate.

static Int

Override network type when the device is connected to TelephonyManager#NETWORK_TYPE_LTE network and has E-UTRA-NR Dual Connectivity(EN-DC) capability or is currently connected to the secondary TelephonyManager#NETWORK_TYPE_NR cellular network.

static Int

Override network type when the device is connected to TelephonyManager#NETWORK_TYPE_LTE network and has E-UTRA-NR Dual Connectivity(EN-DC) capability or is currently connected to the secondary TelephonyManager#NETWORK_TYPE_NR cellular network on millimeter wave bands.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Int

Get current packet-switching cellular network type.

Int

Get the override network type.

Int

Boolean

Get device is roaming or not.

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<TelephonyDisplayInfo!>

Constants

OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO

Added in API level 30
static val OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO: Int

Override network type when the device is connected to advanced pro TelephonyManager#NETWORK_TYPE_LTE cellular network.

Value: 2

OVERRIDE_NETWORK_TYPE_LTE_CA

Added in API level 30
static val OVERRIDE_NETWORK_TYPE_LTE_CA: Int

Override network type when the device is connected to TelephonyManager#NETWORK_TYPE_LTE cellular network and is using carrier aggregation.

Value: 1

OVERRIDE_NETWORK_TYPE_NONE

Added in API level 30
static val OVERRIDE_NETWORK_TYPE_NONE: Int

No override. getNetworkType() should be used for display network type.

Value: 0

OVERRIDE_NETWORK_TYPE_NR_ADVANCED

Added in API level 31
static val OVERRIDE_NETWORK_TYPE_NR_ADVANCED: Int

Override network type when the device is connected NR cellular network and the data rate is higher than the generic 5G date rate. Including but not limited to

  • The device is connected to the NR cellular network on millimeter wave bands.
  • The device is connected to the specific network which the carrier is using proprietary means to provide a faster overall data connection than would be otherwise possible. This may include using other bands unique to the carrier, or carrier aggregation, for example.
One of the use case is that UX can show a different icon, for example, "5G+"

Value: 5

OVERRIDE_NETWORK_TYPE_NR_NSA

Added in API level 30
static val OVERRIDE_NETWORK_TYPE_NR_NSA: Int

Override network type when the device is connected to TelephonyManager#NETWORK_TYPE_LTE network and has E-UTRA-NR Dual Connectivity(EN-DC) capability or is currently connected to the secondary TelephonyManager#NETWORK_TYPE_NR cellular network.

Value: 3

OVERRIDE_NETWORK_TYPE_NR_NSA_MMWAVE

Added in API level 30
Deprecated in API level 31
static val OVERRIDE_NETWORK_TYPE_NR_NSA_MMWAVE: Int

Deprecated: Use{@link #OVERRIDE_NETWORK_TYPE_NR_ADVANCED} instead.

Override network type when the device is connected to TelephonyManager#NETWORK_TYPE_LTE network and has E-UTRA-NR Dual Connectivity(EN-DC) capability or is currently connected to the secondary TelephonyManager#NETWORK_TYPE_NR cellular network on millimeter wave bands.

Value: 4

Public methods

describeContents

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

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

getOverrideNetworkType

Added in API level 30
fun getOverrideNetworkType(): Int

Get the override network type. Note the override network type is for market branding or visualization purposes only. It cannot be treated as the actual network type device is camped on.

Return
Int The override network type. Value is android.telephony.TelephonyDisplayInfo#OVERRIDE_NETWORK_TYPE_NONE, android.telephony.TelephonyDisplayInfo#OVERRIDE_NETWORK_TYPE_LTE_CA, android.telephony.TelephonyDisplayInfo#OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO, android.telephony.TelephonyDisplayInfo#OVERRIDE_NETWORK_TYPE_NR_NSA, or android.telephony.TelephonyDisplayInfo#OVERRIDE_NETWORK_TYPE_NR_ADVANCED

hashCode

Added in API level 30
fun hashCode(): Int
Return
Int a hash code value for this object.

isRoaming

Added in API level 34
fun isRoaming(): Boolean

Get device is roaming or not. Note the isRoaming is for market branding or visualization purposes only. It cannot be treated as the actual roaming device is camped on.

Return
Boolean True if the device is registered on roaming network overridden by config.

toString

Added in API level 30
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 30
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

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_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

Properties

CREATOR

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