SubscriptionInfo
  public
  
  
  
  class
  SubscriptionInfo
  
    extends Object
  
  
  
  
  
      implements
      
        Parcelable
      
  
  
| java.lang.Object | |
| ↳ | android.telephony.SubscriptionInfo | 
A Parcelable class for Subscription Information.
Summary
| Inherited constants | 
|---|
| Fields | |
|---|---|
| 
    public
    static
    final
    Creator<SubscriptionInfo> | CREATOR
 | 
| Public methods | |
|---|---|
| 
        
        
        
        
        
        Bitmap | 
      createIconBitmap(Context context)
      Creates and returns an icon  | 
| 
        
        
        
        
        
        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  | 
| 
        
        
        
        
        
        int | 
      getMcc()
      
      This method was deprecated
      in API level 29.
    Use  | 
| 
        
        
        
        
        
        String | 
      getMccString()
       | 
| 
        
        
        
        
        
        int | 
      getMnc()
      
      This method was deprecated
      in API level 29.
    Use  | 
| 
        
        
        
        
        
        String | 
      getMncString()
       | 
| 
        
        
        
        
        
        String | 
      getNumber()
      
      This method was deprecated
      in API level 33.
    use  | 
| 
        
        
        
        
        
        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 | |
|---|---|
Fields
Public methods
createIconBitmap
public Bitmap createIconBitmap (Context context)
Creates and returns an icon Bitmap to represent this SubscriptionInfo in a
 user interface.
| Parameters | |
|---|---|
| context | Context: AContextto get theDisplayMetricss from. | 
| Returns | |
|---|---|
| Bitmap | A bitmap icon for this SubscriptionInfo. | 
describeContents
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 0orCONTENTS_FILE_DESCRIPTOR | 
equals
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 returntrue.
- It is symmetric: for any non-null reference values
     xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue.
- It is transitive: for any non-null reference values
     x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
- It is consistent: for any non-null reference values
     xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified.
- For any non-null reference value x,x.equals(null)should returnfalse.
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 | trueif this object is the same as the obj
          argument;falseotherwise. | 
getCardId
public int getCardId ()
| Returns | |
|---|---|
| int | The card ID of the SIM card which contains the subscription. | 
See also:
getCarrierId
public int getCarrierId ()
| Returns | |
|---|---|
| int | The carrier id of this subscription carrier. | 
See also:
getCarrierName
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:
getCountryIso
public String getCountryIso ()
| Returns | |
|---|---|
| String | The ISO country code. Empty if not available. | 
getDataRoaming
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
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:
getGroupUuid
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
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
public int getIconTint ()
A highlight color to use in displaying information about this PhoneAccount.
| Returns | |
|---|---|
| int | A hexadecimal color value. | 
getMcc
public int getMcc ()
      This method was deprecated
      in API level 29.
    Use getMccString() instead.
  
| Returns | |
|---|---|
| int | The mobile country code. | 
getMccString
public String getMccString ()
| Returns | |
|---|---|
| String | The mobile country code.
 This value may be null. | 
getMnc
public int getMnc ()
      This method was deprecated
      in API level 29.
    Use getMncString() instead.
  
| Returns | |
|---|---|
| int | The mobile network code. | 
getMncString
public String getMncString ()
| Returns | |
|---|---|
| String | The mobile network code.
 This value may be null. | 
getNumber
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
public int getPortIndex ()
| Returns | |
|---|---|
| int | The port index of the SIM card which contains the subscription. | 
getServiceCapabilities
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_SMSandSubscriptionManager#SERVICE_CAPABILITY_DATA.
 This value cannot benull.
 Value isSubscriptionManager.SERVICE_CAPABILITY_VOICE,SubscriptionManager.SERVICE_CAPABILITY_SMS, orSubscriptionManager.SERVICE_CAPABILITY_DATA | 
getSimSlotIndex
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_INDEXif unknown or
 the subscription is inactive. | 
getSubscriptionId
public int getSubscriptionId ()
| Returns | |
|---|---|
| int | The subscription ID. | 
getSubscriptionType
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, orSubscriptionManager.SUBSCRIPTION_TYPE_REMOTE_SIM | 
getUsageSetting
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, orSubscriptionManager.USAGE_SETTING_DATA_CENTRIC | 
hashCode
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 hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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 equalsmethod, then calling thehashCodemethod 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 equalsmethod, then calling thehashCodemethod 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
public boolean isEmbedded ()
| Returns | |
|---|---|
| boolean | trueif the subscription is from eSIM. | 
isOnlyNonTerrestrialNetwork
public boolean isOnlyNonTerrestrialNetwork ()
Check if the subscription is exclusively for non-terrestrial networks.
| Returns | |
|---|---|
| boolean | trueif it is a non-terrestrial network subscription,falseotherwise. | 
isOpportunistic
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
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
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 benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
