Added in API level 22

Summary: Inherited Constants | Fields | Methods | Inherited Methods

SubscriptionInfo

---

Kotlin |Java

public class SubscriptionInfo
extends Object implements Parcelable

java.lang.Object
↳	android.telephony.SubscriptionInfo

---

A Parcelable class for Subscription Information.

Summary

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<SubscriptionInfo>	CREATOR

Public methods
Bitmap	createIconBitmap(Context context) Creates and returns an icon Bitmap to represent this SubscriptionInfo in a user interface.
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	getCardId()
int	getCarrierId()
CharSequence	getCarrierName()
String	getCountryIso()
int	getDataRoaming() Whether user enables data roaming for this subscription or not.
CharSequence	getDisplayName()
ParcelUuid	getGroupUuid() Used in scenarios where different subscriptions are bundled as a group.
String	getIccId() Returns the ICC ID.
int	getIconTint() A highlight color to use in displaying information about this PhoneAccount.
int	getMcc() This method was deprecated in API level 29. Use getMccString() instead.
String	getMccString()
int	getMnc() This method was deprecated in API level 29. Use getMncString() instead.
String	getMncString()
String	getNumber() This method was deprecated in API level 33. use SubscriptionManager#getPhoneNumber(int) instead, which takes a subscription ID.
int	getPortIndex()
Set<Integer>	getServiceCapabilities() Retrieves the service capabilities for the current subscription.
int	getSimSlotIndex()
int	getSubscriptionId()
int	getSubscriptionType() This method returns the type of a subscription.
int	getUsageSetting() Get the usage setting for this subscription.
int	hashCode() Returns a hash code value for the object.
boolean	isEmbedded()
boolean	isOnlyNonTerrestrialNetwork() Check if the subscription is exclusively for non-terrestrial networks.
boolean	isOpportunistic() An opportunistic subscription connects to a network that is limited in functionality and / or coverage.
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.

Fields

CREATOR

Added in API level 22

public static final Creator<SubscriptionInfo> CREATOR

Public methods

createIconBitmap

Added in API level 22

public Bitmap createIconBitmap (Context context)

Creates and returns an icon Bitmap to represent this SubscriptionInfo in a user interface.

Parameters
context	Context: A Context to get the DisplayMetricss from.

Returns
Bitmap	A bitmap icon for this SubscriptionInfo.

describeContents

Added in API level 22

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 22

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.

getCardId

Added in API level 29

public int getCardId ()

Returns
int	The card ID of the SIM card which contains the subscription.

See also:

• UiccCardInfo.getCardId()

getCarrierId

Added in API level 29

public int getCarrierId ()

Returns
int	The carrier id of this subscription carrier.

See also:

• TelephonyManager.getSimCarrierId()

getCarrierName

Added in API level 22

public CharSequence getCarrierName ()

Returns
CharSequence	The name displayed to the user that identifies subscription provider name. This name is the SPN displayed in status bar and many other places. Can't be renamed by the user.

See also:

• getDisplayName()

getCountryIso

Added in API level 22

public String getCountryIso ()

Returns
String	The ISO country code. Empty if not available.

getDataRoaming

Added in API level 22

public int getDataRoaming ()

Whether user enables data roaming for this subscription or not. Either SubscriptionManager#DATA_ROAMING_ENABLE or SubscriptionManager#DATA_ROAMING_DISABLE.

Returns
int

getDisplayName

Added in API level 22

public CharSequence getDisplayName ()

Returns
CharSequence	The name displayed to the user that identifies this subscription. This name is used in Settings page and can be renamed by the user.

See also:

• getCarrierName()

getGroupUuid

Added in API level 29

public ParcelUuid getGroupUuid ()

Used in scenarios where different subscriptions are bundled as a group. It's typically a primary and an opportunistic subscription. (see isOpportunistic()) Such that those subscriptions will have some affiliated behaviors such as opportunistic subscription may be invisible to the user.

Returns
ParcelUuid	Group UUID a String of group UUID if it belongs to a group. Otherwise null.

getIccId

Added in API level 22

public String getIccId ()

Returns the ICC ID. Starting with API level 29 Security Patch 2021-04-05, returns the ICC ID if the calling app has been granted the READ_PRIVILEGED_PHONE_STATE permission, has carrier privileges (see TelephonyManager#hasCarrierPrivileges), or is a device owner or profile owner that has been granted the READ_PHONE_STATE permission. The profile owner is an app that owns a managed profile on the device; for more details see Work profiles. Profile owner access is deprecated and will be removed in a future release.

Returns
String	the ICC ID, or an empty string if one of these requirements is not met

getIconTint

Added in API level 22

public int getIconTint ()

A highlight color to use in displaying information about this PhoneAccount.

Returns
int	A hexadecimal color value.

getMcc

Added in API level 22
Deprecated in API level 29

public int getMcc ()

This method was deprecated in API level 29.
Use getMccString() instead.

Returns
int	The mobile country code.

getMccString

Added in API level 29

public String getMccString ()

Returns
String	The mobile country code. This value may be null.

getMnc

Added in API level 22
Deprecated in API level 29

public int getMnc ()

This method was deprecated in API level 29.
Use getMncString() instead.

Returns
int	The mobile network code.

getMncString

Added in API level 29

public String getMncString ()

Returns
String	The mobile network code. This value may be null.

getNumber

Added in API level 22
Deprecated in API level 33

public String getNumber ()

This method was deprecated in API level 33.
use SubscriptionManager#getPhoneNumber(int) instead, which takes a subscription ID.

Returns the number of this subscription. Starting with API level 30, returns the number of this subscription if the calling app meets at least one of the following requirements:

• If the calling app's target SDK is API level 29 or lower and the app has been granted the READ_PHONE_STATE permission.
• If the calling app has been granted any of READ_PRIVILEGED_PHONE_STATE, READ_PHONE_NUMBERS, or READ_SMS.
• If the calling app has carrier privileges (see TelephonyManager.hasCarrierPrivileges()).
• If the calling app is the default SMS role holder.

Returns
String	the number of this subscription, or an empty string if none of the requirements are met.

getPortIndex

Added in API level 33

public int getPortIndex ()

Returns
int	The port index of the SIM card which contains the subscription.

getServiceCapabilities

Added in API level 35

public Set<Integer> getServiceCapabilities ()

Retrieves the service capabilities for the current subscription.

These capabilities are hint to system components and applications, allowing them to enhance user experience. For instance, a Dialer application can inform the user that the current subscription is incapable of making voice calls if the voice service is not available.

Correct usage of these service capabilities must also consider the device's overall service capabilities. For example, even if the subscription supports voice calls, a voice call might not be feasible on a device that only supports data services. To determine the device's capabilities for voice and SMS services, refer to TelephonyManager#isDeviceVoiceCapable() and TelephonyManager#isDeviceSmsCapable().

Emergency service availability may not directly correlate with the subscription or device's general service capabilities. In some cases, emergency calls might be possible even if the subscription or device does not typically support voice services.

Returns
Set<Integer>	A set of integer representing the subscription's service capabilities, defined by SubscriptionManager#SERVICE_CAPABILITY_VOICE, SubscriptionManager#SERVICE_CAPABILITY_SMS and SubscriptionManager#SERVICE_CAPABILITY_DATA. This value cannot be null. Value is SubscriptionManager.SERVICE_CAPABILITY_VOICE, SubscriptionManager.SERVICE_CAPABILITY_SMS, or SubscriptionManager.SERVICE_CAPABILITY_DATA

See also:

• TelephonyManager.isDeviceVoiceCapable()
• TelephonyManager.isDeviceSmsCapable()
• CarrierConfigManager.KEY_CELLULAR_SERVICE_CAPABILITIES_INT_ARRAY
• SubscriptionManager.SERVICE_CAPABILITY_VOICE
• SubscriptionManager.SERVICE_CAPABILITY_SMS
• SubscriptionManager.SERVICE_CAPABILITY_DATA

getSimSlotIndex

Added in API level 22

public int getSimSlotIndex ()

Returns
int	The index of the SIM slot that currently contains the subscription and not necessarily unique and maybe SubscriptionManager#INVALID_SIM_SLOT_INDEX if unknown or the subscription is inactive.

getSubscriptionId

Added in API level 22

public int getSubscriptionId ()

Returns
int	The subscription ID.

getSubscriptionType

Added in API level 29

public int getSubscriptionType ()

This method returns the type of a subscription. It can be SubscriptionManager#SUBSCRIPTION_TYPE_LOCAL_SIM or SubscriptionManager#SUBSCRIPTION_TYPE_REMOTE_SIM.

Returns
int	The type of the subscription. Value is SubscriptionManager.SUBSCRIPTION_TYPE_LOCAL_SIM, or SubscriptionManager.SUBSCRIPTION_TYPE_REMOTE_SIM

getUsageSetting

Added in API level 33

public int getUsageSetting ()

Get the usage setting for this subscription.

Returns
int	The usage setting used for this subscription. Value is SubscriptionManager.USAGE_SETTING_UNKNOWN, SubscriptionManager.USAGE_SETTING_DEFAULT, SubscriptionManager.USAGE_SETTING_VOICE_CENTRIC, or SubscriptionManager.USAGE_SETTING_DATA_CENTRIC

hashCode

Added in API level 22

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.

isEmbedded

Added in API level 28

public boolean isEmbedded ()

Returns
boolean	true if the subscription is from eSIM.

isOnlyNonTerrestrialNetwork

Added in API level 35

public boolean isOnlyNonTerrestrialNetwork ()

Check if the subscription is exclusively for non-terrestrial networks.

Returns
boolean	true if it is a non-terrestrial network subscription, false otherwise.

isOpportunistic

Added in API level 29

public boolean isOpportunistic ()

An opportunistic subscription connects to a network that is limited in functionality and / or coverage.

Returns
boolean	Whether subscription is opportunistic.

toString

Added in API level 22

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 22

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: 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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES