Added in API level 30

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

TelephonyDisplayInfo

Kotlin |Java

public final class TelephonyDisplayInfo
extends Object implements Parcelable

java.lang.Object
↳	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 TelephonyManager#registerTelephonyCallback with a TelephonyCallback that implements TelephonyCallback.DisplayInfoListener. Override the onDisplayInfoChanged() method to handle the broadcast.

Summary

Constants
`int`	`OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO` Override network type when the device is connected to advanced pro `TelephonyManager#NETWORK_TYPE_LTE` cellular network.
`int`	`OVERRIDE_NETWORK_TYPE_LTE_CA` Override network type when the device is connected to `TelephonyManager#NETWORK_TYPE_LTE` cellular network and is using carrier aggregation.
`int`	`OVERRIDE_NETWORK_TYPE_NONE` No override.
`int`	`OVERRIDE_NETWORK_TYPE_NR_ADVANCED` Override network type when the device is connected NR cellular network and the data rate is higher than the generic 5G date rate.
`int`	`OVERRIDE_NETWORK_TYPE_NR_NSA` 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.
`int`	`OVERRIDE_NETWORK_TYPE_NR_NSA_MMWAVE` This constant was deprecated in API level 31. Use`OVERRIDE_NETWORK_TYPE_NR_ADVANCED` instead.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<TelephonyDisplayInfo>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getNetworkType()` Get current packet-switching cellular network type.
`int`	`getOverrideNetworkType()` Get the override network type.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isRoaming()` Get device is roaming or not.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO

Added in API level 30

public static final int OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO

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

Constant Value: 2 (0x00000002)

OVERRIDE_NETWORK_TYPE_LTE_CA

Added in API level 30

public static final int OVERRIDE_NETWORK_TYPE_LTE_CA

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

Constant Value: 1 (0x00000001)

OVERRIDE_NETWORK_TYPE_NONE

Added in API level 30

public static final int OVERRIDE_NETWORK_TYPE_NONE

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

Constant Value: 0 (0x00000000)

OVERRIDE_NETWORK_TYPE_NR_ADVANCED

Added in API level 31

public static final int OVERRIDE_NETWORK_TYPE_NR_ADVANCED

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+"

Constant Value: 5 (0x00000005)

OVERRIDE_NETWORK_TYPE_NR_NSA

Added in API level 30

public static final int OVERRIDE_NETWORK_TYPE_NR_NSA

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.

Constant Value: 3 (0x00000003)

OVERRIDE_NETWORK_TYPE_NR_NSA_MMWAVE

Added in API level 30
Deprecated in API level 31

public static final int OVERRIDE_NETWORK_TYPE_NR_NSA_MMWAVE

This constant was deprecated in API level 31.
UseOVERRIDE_NETWORK_TYPE_NR_ADVANCED instead.

Constant Value: 4 (0x00000004)

Fields

CREATOR

Added in API level 30

public static final Creator<TelephonyDisplayInfo> CREATOR

Public methods

describeContents

Added in API level 30

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`

equals

Added in API level 30

public boolean equals (Object o)

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
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getNetworkType

Added in API level 30

public int getNetworkType ()

Get current packet-switching cellular network type. This is the actual network type the device is camped on.

Returns

Returns
`int`	The network type. Value is `TelephonyManager.NETWORK_TYPE_UNKNOWN`, `TelephonyManager.NETWORK_TYPE_GPRS`, `TelephonyManager.NETWORK_TYPE_EDGE`, `TelephonyManager.NETWORK_TYPE_UMTS`, `TelephonyManager.NETWORK_TYPE_CDMA`, `TelephonyManager.NETWORK_TYPE_EVDO_0`, `TelephonyManager.NETWORK_TYPE_EVDO_A`, `TelephonyManager.NETWORK_TYPE_1xRTT`, `TelephonyManager.NETWORK_TYPE_HSDPA`, `TelephonyManager.NETWORK_TYPE_HSUPA`, `TelephonyManager.NETWORK_TYPE_HSPA`, `TelephonyManager.NETWORK_TYPE_IDEN`, `TelephonyManager.NETWORK_TYPE_EVDO_B`, `TelephonyManager.NETWORK_TYPE_LTE`, `TelephonyManager.NETWORK_TYPE_EHRPD`, `TelephonyManager.NETWORK_TYPE_HSPAP`, `TelephonyManager.NETWORK_TYPE_GSM`, `TelephonyManager.NETWORK_TYPE_TD_SCDMA`, `TelephonyManager.NETWORK_TYPE_IWLAN`, or `TelephonyManager.NETWORK_TYPE_NR`

int

The network type. Value is TelephonyManager.NETWORK_TYPE_UNKNOWN, TelephonyManager.NETWORK_TYPE_GPRS, TelephonyManager.NETWORK_TYPE_EDGE, TelephonyManager.NETWORK_TYPE_UMTS, TelephonyManager.NETWORK_TYPE_CDMA, TelephonyManager.NETWORK_TYPE_EVDO_0, TelephonyManager.NETWORK_TYPE_EVDO_A, TelephonyManager.NETWORK_TYPE_1xRTT, TelephonyManager.NETWORK_TYPE_HSDPA, TelephonyManager.NETWORK_TYPE_HSUPA, TelephonyManager.NETWORK_TYPE_HSPA, TelephonyManager.NETWORK_TYPE_IDEN, TelephonyManager.NETWORK_TYPE_EVDO_B, TelephonyManager.NETWORK_TYPE_LTE, TelephonyManager.NETWORK_TYPE_EHRPD, TelephonyManager.NETWORK_TYPE_HSPAP, TelephonyManager.NETWORK_TYPE_GSM, TelephonyManager.NETWORK_TYPE_TD_SCDMA, TelephonyManager.NETWORK_TYPE_IWLAN, or TelephonyManager.NETWORK_TYPE_NR

getOverrideNetworkType

Added in API level 30

public int getOverrideNetworkType ()

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.

Returns
`int`	The override network type. Value is `OVERRIDE_NETWORK_TYPE_NONE`, `OVERRIDE_NETWORK_TYPE_LTE_CA`, `OVERRIDE_NETWORK_TYPE_LTE_ADVANCED_PRO`, `OVERRIDE_NETWORK_TYPE_NR_NSA`, or `OVERRIDE_NETWORK_TYPE_NR_ADVANCED`

hashCode

Added in API level 30

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
`int`	a hash code value for this object.

isRoaming

Added in API level 34

public boolean isRoaming ()

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.

Returns
`boolean`	True if the device is registered on roaming network overridden by config.

See also:

toString

Added in API level 30

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 30

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