Added in API level 22

SubscriptionInfo


open class SubscriptionInfo : Parcelable
kotlin.Any
   ↳ android.telephony.SubscriptionInfo

A Parcelable class for Subscription Information.

Summary

Inherited constants
Public methods
open Bitmap!

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

open Int

open Boolean
equals(other: Any?)

open Int

open Int

open CharSequence!

open String!

open Int

Whether user enables data roaming for this subscription or not.

open CharSequence!

open ParcelUuid?

Used in scenarios where different subscriptions are bundled as a group.

open String!

Returns the ICC ID.

open Int

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

open Int

open String?

open Int

open String?

open String!

Returns the number of this subscription.

open Int

open MutableSet<Int!>

Retrieves the service capabilities for the current subscription.

open Int

open Int

open Int

This method returns the type of a subscription.

open Int

Get the usage setting for this subscription.

open Int

open Boolean

open Boolean

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

open Boolean

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

open String

open Unit
writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<SubscriptionInfo!>

Public methods

createIconBitmap

Added in API level 22
open fun createIconBitmap(context: Context!): Bitmap!

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

Parameters
context Context!: A Context to get the DisplayMetricss from.
Return
Bitmap! A bitmap icon for this SubscriptionInfo.

describeContents

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

getCardId

Added in API level 29
open fun getCardId(): Int
Return
Int The card ID of the SIM card which contains the subscription.

getCarrierId

Added in API level 29
open fun getCarrierId(): Int
Return
Int The carrier id of this subscription carrier.

getCarrierName

Added in API level 22
open fun getCarrierName(): CharSequence!
Return
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.

getCountryIso

Added in API level 22
open fun getCountryIso(): String!
Return
String! The ISO country code. Empty if not available.

getDataRoaming

Added in API level 22
open fun getDataRoaming(): Int

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

getDisplayName

Added in API level 22
open fun getDisplayName(): CharSequence!
Return
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.

getGroupUuid

Added in API level 29
open fun getGroupUuid(): ParcelUuid?

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.

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

getIccId

Added in API level 22
open fun getIccId(): String!

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.

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

getIconTint

Added in API level 22
open fun getIconTint(): Int

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

Return
Int A hexadecimal color value.

getMcc

Added in API level 22
Deprecated in API level 29
open fun getMcc(): Int

Deprecated: Use getMccString() instead.

Return
Int The mobile country code.

getMccString

Added in API level 29
open fun getMccString(): String?
Return
String? The mobile country code. This value may be null.

getMnc

Added in API level 22
Deprecated in API level 29
open fun getMnc(): Int

Deprecated: Use getMncString() instead.

Return
Int The mobile network code.

getMncString

Added in API level 29
open fun getMncString(): String?
Return
String? The mobile network code. This value may be null.

getNumber

Added in API level 22
Deprecated in API level 33
open fun getNumber(): String!

Deprecated: 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 android.telephony.TelephonyManager#hasCarrierPrivileges).
  • If the calling app is the default SMS role holder.

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

getPortIndex

Added in API level 33
open fun getPortIndex(): Int
Return
Int The port index of the SIM card which contains the subscription.

getServiceCapabilities

Added in API level 35
open fun getServiceCapabilities(): MutableSet<Int!>

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.

Return
MutableSet<Int!> 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 android.telephony.SubscriptionManager#SERVICE_CAPABILITY_VOICE, android.telephony.SubscriptionManager#SERVICE_CAPABILITY_SMS, or android.telephony.SubscriptionManager#SERVICE_CAPABILITY_DATA

getSimSlotIndex

Added in API level 22
open fun getSimSlotIndex(): Int
Return
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
open fun getSubscriptionId(): Int
Return
Int The subscription ID.

getSubscriptionType

Added in API level 29
open fun getSubscriptionType(): Int

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

Return
Int The type of the subscription. Value is android.telephony.SubscriptionManager#SUBSCRIPTION_TYPE_LOCAL_SIM, or android.telephony.SubscriptionManager#SUBSCRIPTION_TYPE_REMOTE_SIM

hashCode

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

isEmbedded

Added in API level 28
open fun isEmbedded(): Boolean
Return
Boolean true if the subscription is from eSIM.

isOnlyNonTerrestrialNetwork

Added in API level 35
open fun isOnlyNonTerrestrialNetwork(): Boolean

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

Return
Boolean true if it is a non-terrestrial network subscription, false otherwise.

isOpportunistic

Added in API level 29
open fun isOpportunistic(): Boolean

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

Return
Boolean Whether subscription is opportunistic.

toString

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

writeToParcel

Added in API level 22
open fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit
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_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 22
static val CREATOR: Parcelable.Creator<SubscriptionInfo!>