* The returned TelephonyManager will use the default subscription for all calls.
* To call an API for a specific subscription, use {@link #createForSubscriptionId(int)}. e.g.
*
* telephonyManager = defaultSubTelephonyManager.createForSubscriptionId(subId);
*
*
* Note that access to some telephony information is * permission-protected. Your application cannot access the protected * information unless it has the appropriate permissions declared in * its manifest file. Where permissions apply, they are noted in the * the methods through which you access the protected information. * *
TelephonyManager is intended for use on devices that implement * {@link android.content.pm.PackageManager#FEATURE_TELEPHONY FEATURE_TELEPHONY}. On devices * that do not implement this feature, the behavior is not reliable. */ @SystemService(Context.TELEPHONY_SERVICE) @RequiresFeature(PackageManager.FEATURE_TELEPHONY) public class TelephonyManager { private static final String TAG = "TelephonyManager"; private TelephonyRegistryManager mTelephonyRegistryMgr; /** * To expand the error codes for {@link TelephonyManager#updateAvailableNetworks} and * {@link TelephonyManager#setPreferredOpportunisticDataSubscription}. */ @ChangeId @EnabledAfter(targetSdkVersion = Build.VERSION_CODES.Q) private static final long CALLBACK_ON_MORE_ERROR_CODE_CHANGE = 130595455L; /** * The key to use when placing the result of {@link #requestModemActivityInfo(ResultReceiver)} * into the ResultReceiver Bundle. * @hide */ public static final String MODEM_ACTIVITY_RESULT_KEY = "controller_activity"; /** @hide */ public static final String EXCEPTION_RESULT_KEY = "exception"; /** * The process name of the Phone app as well as many other apps that use this process name, such * as settings and vendor components. * @hide */ public static final String PHONE_PROCESS_NAME = "com.android.phone"; /** * The allowed states of Wi-Fi calling. * * @hide */ public interface WifiCallingChoices { /** Always use Wi-Fi calling */ static final int ALWAYS_USE = 0; /** Ask the user whether to use Wi-Fi on every call */ static final int ASK_EVERY_TIME = 1; /** Never use Wi-Fi calling */ static final int NEVER_USE = 2; } /** @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = {"NETWORK_SELECTION_MODE_"}, value = { NETWORK_SELECTION_MODE_UNKNOWN, NETWORK_SELECTION_MODE_AUTO, NETWORK_SELECTION_MODE_MANUAL}) public @interface NetworkSelectionMode {} public static final int NETWORK_SELECTION_MODE_UNKNOWN = 0; public static final int NETWORK_SELECTION_MODE_AUTO = 1; public static final int NETWORK_SELECTION_MODE_MANUAL = 2; /** * Reasons for Radio being powered off. * * @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = {"RADIO_POWER_REASON_"}, value = { RADIO_POWER_REASON_USER, RADIO_POWER_REASON_THERMAL, RADIO_POWER_REASON_CARRIER, RADIO_POWER_REASON_NEARBY_DEVICE}) public @interface RadioPowerReason {} /** * This reason is used when users want to turn off radio, e.g., users turn on airplane mode. * * @hide */ @SystemApi public static final int RADIO_POWER_REASON_USER = 0; /** * This reason is used when radio needs to be turned off due to thermal. * * @hide */ @SystemApi public static final int RADIO_POWER_REASON_THERMAL = 1; /** * This reason is used when carriers want to turn off radio. A privileged app can request to * turn off radio via the system service * {@link com.android.carrierdefaultapp.CaptivePortalLoginActivity}, which subsequently calls * the system APIs {@link requestRadioPowerOffForReason} and * {@link clearRadioPowerOffForReason}. * * @hide */ @SystemApi public static final int RADIO_POWER_REASON_CARRIER = 2; /** * Used to reduce power on a battery-constrained device when Telephony services are available * via a paired device which is nearby. * * @hide */ @SystemApi public static final int RADIO_POWER_REASON_NEARBY_DEVICE = 3; /** The otaspMode passed to SercvieState changes */ /** @hide */ static public final int OTASP_UNINITIALIZED = 0; /** @hide */ static public final int OTASP_UNKNOWN = 1; /** @hide */ static public final int OTASP_NEEDED = 2; /** @hide */ static public final int OTASP_NOT_NEEDED = 3; /* OtaUtil has conflict enum 4: OtaUtils.OTASP_FAILURE_SPC_RETRIES */ /** @hide */ static public final int OTASP_SIM_UNPROVISIONED = 5; /** * Used in carrier Wi-Fi for IMSI + IMPI encryption, this indicates a public key that's * available for use in ePDG links. * * @hide */ @SystemApi static public final int KEY_TYPE_EPDG = 1; /** * Used in carrier Wi-Fi for IMSI + IMPI encryption, this indicates a public key that's * available for use in WLAN links. * * @hide */ @SystemApi static public final int KEY_TYPE_WLAN = 2; /** @hide */ @Retention(RetentionPolicy.SOURCE) @IntDef(prefix = {"KEY_TYPE_"}, value = {KEY_TYPE_EPDG, KEY_TYPE_WLAN}) public @interface KeyType {} /** * No Single Radio Voice Call Continuity (SRVCC) handover is active. * See TS 23.216 for more information. * @hide */ @SystemApi public static final int SRVCC_STATE_HANDOVER_NONE = -1; /** * Single Radio Voice Call Continuity (SRVCC) handover has been started on the network. * See TS 23.216 for more information. * @hide */ @SystemApi public static final int SRVCC_STATE_HANDOVER_STARTED = 0; /** * Ongoing Single Radio Voice Call Continuity (SRVCC) handover has successfully completed. * See TS 23.216 for more information. * @hide */ @SystemApi public static final int SRVCC_STATE_HANDOVER_COMPLETED = 1; /** * Ongoing Single Radio Voice Call Continuity (SRVCC) handover has failed. * See TS 23.216 for more information. * @hide */ @SystemApi public static final int SRVCC_STATE_HANDOVER_FAILED = 2; /** * Ongoing Single Radio Voice Call Continuity (SRVCC) handover has been canceled. * See TS 23.216 for more information. * @hide */ @SystemApi public static final int SRVCC_STATE_HANDOVER_CANCELED = 3; /** * Convert srvcc handover state to string. * * @param state The srvcc handover state. * @return The srvcc handover state in string format. * * @hide */ public static @NonNull String srvccStateToString(int state) { switch (state) { case TelephonyManager.SRVCC_STATE_HANDOVER_NONE: return "NONE"; case TelephonyManager.SRVCC_STATE_HANDOVER_STARTED: return "STARTED"; case TelephonyManager.SRVCC_STATE_HANDOVER_COMPLETED: return "COMPLETED"; case TelephonyManager.SRVCC_STATE_HANDOVER_FAILED: return "FAILED"; case TelephonyManager.SRVCC_STATE_HANDOVER_CANCELED: return "CANCELED"; default: return "UNKNOWN(" + state + ")"; } } /** * A UICC card identifier used if the device does not support the operation. * For example, {@link #getCardIdForDefaultEuicc()} returns this value if the device has no * eUICC, or the eUICC cannot be read. */ public static final int UNSUPPORTED_CARD_ID = -1; /** * A UICC card identifier used before the UICC card is loaded. See * {@link #getCardIdForDefaultEuicc()} and {@link UiccCardInfo#getCardId()}. *
* Note that once the UICC card is loaded, the card ID may become {@link #UNSUPPORTED_CARD_ID}.
*/
public static final int UNINITIALIZED_CARD_ID = -2;
/**
* Default port index for a UICC.
*
* On physical SIM cards the only available port is 0.
* See {@link android.telephony.UiccPortInfo} for more information on ports.
*
* See {@link android.telephony.euicc.EuiccManager#isSimPortAvailable(int)} for information on
* how portIndex is used on eUICCs.
*/
public static final int DEFAULT_PORT_INDEX = 0;
/** @hide */
public static final int INVALID_PORT_INDEX = -1;
/** @hide */
public static final String PROPERTY_ENABLE_NULL_CIPHER_TOGGLE = "enable_null_cipher_toggle";
/**
* To apply the enforcement telephony feature and API
* @hide
*/
@ChangeId
@EnabledSince(targetSdkVersion = Build.VERSION_CODES.VANILLA_ICE_CREAM)
public static final long ENABLE_FEATURE_MAPPING = 297989574L;
private final Context mContext;
private final int mSubId;
@UnsupportedAppUsage
private SubscriptionManager mSubscriptionManager;
private TelephonyScanManager mTelephonyScanManager;
/** Cached service handles, cleared by resetServiceHandles() at death */
private static final Object sCacheLock = new Object();
/** @hide */
private static boolean sServiceHandleCacheEnabled = true;
@GuardedBy("sCacheLock")
private static ITelephony sITelephony;
@GuardedBy("sCacheLock")
private static IPhoneSubInfo sIPhoneSubInfo;
@GuardedBy("sCacheLock")
private static ISub sISub;
@GuardedBy("sCacheLock")
private static ISms sISms;
@GuardedBy("sCacheLock")
private static final DeathRecipient sServiceDeath = new DeathRecipient();
/**
* Cache key for a {@link PropertyInvalidatedCache} which maps from {@link PhoneAccountHandle}
* to subscription Id. The cache is initialized in {@code PhoneInterfaceManager}'s constructor
* when {@link PropertyInvalidatedCache#invalidateCache(String)} is called.
* The cache is cleared from {@code TelecomAccountRegistry#tearDown} when all phone accounts are
* removed from Telecom.
* @hide
*/
public static final String CACHE_KEY_PHONE_ACCOUNT_TO_SUBID =
"cache_key.telephony.phone_account_to_subid";
private static final int CACHE_MAX_SIZE = 4;
/**
* A {@link PropertyInvalidatedCache} which lives in an app's {@link TelephonyManager} instance.
* Caches any queries for a mapping between {@link PhoneAccountHandle} and {@code subscription
* id}. The cache may be invalidated from Telephony when phone account re-registration takes
* place.
*/
private PropertyInvalidatedCache This is not necessary unless you are invoking caller's code asynchronously from within
* the caller's thread context.
*
* @param r a runnable.
*/
private static void runOnBackgroundThread(@NonNull Runnable r) {
try {
BackgroundThread.getExecutor().execute(r);
} catch (RejectedExecutionException e) {
throw new IllegalStateException(
"Failed to post a callback from the caller's thread context.", e);
}
}
/**
* Returns the multi SIM variant
* Returns DSDS for Dual SIM Dual Standby
* Returns DSDA for Dual SIM Dual Active
* Returns TSTS for Triple SIM Triple Standby
* Returns UNKNOWN for others
*/
/** {@hide} */
@UnsupportedAppUsage
public MultiSimVariants getMultiSimConfiguration() {
String mSimConfig =
TelephonyProperties.multi_sim_config().orElse("");
if (mSimConfig.equals("dsds")) {
return MultiSimVariants.DSDS;
} else if (mSimConfig.equals("dsda")) {
return MultiSimVariants.DSDA;
} else if (mSimConfig.equals("tsts")) {
return MultiSimVariants.TSTS;
} else {
return MultiSimVariants.UNKNOWN;
}
}
/**
* Returns the number of phones available.
* Returns 0 if none of voice, sms, data is not supported
* Returns 1 for Single standby mode (Single SIM functionality).
* Returns 2 for Dual standby mode (Dual SIM functionality).
* Returns 3 for Tri standby mode (Tri SIM functionality).
* @deprecated Use {@link #getActiveModemCount} instead.
*/
@Deprecated
public int getPhoneCount() {
return getActiveModemCount();
}
/**
* Returns the number of logical modems currently configured to be activated.
*
* Returns 0 if none of voice, sms, data is not supported
* Returns 1 for Single standby mode (Single SIM functionality).
* Returns 2 for Dual standby mode (Dual SIM functionality).
* Returns 3 for Tri standby mode (Tri SIM functionality).
*/
public int getActiveModemCount() {
int modemCount = 1;
switch (getMultiSimConfiguration()) {
case UNKNOWN:
modemCount = 1;
// check for voice and data support, 0 if not supported
if (!isVoiceCapable() && !isSmsCapable() && !isDataCapable()) {
modemCount = 0;
}
break;
case DSDS:
case DSDA:
modemCount = 2;
break;
case TSTS:
modemCount = 3;
break;
}
return modemCount;
}
/**
* Return how many logical modem can be potentially active simultaneously, in terms of hardware
* capability.
* It might return different value from {@link #getActiveModemCount}. For example, for a
* dual-SIM capable device operating in single SIM mode (only one logical modem is turned on),
* {@link #getActiveModemCount} returns 1 while this API returns 2.
*/
public int getSupportedModemCount() {
return TelephonyProperties.max_active_modems().orElse(getActiveModemCount());
}
/**
* Gets the maximum number of SIMs that can be active, based on the device's multisim
* configuration.
* @return 1 for single-SIM, DSDS, and TSTS devices. 2 for DSDA devices.
* @hide
*/
@SystemApi
public int getMaxNumberOfSimultaneouslyActiveSims() {
switch (getMultiSimConfiguration()) {
case UNKNOWN:
case DSDS:
case TSTS:
return 1;
case DSDA:
return 2;
}
return 1;
}
/** {@hide} */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public static TelephonyManager from(Context context) {
return (TelephonyManager) context.getSystemService(Context.TELEPHONY_SERVICE);
}
/**
* Create a new TelephonyManager object pinned to the given subscription ID.
*
* @return a TelephonyManager that uses the given subId for all calls.
*/
public TelephonyManager createForSubscriptionId(int subId) {
// Don't reuse any TelephonyManager objects.
return new TelephonyManager(mContext, subId);
}
/**
* Create a new TelephonyManager object pinned to the subscription ID associated with the given
* phone account.
*
* @return a TelephonyManager that uses the given phone account for all calls, or {@code null}
* if the phone account does not correspond to a valid subscription ID.
*/
@Nullable
public TelephonyManager createForPhoneAccountHandle(PhoneAccountHandle phoneAccountHandle) {
int subId = getSubscriptionId(phoneAccountHandle);
if (!SubscriptionManager.isValidSubscriptionId(subId)) {
return null;
}
return new TelephonyManager(mContext, subId);
}
/** {@hide} */
@UnsupportedAppUsage
public boolean isMultiSimEnabled() {
return getPhoneCount() > 1;
}
private static final int MAXIMUM_CALL_COMPOSER_PICTURE_SIZE = 80000;
/**
* Indicates the maximum size of the call composure picture.
*
* Pictures sent via
* {@link #uploadCallComposerPicture(InputStream, String, Executor, OutcomeReceiver)}
* or {@link #uploadCallComposerPicture(Path, String, Executor, OutcomeReceiver)} must not
* exceed this size, or an error will be returned via the callback in those methods.
*
* @return Maximum file size in bytes.
*/
public static @BytesLong long getMaximumCallComposerPictureSize() {
return MAXIMUM_CALL_COMPOSER_PICTURE_SIZE;
}
//
// Broadcast Intent actions
//
/**
* Broadcast intent action indicating that the call state
* on the device has changed.
*
*
* The {@link #EXTRA_STATE} extra indicates the new call state.
* If a receiving app has {@link android.Manifest.permission#READ_CALL_LOG} permission, a second
* extra {@link #EXTRA_INCOMING_NUMBER} provides the phone number for incoming and outgoing
* calls as a String.
*
* If the receiving app has
* {@link android.Manifest.permission#READ_CALL_LOG} and
* {@link android.Manifest.permission#READ_PHONE_STATE} permission, it will receive the
* broadcast twice; one with the {@link #EXTRA_INCOMING_NUMBER} populated with the phone number,
* and another with it blank. Due to the nature of broadcasts, you cannot assume the order
* in which these broadcasts will arrive, however you are guaranteed to receive two in this
* case. Apps which are interested in the {@link #EXTRA_INCOMING_NUMBER} can ignore the
* broadcasts where {@link #EXTRA_INCOMING_NUMBER} is not present in the extras (e.g. where
* {@link Intent#hasExtra(String)} returns {@code false}).
*
* This was a {@link android.content.Context#sendStickyBroadcast sticky}
* broadcast in version 1.0, but it is no longer sticky.
* Instead, use {@link #getCallState} to synchronously query the current call state.
*
* @see #EXTRA_STATE
* @see #EXTRA_INCOMING_NUMBER
* @see #getCallState
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
public static final String ACTION_PHONE_STATE_CHANGED =
"android.intent.action.PHONE_STATE";
/**
* The Phone app sends this intent when a user opts to respond-via-message during an incoming
* call. By default, the device's default SMS app consumes this message and sends a text message
* to the caller. A third party app can also provide this functionality by consuming this Intent
* with a {@link android.app.Service} and sending the message using its own messaging system.
* The intent contains a URI (available from {@link android.content.Intent#getData})
* describing the recipient, using either the {@code sms:}, {@code smsto:}, {@code mms:},
* or {@code mmsto:} URI schema. Each of these URI schema carry the recipient information the
* same way: the path part of the URI contains the recipient's phone number or a comma-separated
* set of phone numbers if there are multiple recipients. For example, {@code
* smsto:2065551234}. The intent may also contain extras for the message text (in {@link
* android.content.Intent#EXTRA_TEXT}) and a message subject
* (in {@link android.content.Intent#EXTRA_SUBJECT}). Note:
* The intent-filter that consumes this Intent needs to be in a {@link android.app.Service}
* that requires the
* permission {@link android.Manifest.permission#SEND_RESPOND_VIA_MESSAGE}. For example, the service that receives this intent can be declared in the manifest file
* with an intent filter like this:
* Output: nothing.
*/
@SdkConstant(SdkConstantType.SERVICE_ACTION)
public static final String ACTION_RESPOND_VIA_MESSAGE =
"android.intent.action.RESPOND_VIA_MESSAGE";
/**
* The emergency dialer may choose to present activities with intent filters for this
* action as emergency assistance buttons that launch the activity when clicked.
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_EMERGENCY_ASSISTANCE =
"android.telephony.action.EMERGENCY_ASSISTANCE";
/**
* A boolean meta-data value indicating whether the voicemail settings should be hidden in the
* call settings page launched by
* {@link android.telecom.TelecomManager#ACTION_SHOW_CALL_SETTINGS}.
* Dialer implementations (see {@link android.telecom.TelecomManager#getDefaultDialerPackage()})
* which would also like to manage voicemail settings should set this meta-data to {@code true}
* in the manifest registration of their application.
*
* @see android.telecom.TelecomManager#ACTION_SHOW_CALL_SETTINGS
* @see #ACTION_CONFIGURE_VOICEMAIL
* @see #EXTRA_HIDE_PUBLIC_SETTINGS
*/
public static final String METADATA_HIDE_VOICEMAIL_SETTINGS_MENU =
"android.telephony.HIDE_VOICEMAIL_SETTINGS_MENU";
/**
* Open the voicemail settings activity to make changes to voicemail configuration.
*
*
* The {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra indicates which {@link PhoneAccountHandle} to
* configure voicemail.
* The {@link #EXTRA_HIDE_PUBLIC_SETTINGS} hides settings the dialer will modify through public
* API if set.
*
* @see #EXTRA_PHONE_ACCOUNT_HANDLE
* @see #EXTRA_HIDE_PUBLIC_SETTINGS
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_CONFIGURE_VOICEMAIL =
"android.telephony.action.CONFIGURE_VOICEMAIL";
/**
* The boolean value indicating whether the voicemail settings activity launched by {@link
* #ACTION_CONFIGURE_VOICEMAIL} should hide settings accessible through public API. This is
* used by dialer implementations which provides their own voicemail settings UI, but still
* needs to expose device specific voicemail settings to the user.
*
* @see #ACTION_CONFIGURE_VOICEMAIL
* @see #METADATA_HIDE_VOICEMAIL_SETTINGS_MENU
*/
public static final String EXTRA_HIDE_PUBLIC_SETTINGS =
"android.telephony.extra.HIDE_PUBLIC_SETTINGS";
/**
* @hide
*/
public static final boolean EMERGENCY_ASSISTANCE_ENABLED = true;
/**
* The lookup key used with the {@link #ACTION_PHONE_STATE_CHANGED} broadcast
* for a String containing the new call state.
*
*
* Retrieve with
* {@link android.content.Intent#getStringExtra(String)}.
*
* @see #EXTRA_STATE_IDLE
* @see #EXTRA_STATE_RINGING
* @see #EXTRA_STATE_OFFHOOK
*/
public static final String EXTRA_STATE = PhoneConstants.STATE_KEY;
/**
* Value used with {@link #EXTRA_STATE} corresponding to
* {@link #CALL_STATE_IDLE}.
*/
public static final String EXTRA_STATE_IDLE = PhoneConstants.State.IDLE.toString();
/**
* Value used with {@link #EXTRA_STATE} corresponding to
* {@link #CALL_STATE_RINGING}.
*/
public static final String EXTRA_STATE_RINGING = PhoneConstants.State.RINGING.toString();
/**
* Value used with {@link #EXTRA_STATE} corresponding to
* {@link #CALL_STATE_OFFHOOK}.
*/
public static final String EXTRA_STATE_OFFHOOK = PhoneConstants.State.OFFHOOK.toString();
/**
* Extra key used with the {@link #ACTION_PHONE_STATE_CHANGED} broadcast
* for a String containing the incoming or outgoing phone number.
*
* This extra is only populated for receivers of the {@link #ACTION_PHONE_STATE_CHANGED}
* broadcast which have been granted the {@link android.Manifest.permission#READ_CALL_LOG} and
* {@link android.Manifest.permission#READ_PHONE_STATE} permissions.
*
* For incoming calls, the phone number is only guaranteed to be populated when the
* {@link #EXTRA_STATE} changes from {@link #EXTRA_STATE_IDLE} to {@link #EXTRA_STATE_RINGING}.
* If the incoming caller is from an unknown number, the extra will be populated with an empty
* string.
* For outgoing calls, the phone number is only guaranteed to be populated when the
* {@link #EXTRA_STATE} changes from {@link #EXTRA_STATE_IDLE} to {@link #EXTRA_STATE_OFFHOOK}.
*
* Retrieve with
* {@link android.content.Intent#getStringExtra(String)}.
*
*
* @deprecated Companion apps for wearable devices should use the {@link InCallService} API
* to retrieve the phone number for calls instead. Apps performing call screening should use
* the {@link CallScreeningService} API instead.
*/
@Deprecated
public static final String EXTRA_INCOMING_NUMBER = "incoming_number";
/**
* Broadcast intent action indicating that call disconnect cause has changed.
*
*
* The {@link #EXTRA_DISCONNECT_CAUSE} extra indicates the disconnect cause.
* The {@link #EXTRA_PRECISE_DISCONNECT_CAUSE} extra indicates the precise disconnect cause.
*
*
* Requires the READ_PRECISE_PHONE_STATE permission.
*
* @see #EXTRA_DISCONNECT_CAUSE
* @see #EXTRA_PRECISE_DISCONNECT_CAUSE
*
* @hide
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_CALL_DISCONNECT_CAUSE_CHANGED =
"android.intent.action.CALL_DISCONNECT_CAUSE";
/**
* The lookup key used with the {@link #ACTION_PRECISE_CALL_STATE_CHANGED} broadcast and {@link
* TelephonyCallback.PreciseCallStateListener#onPreciseCallStateChanged(PreciseCallState)} for
* an integer containing the disconnect cause.
*
* @see DisconnectCause
*
*
* Retrieve with
* {@link android.content.Intent#getIntExtra(String name, int defaultValue)}.
*
* @deprecated Should use the {@link TelecomManager#EXTRA_DISCONNECT_CAUSE} instead.
* @hide
*/
@Deprecated
public static final String EXTRA_DISCONNECT_CAUSE = "disconnect_cause";
/**
* The lookup key used with the {@link #ACTION_PRECISE_CALL_STATE_CHANGED} broadcast and {@link
* TelephonyCallback.PreciseCallStateListener#onPreciseCallStateChanged(PreciseCallState)} for
* an integer containing the disconnect cause provided by the RIL.
*
* @see PreciseDisconnectCause
*
*
* Retrieve with
* {@link android.content.Intent#getIntExtra(String name, int defaultValue)}.
*
* @hide
*/
public static final String EXTRA_PRECISE_DISCONNECT_CAUSE = "precise_disconnect_cause";
/**
* Broadcast intent action for letting the default dialer to know to show voicemail
* notification.
*
*
* The {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra indicates which {@link PhoneAccountHandle} the
* voicemail is received on.
* The {@link #EXTRA_NOTIFICATION_COUNT} extra indicates the total numbers of unheard
* voicemails.
* The {@link #EXTRA_VOICEMAIL_NUMBER} extra indicates the voicemail number if available.
* The {@link #EXTRA_CALL_VOICEMAIL_INTENT} extra is a {@link android.app.PendingIntent} that
* will call the voicemail number when sent. This extra will be empty if the voicemail number
* is not set, and {@link #EXTRA_LAUNCH_VOICEMAIL_SETTINGS_INTENT} will be set instead.
* The {@link #EXTRA_LAUNCH_VOICEMAIL_SETTINGS_INTENT} extra is a
* {@link android.app.PendingIntent} that will launch the voicemail settings. This extra is only
* available when the voicemail number is not set.
* The {@link #EXTRA_IS_REFRESH} extra indicates whether the notification is a refresh or a new
* notification.
*
* @see #EXTRA_PHONE_ACCOUNT_HANDLE
* @see #EXTRA_NOTIFICATION_COUNT
* @see #EXTRA_VOICEMAIL_NUMBER
* @see #EXTRA_CALL_VOICEMAIL_INTENT
* @see #EXTRA_LAUNCH_VOICEMAIL_SETTINGS_INTENT
* @see #EXTRA_IS_REFRESH
*/
public static final String ACTION_SHOW_VOICEMAIL_NOTIFICATION =
"android.telephony.action.SHOW_VOICEMAIL_NOTIFICATION";
/**
* The extra used with an {@link #ACTION_CONFIGURE_VOICEMAIL} and
* {@link #ACTION_SHOW_VOICEMAIL_NOTIFICATION} {@code Intent} to specify the
* {@link PhoneAccountHandle} the configuration or notification is for.
*
* Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
*/
public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
"android.telephony.extra.PHONE_ACCOUNT_HANDLE";
/**
* The number of voice messages associated with the notification.
*/
public static final String EXTRA_NOTIFICATION_COUNT =
"android.telephony.extra.NOTIFICATION_COUNT";
/**
* The voicemail number.
*/
public static final String EXTRA_VOICEMAIL_NUMBER =
"android.telephony.extra.VOICEMAIL_NUMBER";
/**
* The intent to call voicemail.
*/
public static final String EXTRA_CALL_VOICEMAIL_INTENT =
"android.telephony.extra.CALL_VOICEMAIL_INTENT";
/**
* The intent to launch voicemail settings.
*/
public static final String EXTRA_LAUNCH_VOICEMAIL_SETTINGS_INTENT =
"android.telephony.extra.LAUNCH_VOICEMAIL_SETTINGS_INTENT";
/**
* Boolean value representing whether the {@link
* TelephonyManager#ACTION_SHOW_VOICEMAIL_NOTIFICATION} is new or a refresh of an existing
* notification. Notification refresh happens after reboot or connectivity changes. The user has
* already been notified for the voicemail so it should not alert the user, and should not be
* shown again if the user has dismissed it.
*/
public static final String EXTRA_IS_REFRESH = "android.telephony.extra.IS_REFRESH";
/**
* {@link android.telecom.Connection} event used to indicate that an IMS call has be
* successfully handed over from WIFI to LTE.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_HANDOVER_VIDEO_FROM_WIFI_TO_LTE =
"android.telephony.event.EVENT_HANDOVER_VIDEO_FROM_WIFI_TO_LTE";
/**
* {@link android.telecom.Connection} event used to indicate that an IMS call has be
* successfully handed over from LTE to WIFI.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_HANDOVER_VIDEO_FROM_LTE_TO_WIFI =
"android.telephony.event.EVENT_HANDOVER_VIDEO_FROM_LTE_TO_WIFI";
/**
* {@link android.telecom.Connection} event used to indicate that an IMS call failed to be
* handed over from LTE to WIFI.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_HANDOVER_TO_WIFI_FAILED =
"android.telephony.event.EVENT_HANDOVER_TO_WIFI_FAILED";
/**
* {@link android.telecom.Connection} event used to indicate that a video call was downgraded to
* audio because the data limit was reached.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_DOWNGRADE_DATA_LIMIT_REACHED =
"android.telephony.event.EVENT_DOWNGRADE_DATA_LIMIT_REACHED";
/**
* {@link android.telecom.Connection} event used to indicate that a video call was downgraded to
* audio because the data was disabled.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_DOWNGRADE_DATA_DISABLED =
"android.telephony.event.EVENT_DOWNGRADE_DATA_DISABLED";
/**
* {@link android.telecom.Connection} event used to indicate that the InCall UI should notify
* the user when an international call is placed while on WFC only.
*
* Used when the carrier config value
* {@link CarrierConfigManager#KEY_NOTIFY_INTERNATIONAL_CALL_ON_WFC_BOOL} is true, the device
* is on WFC (VoLTE not available) and an international number is dialed.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_NOTIFY_INTERNATIONAL_CALL_ON_WFC =
"android.telephony.event.EVENT_NOTIFY_INTERNATIONAL_CALL_ON_WFC";
/**
* {@link android.telecom.Connection} event used to indicate that an outgoing call has been
* forwarded to another number.
*
* Sent in response to an IMS supplementary service notification indicating the call has been
* forwarded.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to be null when this connection event is used.
* @hide
*/
public static final String EVENT_CALL_FORWARDED =
"android.telephony.event.EVENT_CALL_FORWARDED";
/**
* {@link android.telecom.Connection} event used to indicate that a supplementary service
* notification has been received.
*
* Sent via {@link android.telecom.Connection#sendConnectionEvent(String, Bundle)}.
* The {@link Bundle} parameter is expected to include the following extras:
*
* The dialer app receives this event via
* {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
*
* The {@link Bundle} parameter is guaranteed to include the following extras if the below
* conditions are met:
*
* If the device is connected to satellite via carrier within the hysteresis time defined by
* the carrier config
* {@link CarrierConfigManager#KEY_SATELLITE_CONNECTION_HYSTERESIS_SEC_INT}, the component of
* the {@link #EXTRA_EMERGENCY_CALL_TO_SATELLITE_LAUNCH_INTENT} will be set to the default SMS
* app.
*
* Otherwise, if the overlay config {@code config_oem_enabled_satellite_handover_app} is
* present, the app defined by this config will be used as the component of the
* {@link #EXTRA_EMERGENCY_CALL_TO_SATELLITE_LAUNCH_INTENT}. If this overlay config is empty,
* {@link #EXTRA_EMERGENCY_CALL_TO_SATELLITE_LAUNCH_INTENT} will not be included in the event
* {@link #EVENT_DISPLAY_EMERGENCY_MESSAGE}.
*/
@FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)
public static final String EVENT_DISPLAY_EMERGENCY_MESSAGE =
"android.telephony.event.DISPLAY_EMERGENCY_MESSAGE";
/**
* Integer extra key used with {@link #EVENT_DISPLAY_EMERGENCY_MESSAGE} which indicates
* the type of handover from emergency call to satellite messaging.
*
* Will be either
* android.telephony.satellite.SatelliteManager#EMERGENCY_CALL_TO_SATELLITE_HANDOVER_TYPE_SOS
* or
* android.telephony.satellite.SatelliteManager#EMERGENCY_CALL_TO_SATELLITE_HANDOVER_TYPE_T911
*
* Set in the extras for the {@link #EVENT_DISPLAY_EMERGENCY_MESSAGE} connection event.
*/
@FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)
public static final String EXTRA_EMERGENCY_CALL_TO_SATELLITE_HANDOVER_TYPE =
"android.telephony.extra.EMERGENCY_CALL_TO_SATELLITE_HANDOVER_TYPE";
/**
* Extra key used with the {@link #EVENT_DISPLAY_EMERGENCY_MESSAGE} for a {@link PendingIntent}
* which will be launched by the Dialer app.
*/
@FlaggedApi(Flags.FLAG_OEM_ENABLED_SATELLITE_FLAG)
public static final String EXTRA_EMERGENCY_CALL_TO_SATELLITE_LAUNCH_INTENT =
"android.telephony.extra.EMERGENCY_CALL_TO_SATELLITE_LAUNCH_INTENT";
/**
* Integer extra key used with {@link #EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION} which indicates
* the type of supplementary service notification which occurred.
* Will be either
* {@link com.android.internal.telephony.gsm.SuppServiceNotification#NOTIFICATION_TYPE_CODE_1}
* or
* {@link com.android.internal.telephony.gsm.SuppServiceNotification#NOTIFICATION_TYPE_CODE_2}
*
* Set in the extras for the {@link #EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION} connection event.
* @hide
*/
public static final String EXTRA_NOTIFICATION_TYPE =
"android.telephony.extra.NOTIFICATION_TYPE";
/**
* Integer extra key used with {@link #EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION} which indicates
* the supplementary service notification which occurred.
*
* Depending on the {@link #EXTRA_NOTIFICATION_TYPE}, the code will be one of the {@code CODE_*}
* codes defined in {@link com.android.internal.telephony.gsm.SuppServiceNotification}.
*
* Set in the extras for the {@link #EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION} connection event.
* @hide
*/
public static final String EXTRA_NOTIFICATION_CODE =
"android.telephony.extra.NOTIFICATION_CODE";
/**
* {@link CharSequence} extra key used with {@link #EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION}
* which contains a human-readable message which can be displayed to the user for the
* supplementary service notification.
*
* Set in the extras for the {@link #EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION} connection event.
* @hide
*/
public static final String EXTRA_NOTIFICATION_MESSAGE =
"android.telephony.extra.NOTIFICATION_MESSAGE";
/* Visual voicemail protocols */
/**
* The OMTP protocol.
*/
public static final String VVM_TYPE_OMTP = "vvm_type_omtp";
/**
* A flavor of OMTP protocol with a different mobile originated (MO) format
*/
public static final String VVM_TYPE_CVVM = "vvm_type_cvvm";
/**
* Key in bundle returned by {@link #getVisualVoicemailPackageName()}, indicating whether visual
* voicemail was enabled or disabled by the user. If the user never explicitly changed this
* setting, this key will not exist.
*
* @see #getVisualVoicemailSettings()
* @hide
*/
@SystemApi
public static final String EXTRA_VISUAL_VOICEMAIL_ENABLED_BY_USER_BOOL =
"android.telephony.extra.VISUAL_VOICEMAIL_ENABLED_BY_USER_BOOL";
/**
* Key in bundle returned by {@link #getVisualVoicemailPackageName()}, indicating the voicemail
* access PIN scrambled during the auto provisioning process. The user is expected to reset
* their PIN if this value is not {@code null}.
*
* @see #getVisualVoicemailSettings()
* @hide
*/
@SystemApi
public static final String EXTRA_VOICEMAIL_SCRAMBLED_PIN_STRING =
"android.telephony.extra.VOICEMAIL_SCRAMBLED_PIN_STRING";
/**
* Broadcast action to be received by Broadcast receivers.
*
* Indicates multi-SIM configuration is changed. For example, it changed
* from single SIM capable to dual-SIM capable (DSDS or DSDA) or triple-SIM mode.
*
* It doesn't indicate how many subscriptions are actually active, or which states SIMs are,
* or that all steps during multi-SIM change are done. To know those information you still need
* to listen to SIM_STATE changes or active subscription changes.
*
* See extra of {@link #EXTRA_ACTIVE_SIM_SUPPORTED_COUNT} for updated value.
*/
public static final String ACTION_MULTI_SIM_CONFIG_CHANGED =
"android.telephony.action.MULTI_SIM_CONFIG_CHANGED";
/**
* The number of active SIM supported by current multi-SIM config. It's not related to how many
* SIM/subscriptions are currently active.
*
* Same value will be returned by {@link #getActiveModemCount()}.
*
* For single SIM mode, it's 1.
* For DSDS or DSDA mode, it's 2.
* For triple-SIM mode, it's 3.
*
* Extra of {@link #ACTION_MULTI_SIM_CONFIG_CHANGED}.
*
* type: integer
*/
public static final String EXTRA_ACTIVE_SIM_SUPPORTED_COUNT =
"android.telephony.extra.ACTIVE_SIM_SUPPORTED_COUNT";
/**
* @hide
*/
public static final String USSD_RESPONSE = "USSD_RESPONSE";
/**
* USSD return code success.
* @hide
*/
public static final int USSD_RETURN_SUCCESS = 100;
/**
* Failed code returned when the mobile network has failed to complete a USSD request.
*
* Returned via {@link TelephonyManager.UssdResponseCallback#onReceiveUssdResponseFailed(
* TelephonyManager, String, int)}.
*/
public static final int USSD_RETURN_FAILURE = -1;
/**
* Failure code returned when a USSD request has failed to execute because the Telephony
* service is unavailable.
*
* Returned via {@link TelephonyManager.UssdResponseCallback#onReceiveUssdResponseFailed(
* TelephonyManager, String, int)}.
*/
public static final int USSD_ERROR_SERVICE_UNAVAIL = -2;
/**
* Value for {@link CarrierConfigManager#KEY_CDMA_ROAMING_MODE_INT} which leaves the roaming
* mode set to the radio default or to the user's preference if they've indicated one.
*/
public static final int CDMA_ROAMING_MODE_RADIO_DEFAULT = -1;
/**
* Value for {@link CarrierConfigManager#KEY_CDMA_ROAMING_MODE_INT} which only permits
* connections on home networks.
*/
public static final int CDMA_ROAMING_MODE_HOME = 0;
/**
* Value for {@link CarrierConfigManager#KEY_CDMA_ROAMING_MODE_INT} which permits roaming on
* affiliated networks.
*/
public static final int CDMA_ROAMING_MODE_AFFILIATED = 1;
/**
* Value for {@link CarrierConfigManager#KEY_CDMA_ROAMING_MODE_INT} which permits roaming on
* any network.
*/
public static final int CDMA_ROAMING_MODE_ANY = 2;
/** @hide */
@IntDef(prefix = { "CDMA_ROAMING_MODE_" }, value = {
CDMA_ROAMING_MODE_RADIO_DEFAULT,
CDMA_ROAMING_MODE_HOME,
CDMA_ROAMING_MODE_AFFILIATED,
CDMA_ROAMING_MODE_ANY
})
@Retention(RetentionPolicy.SOURCE)
public @interface CdmaRoamingMode{}
/**
* An unknown carrier id. It could either be subscription unavailable or the subscription
* carrier cannot be recognized. Unrecognized carriers here means
* {@link #getSimOperator() MCC+MNC} cannot be identified.
*/
public static final int UNKNOWN_CARRIER_ID = -1;
/**
* An unknown carrier id list version.
* @hide
*/
@TestApi
public static final int UNKNOWN_CARRIER_ID_LIST_VERSION = -1;
/**
* Broadcast Action: The subscription carrier identity has changed.
* This intent could be sent on the following events:
* This is a protected intent that can only be sent by the system.
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED =
"android.telephony.action.SUBSCRIPTION_CARRIER_IDENTITY_CHANGED";
/**
* An int extra used with {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED} which indicates
* the updated carrier id returned by {@link TelephonyManager#getSimCarrierId()}.
* Will be {@link TelephonyManager#UNKNOWN_CARRIER_ID} if the subscription is unavailable or
* the carrier cannot be identified.
*/
public static final String EXTRA_CARRIER_ID = "android.telephony.extra.CARRIER_ID";
/**
* An string extra used with {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED} which
* indicates the updated carrier name of the current subscription.
* @see TelephonyManager#getSimCarrierIdName()
* Carrier name is a user-facing name of the carrier id {@link #EXTRA_CARRIER_ID},
* usually the brand name of the subsidiary (e.g. T-Mobile).
*/
public static final String EXTRA_CARRIER_NAME = "android.telephony.extra.CARRIER_NAME";
/**
* Broadcast Action: The subscription specific carrier identity has changed.
*
* A specific carrier ID returns the fine-grained carrier ID of the current subscription.
* It can represent the fact that a carrier may be in effect an aggregation of other carriers
* (ie in an MVNO type scenario) where each of these specific carriers which are used to make
* up the actual carrier service may have different carrier configurations.
* A specific carrier ID could also be used, for example, in a scenario where a carrier requires
* different carrier configuration for different service offering such as a prepaid plan.
*
* the specific carrier ID would be used for configuration purposes, but apps wishing to know
* about the carrier itself should use the regular carrier ID returned by
* {@link #getSimCarrierId()}.
*
* Similar like {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED}, this intent will be
* sent on the event of {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED} while its also
* possible to be sent without {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED} when
* specific carrier ID changes while carrier ID remains the same.
* e.g, the same subscription switches to different IMSI could potentially change its
* specific carrier ID while carrier id remains the same.
* @see #getSimSpecificCarrierId()
* @see #getSimCarrierId()
*
* The intent will have the following extra values:
* This is a protected intent that can only be sent by the system.
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SUBSCRIPTION_SPECIFIC_CARRIER_IDENTITY_CHANGED =
"android.telephony.action.SUBSCRIPTION_SPECIFIC_CARRIER_IDENTITY_CHANGED";
/**
* An int extra used with {@link #ACTION_SUBSCRIPTION_SPECIFIC_CARRIER_IDENTITY_CHANGED} which
* indicates the updated specific carrier id returned by
* {@link TelephonyManager#getSimSpecificCarrierId()}. Note, its possible specific carrier id
* changes while {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED} remains the same
* e.g, when subscription switch to different IMSIs.
* Will be {@link TelephonyManager#UNKNOWN_CARRIER_ID} if the subscription is unavailable or
* the carrier cannot be identified.
*/
public static final String EXTRA_SPECIFIC_CARRIER_ID =
"android.telephony.extra.SPECIFIC_CARRIER_ID";
/**
* An string extra used with {@link #ACTION_SUBSCRIPTION_SPECIFIC_CARRIER_IDENTITY_CHANGED}
* which indicates the updated specific carrier name returned by
* {@link TelephonyManager#getSimSpecificCarrierIdName()}.
* it's a user-facing name of the specific carrier id {@link #EXTRA_SPECIFIC_CARRIER_ID}
* e.g, Tracfone-AT&T
*/
public static final String EXTRA_SPECIFIC_CARRIER_NAME =
"android.telephony.extra.SPECIFIC_CARRIER_NAME";
/**
* An int extra used with {@link #ACTION_SUBSCRIPTION_CARRIER_IDENTITY_CHANGED} to indicate the
* subscription which has changed; or in general whenever a subscription ID needs specified.
*/
public static final String EXTRA_SUBSCRIPTION_ID = "android.telephony.extra.SUBSCRIPTION_ID";
/**
* Broadcast Action: The Service Provider string(s) have been updated. Activities or
* services that use these strings should update their display.
*
* The intent will have the following extra values:
* Note: this is a protected intent that can only be sent by the system.
* @hide
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SERVICE_PROVIDERS_UPDATED =
"android.telephony.action.SERVICE_PROVIDERS_UPDATED";
/**
* String intent extra to be used with {@link ACTION_SERVICE_PROVIDERS_UPDATED} to indicate
* whether the PLMN should be shown.
* @hide
*/
public static final String EXTRA_SHOW_PLMN = "android.telephony.extra.SHOW_PLMN";
/**
* String intent extra to be used with {@link ACTION_SERVICE_PROVIDERS_UPDATED} to indicate
* the operator name of the registered network.
* @hide
*/
public static final String EXTRA_PLMN = "android.telephony.extra.PLMN";
/**
* String intent extra to be used with {@link ACTION_SERVICE_PROVIDERS_UPDATED} to indicate
* whether the PLMN should be shown.
* @hide
*/
public static final String EXTRA_SHOW_SPN = "android.telephony.extra.SHOW_SPN";
/**
* String intent extra to be used with {@link ACTION_SERVICE_PROVIDERS_UPDATED} to indicate
* the service provider name.
* @hide
*/
public static final String EXTRA_SPN = "android.telephony.extra.SPN";
/**
* String intent extra to be used with {@link ACTION_SERVICE_PROVIDERS_UPDATED} to indicate
* the service provider name for data service.
* @hide
*/
public static final String EXTRA_DATA_SPN = "android.telephony.extra.DATA_SPN";
/**
* Broadcast intent action indicating that when data stall recovery is attempted by Telephony,
* intended for report every data stall recovery step attempted.
*
*
* The {@link #EXTRA_RECOVERY_ACTION} extra indicates the action associated with the data
* stall recovery.
* The phone id where the data stall recovery is attempted.
*
*
* Requires the READ_PHONE_STATE permission.
*
*
* This is a protected intent that can only be sent by the system.
*
* @see #EXTRA_RECOVERY_ACTION
*
* @hide
*/
// TODO(b/78370030) : Restrict this to system applications only
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
public static final String ACTION_DATA_STALL_DETECTED =
"android.intent.action.DATA_STALL_DETECTED";
/**
* A service action that identifies
* a {@link android.service.carrier.CarrierMessagingClientService} subclass in the
* AndroidManifest.xml.
*
* See {@link android.service.carrier.CarrierMessagingClientService} for the details.
*/
@SdkConstant(SdkConstantType.SERVICE_ACTION)
public static final String ACTION_CARRIER_MESSAGING_CLIENT_SERVICE =
"android.telephony.action.CARRIER_MESSAGING_CLIENT_SERVICE";
/**
* An int extra used with {@link #ACTION_DATA_STALL_DETECTED} to indicate the
* action associated with the data stall recovery.
*
* @see #ACTION_DATA_STALL_DETECTED
*
* @hide
*/
public static final String EXTRA_RECOVERY_ACTION = "recoveryAction";
private static final long MAX_NUMBER_VERIFICATION_TIMEOUT_MILLIS = 60000;
/**
* Intent sent when an error occurs that debug tools should log and possibly take further
* action such as capturing vendor-specific logs.
*
* A privileged application that reads these events should take appropriate vendor-specific
* action to record the event and collect further information to assist in analysis, debugging,
* and resolution of any associated issue.
*
* This event should not be used for generic logging or diagnostic monitoring purposes and
* should generally be sent at a low rate. Instead, this mechanism should be used for the
* framework to notify a debugging application that an event (such as a bug) has occured
* within the framework if that event should trigger the collection and preservation of other
* more detailed device state for debugging.
*
* At most one application can receive these events and should register a receiver in
* in the application manifest. For performance reasons, if no application to receive these
* events is detected at boot, then these events will not be sent.
*
* Each event will include an {@link EXTRA_ANOMALY_ID} that will uniquely identify the
* event that has occurred. Each event will be sent to the diagnostic monitor only once per
* boot cycle (as another optimization).
*
* @see #EXTRA_ANOMALY_ID
* @see #EXTRA_ANOMALY_DESCRIPTION
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public static final String ACTION_ANOMALY_REPORTED =
"android.telephony.action.ANOMALY_REPORTED";
/**
* An arbitrary ParcelUuid which should be consistent for each occurrence of a DebugEvent.
*
* This field must be included in all {@link ACTION_ANOMALY_REPORTED} events.
*
* @see #ACTION_ANOMALY_REPORTED
* @hide
*/
@SystemApi
public static final String EXTRA_ANOMALY_ID = "android.telephony.extra.ANOMALY_ID";
/**
* A freeform string description of the Anomaly.
*
* This field is optional for all {@link ACTION_ANOMALY_REPORTED}s, as a guideline should not
* exceed 80 characters, and should be as short as possible to convey the essence of the event.
*
* @see #ACTION_ANOMALY_REPORTED
* @hide
*/
@SystemApi
public static final String EXTRA_ANOMALY_DESCRIPTION =
"android.telephony.extra.ANOMALY_DESCRIPTION";
/**
* Broadcast intent sent to indicate primary (non-opportunistic) subscription list has changed.
*
* @hide
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_PRIMARY_SUBSCRIPTION_LIST_CHANGED =
"android.telephony.action.PRIMARY_SUBSCRIPTION_LIST_CHANGED";
/**
* Integer intent extra to be used with {@link #ACTION_PRIMARY_SUBSCRIPTION_LIST_CHANGED}
* to indicate what type of SIM selection is needed.
*
* @hide
*/
public static final String EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE =
"android.telephony.extra.DEFAULT_SUBSCRIPTION_SELECT_TYPE";
/** @hide */
@IntDef({
EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_NONE,
EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_DATA,
EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_VOICE,
EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_SMS,
EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_ALL
})
@Retention(RetentionPolicy.SOURCE)
public @interface DefaultSubscriptionSelectType{}
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate there's no need to re-select any default subscription.
* @hide
*/
public static final int EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_NONE = 0;
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate there's a need to select default data subscription.
* @hide
*/
public static final int EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_DATA = 1;
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate there's a need to select default voice call subscription.
* @hide
*/
public static final int EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_VOICE = 2;
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate there's a need to select default sms subscription.
* @hide
*/
public static final int EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_SMS = 3;
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate user to decide whether current SIM should be preferred for all
* data / voice / sms. {@link #EXTRA_SUBSCRIPTION_ID} will specified to indicate
* which subscription should be the default subscription.
* @hide
*/
public static final int EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_ALL = 4;
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate that default subscription for data/sms/voice is now determined, that
* it should dismiss any dialog or pop-ups that is asking user to select default sub.
* This is used when, for example, opportunistic subscription is configured. At that
* time the primary becomes default sub there's no need to ask user to select anymore.
* @hide
*/
public static final int EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE_DISMISS = 5;
/**
* Integer intent extra to be used with {@link #ACTION_PRIMARY_SUBSCRIPTION_LIST_CHANGED}
* to indicate if the SIM combination in DSDS has limitation or compatible issue.
* e.g. two CDMA SIMs may disrupt each other's voice call in certain scenarios.
*
* @hide
*/
public static final String EXTRA_SIM_COMBINATION_WARNING_TYPE =
"android.telephony.extra.SIM_COMBINATION_WARNING_TYPE";
/** @hide */
@IntDef({
EXTRA_SIM_COMBINATION_WARNING_TYPE_NONE,
EXTRA_SIM_COMBINATION_WARNING_TYPE_DUAL_CDMA
})
@Retention(RetentionPolicy.SOURCE)
public @interface SimCombinationWarningType{}
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate there's no SIM combination warning.
* @hide
*/
public static final int EXTRA_SIM_COMBINATION_WARNING_TYPE_NONE = 0;
/**
* Used as an int value for {@link #EXTRA_DEFAULT_SUBSCRIPTION_SELECT_TYPE}
* to indicate two active SIMs are both CDMA hence there might be functional limitation.
* @hide
*/
public static final int EXTRA_SIM_COMBINATION_WARNING_TYPE_DUAL_CDMA = 1;
/**
* String intent extra to be used with {@link #ACTION_PRIMARY_SUBSCRIPTION_LIST_CHANGED}
* to indicate what's the name of SIM combination it has limitation or compatible issue.
* e.g. two CDMA SIMs may disrupt each other's voice call in certain scenarios, and the
* name will be "operator1 & operator2".
*
* @hide
*/
public static final String EXTRA_SIM_COMBINATION_NAMES =
"android.telephony.extra.SIM_COMBINATION_NAMES";
/**
* Broadcast Action: The emergency callback mode is changed.
*
* You can not receive this through components declared
* in manifests, only by explicitly registering for it with
* {@link android.content.Context#registerReceiver(android.content.BroadcastReceiver,
* android.content.IntentFilter) Context.registerReceiver()}.
*
* This is a protected intent that can only be sent by the system.
*
* @see #EXTRA_PHONE_IN_ECM_STATE
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
@SuppressLint("ActionValue")
public static final String ACTION_EMERGENCY_CALLBACK_MODE_CHANGED =
"android.intent.action.EMERGENCY_CALLBACK_MODE_CHANGED";
/**
* Extra included in {@link #ACTION_EMERGENCY_CALLBACK_MODE_CHANGED}.
* Indicates whether the phone is in an emergency phone state.
*
* @hide
*/
@SystemApi
public static final String EXTRA_PHONE_IN_ECM_STATE =
"android.telephony.extra.PHONE_IN_ECM_STATE";
/**
* Broadcast action sent when a data connection is redirected with validation failure.
*
* This action is intended for sim/account status checks and only sent to the carrier apps
* specified in the carrier config for the subscription ID that's attached to this intent.
*
* The intent will have the following extra values:
* This is a protected intent that can only be sent by the system. This is a protected intent that can only be sent by the system.
* <!-- Service that delivers SMS messages received from the phone "quick response" -->
* <service android:name=".HeadlessSmsSendService"
* android:permission="android.permission.SEND_RESPOND_VIA_MESSAGE"
* android:exported="true" >
* <intent-filter>
* <action android:name="android.intent.action.RESPOND_VIA_MESSAGE" />
* <category android:name="android.intent.category.DEFAULT" />
* <data android:scheme="sms" />
* <data android:scheme="smsto" />
* <data android:scheme="mms" />
* <data android:scheme="mmsto" />
* </intent-filter>
* </service>
*
*
* @hide
*/
public static final String EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION =
"android.telephony.event.EVENT_SUPPLEMENTARY_SERVICE_NOTIFICATION";
/**
* Event reported from the Telephony stack to indicate that the {@link Connection} is not
* able to find any network and likely will not get connected. Upon receiving this event,
* the dialer app should start the app included in the extras bundle of this event if satellite
* is provisioned.
*
*
*
*
* The intent will have the following extra values:
*
*
*
*
*
*
*
* Note that {@link #EXTRA_SHOW_PLMN} may indicate that {@link #EXTRA_PLMN} should be displayed,
* even though the value for {@link #EXTRA_PLMN} is null. This can happen, for example, if the
* phone has not registered to a network yet. In this case the receiver may substitute an
* appropriate placeholder string (eg, "No service").
*
* It is recommended to display {@link #EXTRA_PLMN} before / above {@link #EXTRA_SPN} if
* both are displayed.
*
*
*
*
*
*
*
*
This is a protected intent that can only be sent by the system.
*/ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_CARRIER_SIGNAL_PCO_VALUE = "android.telephony.action.CARRIER_SIGNAL_PCO_VALUE"; /** * Broadcast action sent when the availability of the system default network changes. * * @see ConnectivityManager#registerDefaultNetworkCallback(ConnectivityManager.NetworkCallback) * * This action is intended for carrier apps to set/reset carrier actions. It is only sent to the * carrier apps specified in the carrier config for the subscription ID attached to this intent. * * The intent will have the following extra values: *This is a protected intent that can only be sent by the system.
*/ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_CARRIER_SIGNAL_DEFAULT_NETWORK_AVAILABLE = "android.telephony.action.CARRIER_SIGNAL_DEFAULT_NETWORK_AVAILABLE"; /** * Broadcast action sent when carrier apps should reset their internal state. * * Sent when certain events such as turning on/off mobile data, removing the SIM, etc. require * carrier apps to reset their state. * * This action is intended to signal carrier apps to perform cleanup operations. It is only sent * to the carrier apps specified in the carrier config for the subscription ID attached to * this intent. * * The intent will have the following extra values: *This is a protected intent that can only be sent by the system.
*/ @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) public static final String ACTION_CARRIER_SIGNAL_RESET = "android.telephony.action.CARRIER_SIGNAL_RESET"; /** * String extra containing the redirection URL sent with * {@link #ACTION_CARRIER_SIGNAL_REDIRECTED}. */ public static final String EXTRA_REDIRECTION_URL = "android.telephony.extra.REDIRECTION_URL"; /** * An integer extra containing the data fail cause. * * Sent with {@link #ACTION_CARRIER_SIGNAL_REQUEST_NETWORK_FAILED}. See {@link DataFailCause} * for a list of possible values. */ public static final String EXTRA_DATA_FAIL_CAUSE = "android.telephony.extra.DATA_FAIL_CAUSE"; /** * An integer extra containing the APN type. * * Sent with the {@link #ACTION_CARRIER_SIGNAL_REQUEST_NETWORK_FAILED}, * {@link #ACTION_CARRIER_SIGNAL_REDIRECTED}, and {@link #ACTION_CARRIER_SIGNAL_PCO_VALUE} * broadcasts. * See the {@code TYPE_} constants in {@link ApnSetting} for a list of possible values. */ public static final String EXTRA_APN_TYPE = "android.telephony.extra.APN_TYPE"; /** * An integer extra containing the protocol of the apn connection. * * Sent with the {@link #ACTION_CARRIER_SIGNAL_PCO_VALUE} broadcast. * See the {@code PROTOCOL_*} constants in {@link ApnSetting} for a list of possible values. */ public static final String EXTRA_APN_PROTOCOL = "android.telephony.extra.APN_PROTOCOL"; /** * An integer extra indicating the ID for the PCO data. * Sent with the {@link #ACTION_CARRIER_SIGNAL_PCO_VALUE} broadcast. */ public static final String EXTRA_PCO_ID = "android.telephony.extra.PCO_ID"; /** * A byte array extra containing PCO data read from the modem. * Sent with the {@link #ACTION_CARRIER_SIGNAL_PCO_VALUE} broadcast. */ public static final String EXTRA_PCO_VALUE = "android.telephony.extra.PCO_VALUE"; /** * A boolean extra indicating the availability of the default network. * Sent with the {@link #ACTION_CARRIER_SIGNAL_DEFAULT_NETWORK_AVAILABLE} broadcast. */ public static final String EXTRA_DEFAULT_NETWORK_AVAILABLE = "android.telephony.extra.DEFAULT_NETWORK_AVAILABLE"; /** *Broadcast Action: The emergency call state is changed. *
* You can not receive this through components declared * in manifests, only by explicitly registering for it with * {@link android.content.Context#registerReceiver(android.content.BroadcastReceiver, * android.content.IntentFilter) Context.registerReceiver()}. * *
This is a protected intent that can only be sent by the system. * * @see #EXTRA_PHONE_IN_EMERGENCY_CALL * * @hide */ @SystemApi @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) @SuppressLint("ActionValue") public static final String ACTION_EMERGENCY_CALL_STATE_CHANGED = "android.intent.action.EMERGENCY_CALL_STATE_CHANGED"; /** * Extra included in {@link #ACTION_EMERGENCY_CALL_STATE_CHANGED}. * It indicates whether the phone is making an emergency call. * * @hide */ @SystemApi public static final String EXTRA_PHONE_IN_EMERGENCY_CALL = "android.telephony.extra.PHONE_IN_EMERGENCY_CALL"; /** *
Broadcast Action: It indicates the Emergency callback mode blocks datacall/sms *
. * This is to pop up a notice to show user that the phone is in emergency callback mode * and data calls and outgoing sms are blocked. * *
This is a protected intent that can only be sent by the system. * * @hide */ @SystemApi public static final String ACTION_SHOW_NOTICE_ECM_BLOCK_OTHERS = "android.telephony.action.SHOW_NOTICE_ECM_BLOCK_OTHERS"; /** * Broadcast Action: The default data subscription has changed in a multi-SIM device. * This has the following extra values:
** Open Mobile Alliance (OMA) Device Management (DM). * * This intent is used by the system components to trigger OMA-DM * * @hide */ @SystemApi @SuppressLint("ActionValue") public static final String ACTION_REQUEST_OMADM_CONFIGURATION_UPDATE = "com.android.omadm.service.CONFIGURATION_UPDATE"; /** * Activity action: Show setting to reset mobile networks. * *
On devices with a settings activity to reset mobile networks, the activity should be * launched without additional permissions. * *
On some devices, this settings activity may not exist. Callers should ensure that this * case is appropriately handled. */ @FlaggedApi(Flags.FLAG_RESET_MOBILE_NETWORK_SETTINGS) @SdkConstant(SdkConstant.SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_RESET_MOBILE_NETWORK_SETTINGS = "android.telephony.action.RESET_MOBILE_NETWORK_SETTINGS"; // // // Device Info // // /** * Returns the software version number for the device, for example, * the IMEI/SV for GSM phones. Return null if the software version is * not available. *
* * @throws UnsupportedOperationException If the device does not have * {@link PackageManager#FEATURE_TELEPHONY}. */ @RequiresPermission(anyOf = { android.Manifest.permission.READ_PHONE_STATE, android.Manifest.permission.READ_BASIC_PHONE_STATE}) @RequiresFeature(PackageManager.FEATURE_TELEPHONY) @Nullable public String getDeviceSoftwareVersion() { return getDeviceSoftwareVersion(getSlotIndex()); } /** * Returns the software version number for the device, for example, * the IMEI/SV for GSM phones. Return null if the software version is * not available. *
* Requires Permission: READ_PHONE_STATE. * * @param slotIndex of which deviceID is returned * * @throws UnsupportedOperationException If the device does not have * {@link PackageManager#FEATURE_TELEPHONY}. * @hide */ @SystemApi @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE) @RequiresFeature(PackageManager.FEATURE_TELEPHONY) @Nullable public String getDeviceSoftwareVersion(int slotIndex) { ITelephony telephony = getITelephony(); if (telephony == null) return null; try { return telephony.getDeviceSoftwareVersionForSlot(slotIndex, getOpPackageName(), getAttributionTag()); } catch (RemoteException ex) { return null; } catch (NullPointerException ex) { return null; } } /** * Returns the unique device ID, for example, the IMEI for GSM and the MEID * or ESN for CDMA phones. Return null if device ID is not available. * *
Starting with API level 29, persistent device identifiers are guarded behind additional * restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This * method can be invoked if one of the following requirements is met: *
If the calling app does not meet one of these requirements then this method will behave * as follows: * *
Starting with API level 29, persistent device identifiers are guarded behind additional * restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This * method can be invoked if one of the following requirements is met: *
If the calling app does not meet one of these requirements then this method will behave * as follows: * *
Starting with API level 29, persistent device identifiers are guarded behind additional * restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This * method can be invoked if one of the following requirements is met: *
If the calling app does not meet one of these requirements then this method will behave * as follows: * *
Starting with API level 29, persistent device identifiers are guarded behind additional * restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This * method can be invoked if one of the following requirements is met: *
If the calling app does not meet one of these requirements then this method will behave * as follows: * *
Starting with API level 29, persistent device identifiers are guarded behind additional * restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This * method can be invoked if one of the following requirements is met: *
If the calling app does not meet one of these requirements then this method will behave * as follows: * *
Starting with API level 29, persistent device identifiers are guarded behind additional * restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This * method can be invoked if one of the following requirements is met: *
If the calling app does not meet one of these requirements then this method will behave * as follows: * *
* If there is only one radio in the device and that radio has an LTE connection, * this method will return null. The implementation must not to try add LTE * identifiers into the existing cdma/gsm classes. *
* @return Current location of the device or null if not available.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*
* @deprecated use {@link #getAllCellInfo} instead, which returns a superset of this API.
*/
@Deprecated
@RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public CellLocation getCellLocation() {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
Rlog.d(TAG, "getCellLocation returning null because telephony is null");
return null;
}
CellIdentity cellIdentity = telephony.getCellLocation(mContext.getOpPackageName(),
mContext.getAttributionTag());
CellLocation cl = cellIdentity.asCellLocation();
if (cl == null || cl.isEmpty()) {
Rlog.d(TAG, "getCellLocation returning null because CellLocation is empty or"
+ " phone type doesn't match CellLocation type");
return null;
}
return cl;
} catch (RemoteException ex) {
Rlog.d(TAG, "getCellLocation returning null due to RemoteException " + ex);
return null;
}
}
/**
* Returns the neighboring cell information of the device.
*
* @return List of NeighboringCellInfo or null if info unavailable.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @removed
* @deprecated Use {@link #getAllCellInfo} which returns a superset of the information
* from NeighboringCellInfo, including LTE cell information.
*/
@Deprecated
@RequiresPermission(android.Manifest.permission.ACCESS_COARSE_LOCATION)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public List
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public String getNetworkOperatorName() {
return getNetworkOperatorName(getSubId());
}
/**
* Returns the alphabetic name of current registered operator
* for a particular subscription.
*
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
* @param subId
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getNetworkOperatorName(int subId) {
int phoneId = SubscriptionManager.getPhoneId(subId);
return getTelephonyProperty(phoneId, TelephonyProperties.operator_alpha(), "");
}
/**
* Returns the numeric name (MCC+MNC) of current registered operator.
*
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public String getNetworkOperator() {
return getNetworkOperatorForPhone(getPhoneId());
}
/**
* Returns the numeric name (MCC+MNC) of current registered operator
* for a particular subscription.
*
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*
* @param subId
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getNetworkOperator(int subId) {
int phoneId = SubscriptionManager.getPhoneId(subId);
return getNetworkOperatorForPhone(phoneId);
}
/**
* Returns the numeric name (MCC+MNC) of current registered operator
* for a particular subscription.
*
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*
* @param phoneId
* @hide
**/
@UnsupportedAppUsage
public String getNetworkOperatorForPhone(int phoneId) {
return getTelephonyProperty(phoneId, TelephonyProperties.operator_numeric(), "");
}
/**
* Returns the network specifier of the subscription ID pinned to the TelephonyManager. The
* network specifier is used by {@link
* android.net.NetworkRequest.Builder#setNetworkSpecifier(String)} to create a {@link
* android.net.NetworkRequest} that connects through the subscription.
*
* @see android.net.NetworkRequest.Builder#setNetworkSpecifier(String)
* @see #createForSubscriptionId(int)
* @see #createForPhoneAccountHandle(PhoneAccountHandle)
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public String getNetworkSpecifier() {
return String.valueOf(getSubId());
}
/**
* Returns the carrier config of the subscription ID pinned to the TelephonyManager. If an
* invalid subscription ID is pinned to the TelephonyManager, the returned config will contain
* default values.
*
* This method may take several seconds to complete, so it should only be called from a
* worker thread.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @see CarrierConfigManager#getConfigForSubId(int)
* @see #createForSubscriptionId(int)
* @see #createForPhoneAccountHandle(PhoneAccountHandle)
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@WorkerThread
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public PersistableBundle getCarrierConfig() {
CarrierConfigManager carrierConfigManager = mContext
.getSystemService(CarrierConfigManager.class);
return carrierConfigManager.getConfigForSubId(getSubId());
}
/**
* Returns true if the device is considered roaming on the current
* network, for GSM purposes.
*
* Availability: Only when user registered to a network.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean isNetworkRoaming() {
return isNetworkRoaming(getSubId());
}
/**
* Returns true if the device is considered roaming on the current
* network for a subscription.
*
* Availability: Only when user registered to a network.
*
* @param subId
* @hide
*/
@UnsupportedAppUsage
public boolean isNetworkRoaming(int subId) {
int phoneId = SubscriptionManager.getPhoneId(subId);
return getTelephonyProperty(phoneId, TelephonyProperties.operator_is_roaming(), false);
}
/**
* Returns the ISO-3166-1 alpha-2 country code equivalent of the MCC (Mobile Country Code) of
* the current registered operator or the cell nearby, if available.
*
* Note: Result may be unreliable on CDMA networks (use {@link #getPhoneType()} to determine
* if on a CDMA network).
*
* @return the lowercase 2 character ISO-3166-1 alpha-2 country code, or empty string if not
* available.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public String getNetworkCountryIso() {
return getNetworkCountryIso(getSlotIndex());
}
/**
* Returns the ISO-3166-1 alpha-2 country code equivalent of the MCC (Mobile Country Code) of
* the current registered operator or the cell nearby, if available. This is same as
* {@link #getNetworkCountryIso()} but allowing specifying the SIM slot index. This is used for
* accessing network country info from the SIM slot that does not have SIM inserted.
*
* Note: Result may be unreliable on CDMA networks (use {@link #getPhoneType()} to determine
* if on a CDMA network).
*
*
* @param slotIndex the SIM slot index to get network country ISO.
*
* @return the lowercase 2 character ISO-3166-1 alpha-2 country code, or empty string if not
* available.
*
* @throws IllegalArgumentException when the slotIndex is invalid.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
@NonNull
public String getNetworkCountryIso(int slotIndex) {
try {
if (slotIndex != SubscriptionManager.DEFAULT_SIM_SLOT_INDEX
&& !SubscriptionManager.isValidSlotIndex(slotIndex)) {
throw new IllegalArgumentException("invalid slot index " + slotIndex);
}
ITelephony telephony = getITelephony();
if (telephony == null) return "";
return telephony.getNetworkCountryIsoForPhone(slotIndex);
} catch (RemoteException ex) {
return "";
}
}
/**
* @hide
* @deprecated Use {@link #getNetworkCountryIso(int)} instead.
*/
@Deprecated
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.Q,
publicAlternatives = "Use {@link #getNetworkCountryIso(int)} instead.")
public String getNetworkCountryIsoForPhone(int phoneId) {
return getNetworkCountryIso(phoneId);
}
/*
* When adding a network type to the list below, make sure to add the correct icon to
* MobileSignalController.mapIconSets() as well as NETWORK_TYPES
* Do not add negative types.
*/
/** Network type is unknown */
public static final int NETWORK_TYPE_UNKNOWN = TelephonyProtoEnums.NETWORK_TYPE_UNKNOWN; // = 0.
/** Current network is GPRS */
public static final int NETWORK_TYPE_GPRS = TelephonyProtoEnums.NETWORK_TYPE_GPRS; // = 1.
/** Current network is EDGE */
public static final int NETWORK_TYPE_EDGE = TelephonyProtoEnums.NETWORK_TYPE_EDGE; // = 2.
/** Current network is UMTS */
public static final int NETWORK_TYPE_UMTS = TelephonyProtoEnums.NETWORK_TYPE_UMTS; // = 3.
/** Current network is CDMA: Either IS95A or IS95B*/
public static final int NETWORK_TYPE_CDMA = TelephonyProtoEnums.NETWORK_TYPE_CDMA; // = 4.
/** Current network is EVDO revision 0*/
public static final int NETWORK_TYPE_EVDO_0 = TelephonyProtoEnums.NETWORK_TYPE_EVDO_0; // = 5.
/** Current network is EVDO revision A*/
public static final int NETWORK_TYPE_EVDO_A = TelephonyProtoEnums.NETWORK_TYPE_EVDO_A; // = 6.
/** Current network is 1xRTT*/
public static final int NETWORK_TYPE_1xRTT = TelephonyProtoEnums.NETWORK_TYPE_1XRTT; // = 7.
/** Current network is HSDPA */
public static final int NETWORK_TYPE_HSDPA = TelephonyProtoEnums.NETWORK_TYPE_HSDPA; // = 8.
/** Current network is HSUPA */
public static final int NETWORK_TYPE_HSUPA = TelephonyProtoEnums.NETWORK_TYPE_HSUPA; // = 9.
/** Current network is HSPA */
public static final int NETWORK_TYPE_HSPA = TelephonyProtoEnums.NETWORK_TYPE_HSPA; // = 10.
/**
* Current network is iDen
* @deprecated Legacy network type no longer being used starting in Android U.
*/
@Deprecated
public static final int NETWORK_TYPE_IDEN = TelephonyProtoEnums.NETWORK_TYPE_IDEN; // = 11.
/** Current network is EVDO revision B*/
public static final int NETWORK_TYPE_EVDO_B = TelephonyProtoEnums.NETWORK_TYPE_EVDO_B; // = 12.
/** Current network is LTE */
public static final int NETWORK_TYPE_LTE = TelephonyProtoEnums.NETWORK_TYPE_LTE; // = 13.
/** Current network is eHRPD */
public static final int NETWORK_TYPE_EHRPD = TelephonyProtoEnums.NETWORK_TYPE_EHRPD; // = 14.
/** Current network is HSPA+ */
public static final int NETWORK_TYPE_HSPAP = TelephonyProtoEnums.NETWORK_TYPE_HSPAP; // = 15.
/** Current network is GSM */
public static final int NETWORK_TYPE_GSM = TelephonyProtoEnums.NETWORK_TYPE_GSM; // = 16.
/** Current network is TD_SCDMA */
public static final int NETWORK_TYPE_TD_SCDMA =
TelephonyProtoEnums.NETWORK_TYPE_TD_SCDMA; // = 17.
/** Current network is IWLAN */
public static final int NETWORK_TYPE_IWLAN = TelephonyProtoEnums.NETWORK_TYPE_IWLAN; // = 18.
/** Current network is LTE_CA {@hide} */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static final int NETWORK_TYPE_LTE_CA = TelephonyProtoEnums.NETWORK_TYPE_LTE_CA; // = 19.
/**
* Current network is NR (New Radio) 5G.
* This will only be returned for 5G SA.
* For 5G NSA, the network type will be {@link #NETWORK_TYPE_LTE}.
*/
public static final int NETWORK_TYPE_NR = TelephonyProtoEnums.NETWORK_TYPE_NR; // 20.
private static final @NetworkType int[] NETWORK_TYPES = {
NETWORK_TYPE_GPRS,
NETWORK_TYPE_EDGE,
NETWORK_TYPE_UMTS,
NETWORK_TYPE_CDMA,
NETWORK_TYPE_EVDO_0,
NETWORK_TYPE_EVDO_A,
NETWORK_TYPE_1xRTT,
NETWORK_TYPE_HSDPA,
NETWORK_TYPE_HSUPA,
NETWORK_TYPE_HSPA,
NETWORK_TYPE_IDEN,
NETWORK_TYPE_EVDO_B,
NETWORK_TYPE_LTE,
NETWORK_TYPE_EHRPD,
NETWORK_TYPE_HSPAP,
NETWORK_TYPE_GSM,
NETWORK_TYPE_TD_SCDMA,
NETWORK_TYPE_IWLAN,
NETWORK_TYPE_LTE_CA,
NETWORK_TYPE_NR
};
/**
* Returns an array of all valid network types.
*
* @return An integer array containing all valid network types in no particular order.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static @NonNull @NetworkType int[] getAllNetworkTypes() {
return NETWORK_TYPES.clone();
}
/**
* Return the current data network type.
*
* @deprecated use {@link #getDataNetworkType()}
* @return the NETWORK_TYPE_xxxx for current data connection.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@Deprecated
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NetworkType int getNetworkType() {
return getNetworkType(getSubId(SubscriptionManager.getActiveDataSubscriptionId()));
}
/**
* Returns a constant indicating the radio technology (network type)
* currently in use on the device for a subscription.
* @return the network type
*
* @param subId for which network type is returned
*
* @see #NETWORK_TYPE_UNKNOWN
* @see #NETWORK_TYPE_GPRS
* @see #NETWORK_TYPE_EDGE
* @see #NETWORK_TYPE_UMTS
* @see #NETWORK_TYPE_HSDPA
* @see #NETWORK_TYPE_HSUPA
* @see #NETWORK_TYPE_HSPA
* @see #NETWORK_TYPE_CDMA
* @see #NETWORK_TYPE_EVDO_0
* @see #NETWORK_TYPE_EVDO_A
* @see #NETWORK_TYPE_EVDO_B
* @see #NETWORK_TYPE_1xRTT
* @see #NETWORK_TYPE_IDEN
* @see #NETWORK_TYPE_LTE
* @see #NETWORK_TYPE_EHRPD
* @see #NETWORK_TYPE_HSPAP
* @see #NETWORK_TYPE_NR
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public int getNetworkType(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getNetworkTypeForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} else {
// This can happen when the ITelephony interface is not up yet.
return NETWORK_TYPE_UNKNOWN;
}
} catch (RemoteException ex) {
// This shouldn't happen in the normal case
return NETWORK_TYPE_UNKNOWN;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return NETWORK_TYPE_UNKNOWN;
}
}
/**
* Returns a constant indicating the radio technology (network type)
* currently in use on the device for data transmission.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the given
* subId. Otherwise, applies to {@link SubscriptionManager#getActiveDataSubscriptionId()}.
*
* Note: Before {@link SubscriptionManager#getActiveDataSubscriptionId()} was introduced in API
* level 30, it was applied to {@link SubscriptionManager#getDefaultDataSubscriptionId()} which
* may be different now from {@link SubscriptionManager#getActiveDataSubscriptionId()}, e.g.
* when opportunistic network is providing cellular internet connection to the user.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or {@link android.Manifest.permission#READ_BASIC_PHONE_STATE
* READ_BASIC_PHONE_STATE} or that the calling app has carrier privileges
* (see {@link #hasCarrierPrivileges}).
*
* @return the network type
*
* @see #NETWORK_TYPE_UNKNOWN
* @see #NETWORK_TYPE_GPRS
* @see #NETWORK_TYPE_EDGE
* @see #NETWORK_TYPE_UMTS
* @see #NETWORK_TYPE_HSDPA
* @see #NETWORK_TYPE_HSUPA
* @see #NETWORK_TYPE_HSPA
* @see #NETWORK_TYPE_CDMA
* @see #NETWORK_TYPE_EVDO_0
* @see #NETWORK_TYPE_EVDO_A
* @see #NETWORK_TYPE_EVDO_B
* @see #NETWORK_TYPE_1xRTT
* @see #NETWORK_TYPE_IDEN
* @see #NETWORK_TYPE_LTE
* @see #NETWORK_TYPE_EHRPD
* @see #NETWORK_TYPE_HSPAP
* @see #NETWORK_TYPE_NR
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_BASIC_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NetworkType int getDataNetworkType() {
return getDataNetworkType(getSubId(SubscriptionManager.getActiveDataSubscriptionId()));
}
/**
* Returns a constant indicating the radio technology (network type)
* currently in use on the device for data transmission for a subscription
* @return the network type
*
* @param subId for which network type is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public int getDataNetworkType(int subId) {
try{
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getDataNetworkTypeForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} else {
// This can happen when the ITelephony interface is not up yet.
return NETWORK_TYPE_UNKNOWN;
}
} catch(RemoteException ex) {
// This shouldn't happen in the normal case
return NETWORK_TYPE_UNKNOWN;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return NETWORK_TYPE_UNKNOWN;
}
}
/**
* Returns the NETWORK_TYPE_xxxx for voice
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or {@link android.Manifest.permission#READ_BASIC_PHONE_STATE
* READ_BASIC_PHONE_STATE} or that the calling app has carrier privileges
* (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_BASIC_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public @NetworkType int getVoiceNetworkType() {
return getVoiceNetworkType(getSubId());
}
/**
* Returns the NETWORK_TYPE_xxxx for voice for a subId
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public int getVoiceNetworkType(int subId) {
try{
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getVoiceNetworkTypeForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} else {
// This can happen when the ITelephony interface is not up yet.
return NETWORK_TYPE_UNKNOWN;
}
} catch(RemoteException ex) {
// This shouldn't happen in the normal case
return NETWORK_TYPE_UNKNOWN;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return NETWORK_TYPE_UNKNOWN;
}
}
/**
* Returns a string representation of the radio technology (network type)
* currently in use on the device.
* @return the name of the radio technology
*
* @hide pending API council review
*/
@UnsupportedAppUsage
public String getNetworkTypeName() {
return getNetworkTypeName(getNetworkType());
}
/**
* Returns a string representation of the radio technology (network type)
* currently in use on the device.
* @param subId for which network type is returned
* @return the name of the radio technology
*
*/
/** {@hide} */
@UnsupportedAppUsage
public static String getNetworkTypeName(@NetworkType int type) {
switch (type) {
case NETWORK_TYPE_GPRS:
return "GPRS";
case NETWORK_TYPE_EDGE:
return "EDGE";
case NETWORK_TYPE_UMTS:
return "UMTS";
case NETWORK_TYPE_HSDPA:
return "HSDPA";
case NETWORK_TYPE_HSUPA:
return "HSUPA";
case NETWORK_TYPE_HSPA:
return "HSPA";
case NETWORK_TYPE_CDMA:
return "CDMA";
case NETWORK_TYPE_EVDO_0:
return "CDMA - EvDo rev. 0";
case NETWORK_TYPE_EVDO_A:
return "CDMA - EvDo rev. A";
case NETWORK_TYPE_EVDO_B:
return "CDMA - EvDo rev. B";
case NETWORK_TYPE_1xRTT:
return "CDMA - 1xRTT";
case NETWORK_TYPE_LTE:
return "LTE";
case NETWORK_TYPE_EHRPD:
return "CDMA - eHRPD";
case NETWORK_TYPE_IDEN:
return "iDEN";
case NETWORK_TYPE_HSPAP:
return "HSPA+";
case NETWORK_TYPE_GSM:
return "GSM";
case NETWORK_TYPE_TD_SCDMA:
return "TD_SCDMA";
case NETWORK_TYPE_IWLAN:
return "IWLAN";
case NETWORK_TYPE_LTE_CA:
return "LTE_CA";
case NETWORK_TYPE_NR:
return "NR";
case NETWORK_TYPE_UNKNOWN:
return "UNKNOWN";
default:
return "UNKNOWN(" + type + ")";
}
}
/**
* Returns the bitmask for a given technology (network type)
* @param networkType for which bitmask is returned
* @return the network type bitmask
* {@hide}
*/
public static @NetworkTypeBitMask long getBitMaskForNetworkType(@NetworkType int networkType) {
switch(networkType) {
case NETWORK_TYPE_GSM:
return NETWORK_TYPE_BITMASK_GSM;
case NETWORK_TYPE_GPRS:
return NETWORK_TYPE_BITMASK_GPRS;
case NETWORK_TYPE_EDGE:
return NETWORK_TYPE_BITMASK_EDGE;
case NETWORK_TYPE_CDMA:
return NETWORK_TYPE_BITMASK_CDMA;
case NETWORK_TYPE_1xRTT:
return NETWORK_TYPE_BITMASK_1xRTT;
case NETWORK_TYPE_EVDO_0:
return NETWORK_TYPE_BITMASK_EVDO_0;
case NETWORK_TYPE_EVDO_A:
return NETWORK_TYPE_BITMASK_EVDO_A;
case NETWORK_TYPE_EVDO_B:
return NETWORK_TYPE_BITMASK_EVDO_B;
case NETWORK_TYPE_EHRPD:
return NETWORK_TYPE_BITMASK_EHRPD;
case NETWORK_TYPE_HSUPA:
return NETWORK_TYPE_BITMASK_HSUPA;
case NETWORK_TYPE_HSDPA:
return NETWORK_TYPE_BITMASK_HSDPA;
case NETWORK_TYPE_HSPA:
return NETWORK_TYPE_BITMASK_HSPA;
case NETWORK_TYPE_HSPAP:
return NETWORK_TYPE_BITMASK_HSPAP;
case NETWORK_TYPE_UMTS:
return NETWORK_TYPE_BITMASK_UMTS;
case NETWORK_TYPE_TD_SCDMA:
return NETWORK_TYPE_BITMASK_TD_SCDMA;
case NETWORK_TYPE_LTE:
case NETWORK_TYPE_LTE_CA:
return NETWORK_TYPE_BITMASK_LTE;
case NETWORK_TYPE_NR:
return NETWORK_TYPE_BITMASK_NR;
case NETWORK_TYPE_IWLAN:
return NETWORK_TYPE_BITMASK_IWLAN;
case NETWORK_TYPE_IDEN:
return NETWORK_TYPE_BITMASK_IDEN;
default:
return NETWORK_TYPE_BITMASK_UNKNOWN;
}
}
//
//
// SIM Card
//
//
/** @hide */
@IntDef(prefix = {"SIM_STATE_"},
value = {
SIM_STATE_UNKNOWN,
SIM_STATE_ABSENT,
SIM_STATE_PIN_REQUIRED,
SIM_STATE_PUK_REQUIRED,
SIM_STATE_NETWORK_LOCKED,
SIM_STATE_READY,
SIM_STATE_NOT_READY,
SIM_STATE_PERM_DISABLED,
SIM_STATE_CARD_IO_ERROR,
SIM_STATE_CARD_RESTRICTED,
SIM_STATE_LOADED,
SIM_STATE_PRESENT,
})
@Retention(RetentionPolicy.SOURCE)
public @interface SimState {}
/**
* SIM card state: Unknown. Signifies that the SIM is in transition
* between states. For example, when the user inputs the SIM pin
* under PIN_REQUIRED state, a query for sim status returns
* this state before turning to SIM_STATE_READY.
*
* These are the ordinal value of IccCardConstants.State.
*/
public static final int SIM_STATE_UNKNOWN = TelephonyProtoEnums.SIM_STATE_UNKNOWN; // 0
/** SIM card state: no SIM card is available in the device */
public static final int SIM_STATE_ABSENT = TelephonyProtoEnums.SIM_STATE_ABSENT; // 1
/** SIM card state: Locked: requires the user's SIM PIN to unlock */
public static final int SIM_STATE_PIN_REQUIRED =
TelephonyProtoEnums.SIM_STATE_PIN_REQUIRED; // 2
/** SIM card state: Locked: requires the user's SIM PUK to unlock */
public static final int SIM_STATE_PUK_REQUIRED =
TelephonyProtoEnums.SIM_STATE_PUK_REQUIRED; // 3
/** SIM card state: Locked: requires a network PIN to unlock */
public static final int SIM_STATE_NETWORK_LOCKED =
TelephonyProtoEnums.SIM_STATE_NETWORK_LOCKED; // 4
/** SIM card state: Ready */
public static final int SIM_STATE_READY = TelephonyProtoEnums.SIM_STATE_READY; // 5
/** SIM card state: SIM Card is NOT READY */
public static final int SIM_STATE_NOT_READY = TelephonyProtoEnums.SIM_STATE_NOT_READY; // 6
/** SIM card state: SIM Card Error, permanently disabled */
public static final int SIM_STATE_PERM_DISABLED =
TelephonyProtoEnums.SIM_STATE_PERM_DISABLED; // 7
/** SIM card state: SIM Card Error, present but faulty */
public static final int SIM_STATE_CARD_IO_ERROR =
TelephonyProtoEnums.SIM_STATE_CARD_IO_ERROR; // 8
/** SIM card state: SIM Card restricted, present but not usable due to
* carrier restrictions.
*/
public static final int SIM_STATE_CARD_RESTRICTED =
TelephonyProtoEnums.SIM_STATE_CARD_RESTRICTED; // 9
/**
* SIM card state: Loaded: SIM card applications have been loaded
* @hide
*/
@SystemApi
public static final int SIM_STATE_LOADED = TelephonyProtoEnums.SIM_STATE_LOADED; // 10
/**
* SIM card state: SIM Card is present
* @hide
*/
@SystemApi
public static final int SIM_STATE_PRESENT = TelephonyProtoEnums.SIM_STATE_PRESENT; // 11
/**
* Extra included in {@link #ACTION_SIM_CARD_STATE_CHANGED} and
* {@link #ACTION_SIM_APPLICATION_STATE_CHANGED} to indicate the card/application state.
*
* @hide
*/
@SystemApi
public static final String EXTRA_SIM_STATE = "android.telephony.extra.SIM_STATE";
/**
* Broadcast Action: The sim card state has changed.
* The intent will have the following extra values: Requires the READ_PRIVILEGED_PHONE_STATE permission.
*
* The current state can also be queried using {@link #getSimCardState()}.
*
* This is a protected intent that can only be sent by the system.
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SIM_CARD_STATE_CHANGED =
"android.telephony.action.SIM_CARD_STATE_CHANGED";
/**
* Broadcast Action: The sim application state has changed.
* The intent will have the following extra values: Requires the READ_PRIVILEGED_PHONE_STATE permission.
*
* The current state can also be queried using
* {@link #getSimApplicationState()}.
*
* This is a protected intent that can only be sent by the system.
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SIM_APPLICATION_STATE_CHANGED =
"android.telephony.action.SIM_APPLICATION_STATE_CHANGED";
/**
* Broadcast Action: Status of the SIM slots on the device has changed.
*
* Requires the READ_PRIVILEGED_PHONE_STATE permission.
*
* The status can be queried using
* {@link #getUiccSlotsInfo()}
*
* This is a protected intent that can only be sent by the system.
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SIM_SLOT_STATUS_CHANGED =
"android.telephony.action.SIM_SLOT_STATUS_CHANGED";
/**
* Broadcast Action: A debug code has been entered in the dialer.
*
* This intent is broadcast by the system and OEM telephony apps may need to receive these
* broadcasts. And it requires the sender to be default dialer or has carrier privileges
* (see {@link #hasCarrierPrivileges}).
*
* These "secret codes" are used to activate developer menus by dialing certain codes.
* And they are of the form {@code *#*#
* It is supposed to replace {@link android.provider.Telephony.Sms.Intents#SECRET_CODE_ACTION}
* in the next Android version.
* Before that both of these two actions will be broadcast.
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SECRET_CODE = "android.telephony.action.SECRET_CODE";
/**
* This API is used to check if there is an ICC card present in the device.
*
* An ICC card is a smart card that contains a subscriber identity module (SIM) and is used
* to identify and authenticate users to a mobile network.
*
* Note: In case of embedded SIM there is an ICC card always present irrespective
* of whether an active SIM profile is present or not so this API would always return true.
*
* @return true if a ICC card is present.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean hasIccCard() {
return hasIccCard(getSlotIndex());
}
/**
* @return true if a ICC card is present for a subscription
*
* @param slotIndex for which icc card presence is checked
*/
/** {@hide} */
// FIXME Input argument slotIndex should be of type int
@UnsupportedAppUsage
public boolean hasIccCard(int slotIndex) {
try {
ITelephony telephony = getITelephony();
if (telephony == null)
return false;
return telephony.hasIccCardUsingSlotIndex(slotIndex);
} catch (RemoteException ex) {
// Assume no ICC card if remote exception which shouldn't happen
return false;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return false;
}
}
/**
* Returns a constant indicating the state of the default SIM card.
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_ABSENT
* @see #SIM_STATE_PIN_REQUIRED
* @see #SIM_STATE_PUK_REQUIRED
* @see #SIM_STATE_NETWORK_LOCKED
* @see #SIM_STATE_READY
* @see #SIM_STATE_NOT_READY
* @see #SIM_STATE_PERM_DISABLED
* @see #SIM_STATE_CARD_IO_ERROR
* @see #SIM_STATE_CARD_RESTRICTED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @SimState int getSimState() {
int simState = getSimStateIncludingLoaded();
if (simState == SIM_STATE_LOADED) {
simState = SIM_STATE_READY;
}
return simState;
}
private @SimState int getSimStateIncludingLoaded() {
int slotIndex = getSlotIndex();
// slotIndex may be invalid due to sim being absent. In that case query all slots to get
// sim state
if (slotIndex < 0) {
// query for all slots and return absent if all sim states are absent, otherwise
// return unknown
for (int i = 0; i < getPhoneCount(); i++) {
int simState = getSimState(i);
if (simState != SIM_STATE_ABSENT) {
Rlog.d(TAG, "getSimState: default sim:" + slotIndex + ", sim state for " +
"slotIndex=" + i + " is " + simState + ", return state as unknown");
return SIM_STATE_UNKNOWN;
}
}
Rlog.d(TAG, "getSimState: default sim:" + slotIndex + ", all SIMs absent, return " +
"state as absent");
return SIM_STATE_ABSENT;
}
return getSimStateForSlotIndex(slotIndex);
}
/**
* Returns a constant indicating the state of the default SIM card.
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_ABSENT
* @see #SIM_STATE_CARD_IO_ERROR
* @see #SIM_STATE_CARD_RESTRICTED
* @see #SIM_STATE_PRESENT
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @SimState int getSimCardState() {
int simState = getSimState();
return getSimCardStateFromSimState(simState);
}
/**
* Returns a constant indicating the state of the device SIM card in a physical slot.
*
* @param physicalSlotIndex physical slot index
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_ABSENT
* @see #SIM_STATE_CARD_IO_ERROR
* @see #SIM_STATE_CARD_RESTRICTED
* @see #SIM_STATE_PRESENT
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated instead use {@link #getSimCardState(int, int)}
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@Deprecated
public @SimState int getSimCardState(int physicalSlotIndex) {
int activePort = getFirstActivePortIndex(physicalSlotIndex);
int simState = getSimState(getLogicalSlotIndex(physicalSlotIndex, activePort));
return getSimCardStateFromSimState(simState);
}
/**
* Returns a constant indicating the state of the device SIM card in a physical slot and
* port index.
*
* @param physicalSlotIndex physical slot index
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_ABSENT
* @see #SIM_STATE_CARD_IO_ERROR
* @see #SIM_STATE_CARD_RESTRICTED
* @see #SIM_STATE_PRESENT
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @SimState int getSimCardState(int physicalSlotIndex, int portIndex) {
int simState = getSimState(getLogicalSlotIndex(physicalSlotIndex, portIndex));
return getSimCardStateFromSimState(simState);
}
/**
* Converts SIM state to SIM card state.
* @param simState
* @return SIM card state
*/
private @SimState int getSimCardStateFromSimState(int simState) {
switch (simState) {
case SIM_STATE_UNKNOWN:
case SIM_STATE_ABSENT:
case SIM_STATE_CARD_IO_ERROR:
case SIM_STATE_CARD_RESTRICTED:
return simState;
default:
return SIM_STATE_PRESENT;
}
}
/**
* Converts a physical slot index to logical slot index.
* @param physicalSlotIndex physical slot index
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
* @return logical slot index
*/
private int getLogicalSlotIndex(int physicalSlotIndex, int portIndex) {
UiccSlotInfo[] slotInfos = getUiccSlotsInfo();
if (slotInfos != null && physicalSlotIndex >= 0 && physicalSlotIndex < slotInfos.length
&& slotInfos[physicalSlotIndex] != null) {
for (UiccPortInfo portInfo : slotInfos[physicalSlotIndex].getPorts()) {
if (portInfo.getPortIndex() == portIndex) {
return portInfo.getLogicalSlotIndex();
}
}
}
return SubscriptionManager.INVALID_SIM_SLOT_INDEX;
}
/**
* Returns a constant indicating the state of the card applications on the default SIM card.
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_PIN_REQUIRED
* @see #SIM_STATE_PUK_REQUIRED
* @see #SIM_STATE_NETWORK_LOCKED
* @see #SIM_STATE_NOT_READY
* @see #SIM_STATE_PERM_DISABLED
* @see #SIM_STATE_LOADED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @SimState int getSimApplicationState() {
int simState = getSimStateIncludingLoaded();
return getSimApplicationStateFromSimState(simState);
}
/**
* Returns a constant indicating the state of the card applications on the device SIM card in
* a physical slot.
*
* @param physicalSlotIndex physical slot index
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_PIN_REQUIRED
* @see #SIM_STATE_PUK_REQUIRED
* @see #SIM_STATE_NETWORK_LOCKED
* @see #SIM_STATE_NOT_READY
* @see #SIM_STATE_PERM_DISABLED
* @see #SIM_STATE_LOADED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated instead use {@link #getSimApplicationState(int, int)}
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@Deprecated
public @SimState int getSimApplicationState(int physicalSlotIndex) {
int activePort = getFirstActivePortIndex(physicalSlotIndex);
int simState = getSimStateForSlotIndex(getLogicalSlotIndex(physicalSlotIndex, activePort));
return getSimApplicationStateFromSimState(simState);
}
/**
* Returns a constant indicating the state of the card applications on the device SIM card in
* a physical slot.
*
* @param physicalSlotIndex physical slot index
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_PIN_REQUIRED
* @see #SIM_STATE_PUK_REQUIRED
* @see #SIM_STATE_NETWORK_LOCKED
* @see #SIM_STATE_NOT_READY
* @see #SIM_STATE_PERM_DISABLED
* @see #SIM_STATE_LOADED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @SimState int getSimApplicationState(int physicalSlotIndex, int portIndex) {
int simState = getSimStateForSlotIndex(getLogicalSlotIndex(physicalSlotIndex, portIndex));
return getSimApplicationStateFromSimState(simState);
}
/**
* Converts SIM state to SIM application state.
* @param simState
* @return SIM application state
*/
private @SimState int getSimApplicationStateFromSimState(int simState) {
switch (simState) {
case SIM_STATE_UNKNOWN:
case SIM_STATE_ABSENT:
case SIM_STATE_CARD_IO_ERROR:
case SIM_STATE_CARD_RESTRICTED:
return SIM_STATE_UNKNOWN;
case SIM_STATE_READY:
// Ready is not a valid state anymore. The state that is broadcast goes from
// NOT_READY to either LOCKED or LOADED.
return SIM_STATE_NOT_READY;
default:
return simState;
}
}
/**
* Returns true if the specified type of application (e.g. {@link #APPTYPE_CSIM} is present
* on the UICC card.
*
* Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission
*
* @param appType the uicc app type like {@link APPTYPE_CSIM}
* @return true if the specified type of application in UICC CARD or false if no uicc or error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean isApplicationOnUicc(@UiccAppType int appType) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.isApplicationOnUicc(getSubId(), appType);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isApplicationOnUicc", e);
}
return false;
}
/**
* Returns a constant indicating the state of the device SIM card in a logical slot.
*
* @param slotIndex logical slot index
*
* @see #SIM_STATE_UNKNOWN
* @see #SIM_STATE_ABSENT
* @see #SIM_STATE_PIN_REQUIRED
* @see #SIM_STATE_PUK_REQUIRED
* @see #SIM_STATE_NETWORK_LOCKED
* @see #SIM_STATE_READY
* @see #SIM_STATE_NOT_READY
* @see #SIM_STATE_PERM_DISABLED
* @see #SIM_STATE_CARD_IO_ERROR
* @see #SIM_STATE_CARD_RESTRICTED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @SimState int getSimState(int slotIndex) {
int simState = getSimStateForSlotIndex(slotIndex);
if (simState == SIM_STATE_LOADED) {
simState = SIM_STATE_READY;
}
return simState;
}
/**
* Returns the MCC+MNC (mobile country code + mobile network code) of the
* provider of the SIM. 5 or 6 decimal digits.
*
* Availability: SIM state must be {@link #SIM_STATE_READY}
*
* @see #getSimState
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getSimOperator() {
return getSimOperatorNumeric();
}
/**
* Returns the MCC+MNC (mobile country code + mobile network code) of the
* provider of the SIM. 5 or 6 decimal digits.
*
* Availability: SIM state must be {@link #SIM_STATE_READY}
*
* @see #getSimState
*
* @param subId for which SimOperator is returned
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getSimOperator(int subId) {
return getSimOperatorNumeric(subId);
}
/**
* Returns the MCC+MNC (mobile country code + mobile network code) of the
* provider of the SIM. 5 or 6 decimal digits.
*
* Availability: SIM state must be {@link #SIM_STATE_READY}
*
* @see #getSimState
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getSimOperatorNumeric() {
int subId = mSubId;
if (!SubscriptionManager.isUsableSubIdValue(subId)) {
subId = SubscriptionManager.getDefaultDataSubscriptionId();
if (!SubscriptionManager.isUsableSubIdValue(subId)) {
subId = SubscriptionManager.getDefaultSmsSubscriptionId();
if (!SubscriptionManager.isUsableSubIdValue(subId)) {
subId = SubscriptionManager.getDefaultVoiceSubscriptionId();
if (!SubscriptionManager.isUsableSubIdValue(subId)) {
subId = SubscriptionManager.getDefaultSubscriptionId();
}
}
}
}
return getSimOperatorNumeric(subId);
}
/**
* Returns the MCC+MNC (mobile country code + mobile network code) of the
* provider of the SIM for a particular subscription. 5 or 6 decimal digits.
*
* Availability: SIM state must be {@link #SIM_STATE_READY}
*
* @see #getSimState
*
* @param subId for which SimOperator is returned
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getSimOperatorNumeric(int subId) {
int phoneId = SubscriptionManager.getPhoneId(subId);
return getSimOperatorNumericForPhone(phoneId);
}
/**
* Returns the MCC+MNC (mobile country code + mobile network code) of the
* provider of the SIM for a particular subscription. 5 or 6 decimal digits.
*
*
* @param phoneId for which SimOperator is returned
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getSimOperatorNumericForPhone(int phoneId) {
return getTelephonyProperty(phoneId, TelephonyProperties.icc_operator_numeric(), "");
}
/**
* Returns the Service Provider Name (SPN).
*
* Availability: SIM state must be {@link #SIM_STATE_READY}
*
* @see #getSimState
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getSimOperatorName() {
return getSimOperatorNameForPhone(getPhoneId());
}
/**
* Returns the Service Provider Name (SPN).
*
* Availability: SIM state must be {@link #SIM_STATE_READY}
*
* @see #getSimState
*
* @param subId for which SimOperatorName is returned
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getSimOperatorName(int subId) {
int phoneId = SubscriptionManager.getPhoneId(subId);
return getSimOperatorNameForPhone(phoneId);
}
/**
* Returns the Service Provider Name (SPN).
*
* @hide
*/
@UnsupportedAppUsage
public String getSimOperatorNameForPhone(int phoneId) {
return getTelephonyProperty(phoneId, TelephonyProperties.icc_operator_alpha(), "");
}
/**
* Returns the ISO-3166-1 alpha-2 country code equivalent for the SIM provider's country code.
*
* The ISO-3166-1 alpha-2 country code is provided in lowercase 2 character format.
* @return the lowercase 2 character ISO-3166-1 alpha-2 country code, or empty string is not
* available.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getSimCountryIso() {
return getSimCountryIsoForPhone(getPhoneId());
}
/**
* Returns the ISO country code equivalent for the SIM provider's country code.
*
* @param subId for which SimCountryIso is returned
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public static String getSimCountryIso(int subId) {
int phoneId = SubscriptionManager.getPhoneId(subId);
return getSimCountryIsoForPhone(phoneId);
}
/**
* Returns the ISO country code equivalent for the SIM provider's country code.
*
* @hide
*/
@UnsupportedAppUsage
public static String getSimCountryIsoForPhone(int phoneId) {
return getTelephonyProperty(phoneId, TelephonyProperties.icc_operator_iso_country(), "");
}
/**
* Returns the serial number of the SIM, if applicable. Return null if it is
* unavailable.
*
* Starting with API level 29, persistent device identifiers are guarded behind additional
* restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This
* method can be invoked if one of the following requirements is met:
* If the calling app does not meet one of these requirements then this method will behave
* as follows:
*
* Starting with API level 29, persistent device identifiers are guarded behind additional
* restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This
* method can be invoked if one of the following requirements is met:
* If the calling app does not meet one of these requirements then this method will behave
* as follows:
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}.
*
* @return {@code true} if 3GPP and 3GPP2 radio technologies can be supported at the same time
* {@code false} if not supported or unknown
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean isLteCdmaEvdoGsmWcdmaEnabled() {
return getLteOnCdmaMode(getSubId()) == PhoneConstants.LTE_ON_CDMA_TRUE;
}
/**
* Return if the current radio is LTE on CDMA for Subscription. This
* is a tri-state return value as for a period of time
* the mode may be unknown.
*
* @param subId for which radio is LTE on CDMA is returned
* @return {@link PhoneConstants#LTE_ON_CDMA_UNKNOWN}, {@link PhoneConstants#LTE_ON_CDMA_FALSE}
* or {@link PhoneConstants#LTE_ON_CDMA_TRUE}
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@UnsupportedAppUsage
public int getLteOnCdmaMode(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony == null)
return PhoneConstants.LTE_ON_CDMA_UNKNOWN;
return telephony.getLteOnCdmaModeForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
// Assume no ICC card if remote exception which shouldn't happen
return PhoneConstants.LTE_ON_CDMA_UNKNOWN;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return PhoneConstants.LTE_ON_CDMA_UNKNOWN;
}
}
/**
* Get the card ID of the default eUICC card. If the eUICCs have not yet been loaded, returns
* {@link #UNINITIALIZED_CARD_ID}. If there is no eUICC or the device does not support card IDs
* for eUICCs, returns {@link #UNSUPPORTED_CARD_ID}.
*
* The card ID is a unique identifier associated with a UICC or eUICC card. Card IDs are
* unique to a device, and always refer to the same UICC or eUICC card unless the device goes
* through a factory reset.
*
* @return card ID of the default eUICC card, if loaded.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_EUICC}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_EUICC)
public int getCardIdForDefaultEuicc() {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
return UNINITIALIZED_CARD_ID;
}
return telephony.getCardIdForDefaultEuicc(mSubId, mContext.getOpPackageName());
} catch (RemoteException e) {
return UNINITIALIZED_CARD_ID;
}
}
/**
* Gets information about currently inserted UICCs and eUICCs.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* If the caller has carrier priviliges on any active subscription, then they have permission to
* get simple information like the card ID ({@link UiccCardInfo#getCardId()}), whether the card
* is an eUICC ({@link UiccCardInfo#isEuicc()}), and the physical slot index where the card is
* inserted ({@link UiccCardInfo#getPhysicalSlotIndex()}.
*
* To get private information such as the EID ({@link UiccCardInfo#getEid()}) or ICCID
* ({@link UiccCardInfo#getIccId()}), the caller must have carrier priviliges on that specific
* UICC or eUICC card.
*
* See {@link UiccCardInfo} for more details on the kind of information available.
*
* @return a list of UiccCardInfo objects, representing information on the currently inserted
* UICCs and eUICCs. Each UiccCardInfo in the list will have private information filtered out if
* the caller does not have adequate permissions for that card.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@NonNull
public List Starting with API level 29, persistent device identifiers are guarded behind additional
* restrictions, and apps are recommended to use resettable identifiers (see Best practices for unique identifiers). This
* method can be invoked if one of the following requirements is met:
* If the calling app does not meet one of these requirements then this method will behave
* as follows:
*
*
* For a multi-sim device, the dafault data sim is used if not specified.
*
* Requires Permission: READ_PRIVILEGED_PHONE_STATE.
*
* @param keyType whether the key is being used for EPDG or WLAN. Valid values are
* {@link #KEY_TYPE_EPDG} or {@link #KEY_TYPE_WLAN}.
* @return ImsiEncryptionInfo Carrier specific information that will be used to encrypt the
* IMSI and IMPI. This includes the public key and the key identifier. This information
* will be stored in the device keystore. {@code null} will be returned when no key is
* found, and the carrier does not require a key.
* @throws IllegalArgumentException when an invalid key is found or when key is required but
* not found.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@Nullable
public ImsiEncryptionInfo getCarrierInfoForImsiEncryption(@KeyType int keyType) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null) {
Rlog.e(TAG,"IMSI error: Subscriber Info is null");
return null;
}
int subId = getSubId(SubscriptionManager.getDefaultDataSubscriptionId());
if (keyType != KEY_TYPE_EPDG && keyType != KEY_TYPE_WLAN) {
throw new IllegalArgumentException("IMSI error: Invalid key type");
}
ImsiEncryptionInfo imsiEncryptionInfo = info.getCarrierInfoForImsiEncryption(
subId, keyType, mContext.getOpPackageName());
if (imsiEncryptionInfo == null && isImsiEncryptionRequired(subId, keyType)) {
Rlog.e(TAG, "IMSI error: key is required but not found");
throw new IllegalArgumentException("IMSI error: key is required but not found");
}
return imsiEncryptionInfo;
} catch (RemoteException ex) {
Rlog.e(TAG, "getCarrierInfoForImsiEncryption RemoteException" + ex);
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
Rlog.e(TAG, "getCarrierInfoForImsiEncryption NullPointerException" + ex);
}
return null;
}
/**
* Resets the carrier keys used to encrypt the IMSI and IMPI.
*
* This involves 2 steps:
* 1. Delete the keys from the database.
* 2. Send an intent to download new Certificates.
*
* For a multi-sim device, the dafault data sim is used if not specified.
*
* Requires Permission: MODIFY_PHONE_STATE.
*
* @see #getCarrierInfoForImsiEncryption
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
public void resetCarrierKeysForImsiEncryption() {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null) {
throw new RuntimeException("IMSI error: Subscriber Info is null");
}
int subId = getSubId(SubscriptionManager.getDefaultDataSubscriptionId());
info.resetCarrierKeysForImsiEncryption(subId, mContext.getOpPackageName());
} catch (RemoteException ex) {
Rlog.e(TAG, "Telephony#getCarrierInfoForImsiEncryption RemoteException" + ex);
}
}
/**
* @param keyAvailability bitmask that defines the availabilty of keys for a type.
* @param keyType the key type which is being checked. (WLAN, EPDG)
* @return true if the digit at position keyType is 1, else false.
* @hide
*/
private static boolean isKeyEnabled(int keyAvailability, @KeyType int keyType) {
int returnValue = (keyAvailability >> (keyType - 1)) & 1;
return (returnValue == 1) ? true : false;
}
/**
* If Carrier requires Imsi to be encrypted.
* @hide
*/
private boolean isImsiEncryptionRequired(int subId, @KeyType int keyType) {
CarrierConfigManager configManager =
(CarrierConfigManager) mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);
if (configManager == null) {
return false;
}
PersistableBundle pb = configManager.getConfigForSubId(subId);
if (pb == null) {
return false;
}
int keyAvailability = pb.getInt(CarrierConfigManager.IMSI_KEY_AVAILABILITY_INT);
return isKeyEnabled(keyAvailability, keyType);
}
/**
* Sets the Carrier specific information that will be used to encrypt the IMSI and IMPI.
* This includes the public key and the key identifier. This information will be stored in the
* device keystore.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
* @param imsiEncryptionInfo which includes the Key Type, the Public Key
* (java.security.PublicKey) and the Key Identifier.and the Key Identifier.
* The keyIdentifier Attribute value pair that helps a server locate
* the private key to decrypt the permanent identity. This field is
* optional and if it is present then it’s always separated from encrypted
* permanent identity with “,”. Key identifier AVP is presented in ASCII string
* with “name=value” format.
* @hide
*/
public void setCarrierInfoForImsiEncryption(ImsiEncryptionInfo imsiEncryptionInfo) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null) return;
info.setCarrierInfoForImsiEncryption(mSubId, mContext.getOpPackageName(),
imsiEncryptionInfo);
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return;
} catch (RemoteException ex) {
Rlog.e(TAG, "setCarrierInfoForImsiEncryption RemoteException", ex);
return;
}
}
/**
* Exception that may be supplied to the callback in {@link #uploadCallComposerPicture} if
* something goes awry.
*/
public static class CallComposerException extends Exception {
/**
* Used internally only, signals success of the upload to the carrier.
* @hide
*/
public static final int SUCCESS = -1;
/**
* Indicates that an unknown error was encountered when uploading the call composer picture.
*
* Clients that encounter this error should retry the upload.
*/
public static final int ERROR_UNKNOWN = 0;
/**
* Indicates that the phone process died or otherwise became unavailable while uploading the
* call composer picture.
*
* Clients that encounter this error should retry the upload.
*/
public static final int ERROR_REMOTE_END_CLOSED = 1;
/**
* Indicates that the file or stream supplied exceeds the size limit defined in
* {@link #getMaximumCallComposerPictureSize()}.
*
* Clients that encounter this error should retry the upload after reducing the size of the
* picture.
*/
public static final int ERROR_FILE_TOO_LARGE = 2;
/**
* Indicates that the device failed to authenticate with the carrier when uploading the
* picture.
*
* Clients that encounter this error should not retry the upload unless a reboot or radio
* reset has been performed in the interim.
*/
public static final int ERROR_AUTHENTICATION_FAILED = 3;
/**
* Indicates that the {@link InputStream} passed to {@link #uploadCallComposerPicture}
* was closed.
*
* The caller should retry if this error is encountered, and be sure to not close the stream
* before the callback is called this time.
*/
public static final int ERROR_INPUT_CLOSED = 4;
/**
* Indicates that an {@link IOException} was encountered while reading the picture.
*
* The offending {@link IOException} will be available via {@link #getIOException()}.
* Clients should use the contents of the exception to determine whether a retry is
* warranted.
*/
public static final int ERROR_IO_EXCEPTION = 5;
/**
* Indicates that the device is currently not connected to a network that's capable of
* reaching a carrier's RCS servers.
*
* Clients should prompt the user to remedy the issue by moving to an area with better
* signal, by connecting to a different network, or to retry at another time.
*/
public static final int ERROR_NETWORK_UNAVAILABLE = 6;
/** @hide */
@IntDef(prefix = {"ERROR_"}, value = {
ERROR_UNKNOWN,
ERROR_REMOTE_END_CLOSED,
ERROR_FILE_TOO_LARGE,
ERROR_AUTHENTICATION_FAILED,
ERROR_INPUT_CLOSED,
ERROR_IO_EXCEPTION,
ERROR_NETWORK_UNAVAILABLE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface CallComposerError {}
private final int mErrorCode;
private final IOException mIOException;
public CallComposerException(@CallComposerError int errorCode,
@Nullable IOException ioException) {
mErrorCode = errorCode;
mIOException = ioException;
}
/**
* Fetches the error code associated with this exception.
* @return An error code.
*/
public @CallComposerError int getErrorCode() {
return mErrorCode;
}
/**
* Fetches the {@link IOException} that caused the error.
*/
// Follows the naming of IOException
@SuppressLint("AcronymName")
public @Nullable IOException getIOException() {
return mIOException;
}
}
/** @hide */
public static final String KEY_CALL_COMPOSER_PICTURE_HANDLE = "call_composer_picture_handle";
/**
* Uploads a picture to the carrier network for use with call composer.
*
* @see #uploadCallComposerPicture(InputStream, String, Executor, OutcomeReceiver)
* @param pictureToUpload Path to a local file containing the picture to upload.
* @param contentType The MIME type of the picture you're uploading (e.g. image/jpeg)
* @param executor The {@link Executor} on which the {@code pictureToUpload} file will be read
* from disk, as well as on which {@code callback} will be called.
* @param callback A callback called when the upload operation terminates, either in success
* or in error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void uploadCallComposerPicture(@NonNull Path pictureToUpload,
@NonNull String contentType,
@CallbackExecutor @NonNull Executor executor,
@NonNull OutcomeReceiver Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getGroupIdLevel1() {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getGroupIdLevel1ForSubscriber(getSubId(), mContext.getOpPackageName(),
mContext.getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns the Group Identifier Level1 for a GSM phone for a particular subscription.
* Return null if it is unavailable.
*
* @param subId whose subscriber id is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage
public String getGroupIdLevel1(int subId) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getGroupIdLevel1ForSubscriber(subId, mContext.getOpPackageName(),
mContext.getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns the phone number string for line 1, for example, the MSISDN
* for a GSM phone for a particular subscription. Return null if it is unavailable.
*
* The default SMS app can also use this.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_SMS READ_SMS},
* {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
* that the caller is the default SMS app,
* or that the caller has carrier privileges (see {@link #hasCarrierPrivileges})
* for any API level.
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* for apps targeting SDK API level 29 and below.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead.
*/
@Deprecated
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_SMS,
android.Manifest.permission.READ_PHONE_NUMBERS
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getLine1Number() {
return getLine1Number(getSubId());
}
/**
* Returns the phone number string for line 1, for example, the MSISDN
* for a GSM phone for a particular subscription. Return null if it is unavailable.
*
* The default SMS app can also use this.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_SMS READ_SMS},
* {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
* that the caller is the default SMS app,
* or that the caller has carrier privileges (see {@link #hasCarrierPrivileges})
* for any API level.
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* for apps targeting SDK API level 29 and below.
*
* @param subId whose phone number for line 1 is returned
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_SMS,
android.Manifest.permission.READ_PHONE_NUMBERS
})
@UnsupportedAppUsage
public String getLine1Number(int subId) {
String number = null;
try {
ITelephony telephony = getITelephony();
if (telephony != null)
number = telephony.getLine1NumberForDisplay(subId, mContext.getOpPackageName(),
mContext.getAttributionTag());
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
if (number != null) {
return number;
}
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getLine1NumberForSubscriber(subId, mContext.getOpPackageName(),
mContext.getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Set the line 1 phone number string and its alphatag for the current ICCID
* for display purpose only, for example, displayed in Phone Status. It won't
* change the actual MSISDN/MDN. To unset alphatag or number, pass in a null
* value.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param alphaTag alpha-tagging of the dailing nubmer
* @param number The dialing number
* @return true if the operation was executed correctly.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @deprecated use {@link SubscriptionManager#setCarrierPhoneNumber(int, String)} instead.
*/
@Deprecated
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean setLine1NumberForDisplay(String alphaTag, String number) {
return setLine1NumberForDisplay(getSubId(), alphaTag, number);
}
/**
* Set the line 1 phone number string and its alphatag for the current ICCID
* for display purpose only, for example, displayed in Phone Status. It won't
* change the actual MSISDN/MDN. To unset alphatag or number, pass in a null
* value.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId the subscriber that the alphatag and dialing number belongs to.
* @param alphaTag alpha-tagging of the dailing nubmer
* @param number The dialing number
* @return true if the operation was executed correctly.
* @hide
*/
public boolean setLine1NumberForDisplay(int subId, String alphaTag, String number) {
try {
// This API is deprecated; call the new API to allow smooth migartion.
// The new API doesn't accept null so convert null to empty string.
mSubscriptionManager.setCarrierPhoneNumber(subId, (number == null ? "" : number));
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.setLine1NumberForDisplayForSubscriber(subId, alphaTag, number);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return false;
}
/**
* Returns the alphabetic identifier associated with the line 1 number.
* Return null if it is unavailable.
* @hide
* nobody seems to call this.
*/
@UnsupportedAppUsage
@TestApi
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
public String getLine1AlphaTag() {
return getLine1AlphaTag(getSubId());
}
/**
* Returns the alphabetic identifier associated with the line 1 number
* for a subscription.
* Return null if it is unavailable.
* @param subId whose alphabetic identifier associated with line 1 is returned
* nobody seems to call this.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage
public String getLine1AlphaTag(int subId) {
String alphaTag = null;
try {
ITelephony telephony = getITelephony();
if (telephony != null)
alphaTag = telephony.getLine1AlphaTagForDisplay(subId,
getOpPackageName(), getAttributionTag());
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
if (alphaTag != null) {
return alphaTag;
}
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getLine1AlphaTagForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Return the set of subscriber IDs that should be considered "merged together" for data usage
* purposes. This is commonly {@code null} to indicate no merging is required. Any returned
* subscribers are sorted in a deterministic order.
*
* The returned set of subscriber IDs will include the subscriber ID corresponding to this
* TelephonyManager's subId.
*
* This is deprecated and {@link #getMergedImsisFromGroup()} should be used for data
* usage merging purpose.
* TODO: remove this API.
*
* @hide
*/
@UnsupportedAppUsage
@Deprecated
public @Nullable String[] getMergedSubscriberIds() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.getMergedSubscriberIds(getSubId(), getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Return the set of IMSIs that should be considered "merged together" for data usage
* purposes. This API merges IMSIs based on subscription grouping: IMSI of those in the same
* group will all be returned.
* Return the current IMSI if there is no subscription group, see
* {@link SubscriptionManager#createSubscriptionGroup(List)} for the definition of a group,
* otherwise return an empty array if there is a failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @NonNull String[] getMergedImsisFromGroup() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
String[] mergedImsisFromGroup =
telephony.getMergedImsisFromGroup(getSubId(), getOpPackageName());
if (mergedImsisFromGroup != null) {
return mergedImsisFromGroup;
}
}
} catch (RemoteException ex) {
}
return new String[0];
}
/**
* Returns the MSISDN string for a GSM phone. Return null if it is unavailable.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_SMS READ_SMS},
* {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
* that the caller is the default SMS app,
* or that the caller has carrier privileges (see {@link #hasCarrierPrivileges})
* for any API level.
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* for apps targeting SDK API level 29 and below.
*
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_SMS,
android.Manifest.permission.READ_PHONE_NUMBERS
})
@UnsupportedAppUsage
public String getMsisdn() {
return getMsisdn(getSubId());
}
/**
* Returns the MSISDN string for a GSM phone. Return null if it is unavailable.
*
* @param subId for which msisdn is returned
*
* Requires Permission:
* {@link android.Manifest.permission#READ_SMS READ_SMS},
* {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
* that the caller is the default SMS app,
* or that the caller has carrier privileges (see {@link #hasCarrierPrivileges})
* for any API level.
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* for apps targeting SDK API level 29 and below.
*
* @hide
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_SMS,
android.Manifest.permission.READ_PHONE_NUMBERS
})
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getMsisdn(int subId) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getMsisdnForSubscriber(subId, getOpPackageName(), getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns the voice mail number. Return null if it is unavailable.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public String getVoiceMailNumber() {
return getVoiceMailNumber(getSubId());
}
/**
* Returns the voice mail number for a subscription.
* Return null if it is unavailable.
* @param subId whose voice mail number is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage
public String getVoiceMailNumber(int subId) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getVoiceMailNumberForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Sets the voice mail number.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param alphaTag The alpha tag to display.
* @param number The voicemail number.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean setVoiceMailNumber(String alphaTag, String number) {
return setVoiceMailNumber(getSubId(), alphaTag, number);
}
/**
* Sets the voicemail number for the given subscriber.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription id.
* @param alphaTag The alpha tag to display.
* @param number The voicemail number.
* @hide
*/
public boolean setVoiceMailNumber(int subId, String alphaTag, String number) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.setVoiceMailNumber(subId, alphaTag, number);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return false;
}
/**
* Enables or disables the visual voicemail client for a phone account.
*
* Requires that the calling app is the default dialer, or has carrier privileges (see
* {@link #hasCarrierPrivileges}), or has permission
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param phoneAccountHandle the phone account to change the client state
* @param enabled the new state of the client
* @hide
* @deprecated Visual voicemail no longer in telephony. {@link VisualVoicemailService} should
* be implemented instead.
*/
@SystemApi
@Deprecated
@SuppressLint("RequiresPermission")
public void setVisualVoicemailEnabled(PhoneAccountHandle phoneAccountHandle, boolean enabled){
}
/**
* Returns whether the visual voicemail client is enabled.
*
* @param phoneAccountHandle the phone account to check for.
* @return {@code true} when the visual voicemail client is enabled for this client
* @hide
* @deprecated Visual voicemail no longer in telephony. {@link VisualVoicemailService} should
* be implemented instead.
*/
@SystemApi
@Deprecated
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@SuppressLint("RequiresPermission")
public boolean isVisualVoicemailEnabled(PhoneAccountHandle phoneAccountHandle){
return false;
}
/**
* Returns an opaque bundle of settings formerly used by the visual voicemail client for the
* subscription ID pinned to the TelephonyManager, or {@code null} if the subscription ID is
* invalid. This method allows the system dialer to migrate settings out of the pre-O visual
* voicemail client in telephony.
*
* Requires the caller to be the system dialer.
*
* @see #KEY_VISUAL_VOICEMAIL_ENABLED_BY_USER_BOOL
* @see #KEY_VOICEMAIL_SCRAMBLED_PIN_STRING
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@SuppressLint("RequiresPermission")
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
@Nullable
public Bundle getVisualVoicemailSettings(){
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony
.getVisualVoicemailSettings(mContext.getOpPackageName(), mSubId);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Returns the package responsible of processing visual voicemail for the subscription ID pinned
* to the TelephonyManager. Returns {@code null} when there is no package responsible for
* processing visual voicemail for the subscription.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @see #createForSubscriptionId(int)
* @see #createForPhoneAccountHandle(PhoneAccountHandle)
* @see VisualVoicemailService
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@Nullable
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public String getVisualVoicemailPackageName() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getVisualVoicemailPackageName(mContext.getOpPackageName(),
getAttributionTag(), getSubId());
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Set the visual voicemail SMS filter settings for the subscription ID pinned
* to the TelephonyManager.
* When the filter is enabled, {@link
* VisualVoicemailService#onSmsReceived(VisualVoicemailTask, VisualVoicemailSms)} will be
* called when a SMS matching the settings is received. Caller must be the default dialer,
* system dialer, or carrier visual voicemail app.
*
* @param settings The settings for the filter, or {@code null} to disable the filter.
*
* @see TelecomManager#getDefaultDialerPackage()
* @see CarrierConfigManager#KEY_CARRIER_VVM_PACKAGE_NAME_STRING_ARRAY
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void setVisualVoicemailSmsFilterSettings(VisualVoicemailSmsFilterSettings settings) {
if (settings == null) {
disableVisualVoicemailSmsFilter(mSubId);
} else {
enableVisualVoicemailSmsFilter(mSubId, settings);
}
}
/**
* Send a visual voicemail SMS. The caller must be the current default dialer.
* A {@link VisualVoicemailService} uses this method to send a command via SMS to the carrier's
* visual voicemail server. Some examples for carriers using the OMTP standard include
* activating and deactivating visual voicemail, or requesting the current visual voicemail
* provisioning status. See the OMTP Visual Voicemail specification for more information on the
* format of these SMS messages.
*
* Requires Permission:
* {@link android.Manifest.permission#SEND_SMS SEND_SMS}
*
* @param number The destination number.
* @param port The destination port for data SMS, or 0 for text SMS.
* @param text The message content. For data sms, it will be encoded as a UTF-8 byte stream.
* @param sentIntent The sent intent passed to the {@link SmsManager}
*
* @throws SecurityException if the caller is not the current default dialer
*
* @see SmsManager#sendDataMessage(String, String, short, byte[], PendingIntent, PendingIntent)
* @see SmsManager#sendTextMessage(String, String, String, PendingIntent, PendingIntent)
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void sendVisualVoicemailSms(String number, int port, String text,
PendingIntent sentIntent) {
sendVisualVoicemailSmsForSubscriber(mSubId, number, port, text, sentIntent);
}
/**
* Enables the visual voicemail SMS filter for a phone account. When the filter is
* enabled, Incoming SMS messages matching the OMTP VVM SMS interface will be redirected to the
* visual voicemail client with
* {@link android.provider.VoicemailContract.ACTION_VOICEMAIL_SMS_RECEIVED}.
*
* This takes effect only when the caller is the default dialer. The enabled status and
* settings persist through default dialer changes, but the filter will only honor the setting
* set by the current default dialer.
*
*
* @param subId The subscription id of the phone account.
* @param settings The settings for the filter.
*/
/** @hide */
public void enableVisualVoicemailSmsFilter(int subId,
VisualVoicemailSmsFilterSettings settings) {
if(settings == null){
throw new IllegalArgumentException("Settings cannot be null");
}
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.enableVisualVoicemailSmsFilter(mContext.getOpPackageName(), subId,
settings);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
}
/**
* Disables the visual voicemail SMS filter for a phone account.
*
* This takes effect only when the caller is the default dialer. The enabled status and
* settings persist through default dialer changes, but the filter will only honor the setting
* set by the current default dialer.
*/
/** @hide */
public void disableVisualVoicemailSmsFilter(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.disableVisualVoicemailSmsFilter(mContext.getOpPackageName(), subId);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
}
/**
* @returns the settings of the visual voicemail SMS filter for a phone account, or {@code null}
* if the filter is disabled.
*
* This takes effect only when the caller is the default dialer. The enabled status and
* settings persist through default dialer changes, but the filter will only honor the setting
* set by the current default dialer.
*/
/** @hide */
@Nullable
public VisualVoicemailSmsFilterSettings getVisualVoicemailSmsFilterSettings(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony
.getVisualVoicemailSmsFilterSettings(mContext.getOpPackageName(), subId);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* @returns the settings of the visual voicemail SMS filter for a phone account set by the
* current active visual voicemail client, or {@code null} if the filter is disabled.
*
* Requires the calling app to have READ_PRIVILEGED_PHONE_STATE permission.
*/
/** @hide */
@Nullable
public VisualVoicemailSmsFilterSettings getActiveVisualVoicemailSmsFilterSettings(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getActiveVisualVoicemailSmsFilterSettings(subId);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Send a visual voicemail SMS. The IPC caller must be the current default dialer.
*
* @param phoneAccountHandle The account to send the SMS with.
* @param number The destination number.
* @param port The destination port for data SMS, or 0 for text SMS.
* @param text The message content. For data sms, it will be encoded as a UTF-8 byte stream.
* @param sentIntent The sent intent passed to the {@link SmsManager}
*
* @see SmsManager#sendDataMessage(String, String, short, byte[], PendingIntent, PendingIntent)
* @see SmsManager#sendTextMessage(String, String, String, PendingIntent, PendingIntent)
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.SEND_SMS)
public void sendVisualVoicemailSmsForSubscriber(int subId, String number, int port,
String text, PendingIntent sentIntent) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.sendVisualVoicemailSmsForSubscriber(
mContext.getOpPackageName(), mContext.getAttributionTag(), subId, number,
port, text, sentIntent);
}
} catch (RemoteException ex) {
}
}
/**
* Initial SIM activation state, unknown. Not set by any carrier apps.
* @hide
*/
@SystemApi
public static final int SIM_ACTIVATION_STATE_UNKNOWN = 0;
/**
* indicate SIM is under activation procedure now.
* intermediate state followed by another state update with activation procedure result:
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @see #SIM_ACTIVATION_STATE_RESTRICTED
* @hide
*/
@SystemApi
public static final int SIM_ACTIVATION_STATE_ACTIVATING = 1;
/**
* Indicate SIM has been successfully activated with full service
* @hide
*/
@SystemApi
public static final int SIM_ACTIVATION_STATE_ACTIVATED = 2;
/**
* Indicate SIM has been deactivated by the carrier so that service is not available
* and requires activation service to enable services.
* Carrier apps could be signalled to set activation state to deactivated if detected
* deactivated sim state and set it back to activated after successfully run activation service.
* @hide
*/
@SystemApi
public static final int SIM_ACTIVATION_STATE_DEACTIVATED = 3;
/**
* Restricted state indicate SIM has been activated but service are restricted.
* note this is currently available for data activation state. For example out of byte sim.
* @hide
*/
@SystemApi
public static final int SIM_ACTIVATION_STATE_RESTRICTED = 4;
/**
* Sets the voice activation state
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param activationState The voice activation state
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void setVoiceActivationState(@SimActivationState int activationState) {
setVoiceActivationState(getSubId(), activationState);
}
/**
* Sets the voice activation state for the given subscriber.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription id.
* @param activationState The voice activation state of the given subscriber.
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public void setVoiceActivationState(int subId, @SimActivationState int activationState) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.setVoiceActivationState(subId, activationState);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
}
/**
* Sets the data activation state
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param activationState The data activation state
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @see #SIM_ACTIVATION_STATE_RESTRICTED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setDataActivationState(@SimActivationState int activationState) {
setDataActivationState(getSubId(), activationState);
}
/**
* Sets the data activation state for the given subscriber.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription id.
* @param activationState The data activation state of the given subscriber.
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @see #SIM_ACTIVATION_STATE_RESTRICTED
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public void setDataActivationState(int subId, @SimActivationState int activationState) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.setDataActivationState(subId, activationState);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
}
/**
* Returns the voice activation state
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return voiceActivationState
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public @SimActivationState int getVoiceActivationState() {
return getVoiceActivationState(getSubId());
}
/**
* Returns the voice activation state for the given subscriber.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription id.
*
* @return voiceActivationState for the given subscriber
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public @SimActivationState int getVoiceActivationState(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.getVoiceActivationState(subId, getOpPackageName());
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return SIM_ACTIVATION_STATE_UNKNOWN;
}
/**
* Returns the data activation state
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return dataActivationState for the given subscriber
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @see #SIM_ACTIVATION_STATE_RESTRICTED
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public @SimActivationState int getDataActivationState() {
return getDataActivationState(getSubId());
}
/**
* Returns the data activation state for the given subscriber.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription id.
*
* @return dataActivationState for the given subscriber
* @see #SIM_ACTIVATION_STATE_UNKNOWN
* @see #SIM_ACTIVATION_STATE_ACTIVATING
* @see #SIM_ACTIVATION_STATE_ACTIVATED
* @see #SIM_ACTIVATION_STATE_DEACTIVATED
* @see #SIM_ACTIVATION_STATE_RESTRICTED
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public @SimActivationState int getDataActivationState(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.getDataActivationState(subId, getOpPackageName());
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return SIM_ACTIVATION_STATE_UNKNOWN;
}
/**
* Returns the voice mail count. Return 0 if unavailable, -1 if there are unread voice messages
* but the count is unknown.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage
public int getVoiceMessageCount() {
return getVoiceMessageCount(getSubId());
}
/**
* Returns the voice mail count for a subscription. Return 0 if unavailable or the caller does
* not have the READ_PHONE_STATE permission.
* @param subId whose voice message count is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage
public int getVoiceMessageCount(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony == null)
return 0;
return telephony.getVoiceMessageCountForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
return 0;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return 0;
}
}
/**
* Retrieves the alphabetic identifier associated with the voice
* mail number.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public String getVoiceMailAlphaTag() {
return getVoiceMailAlphaTag(getSubId());
}
/**
* Retrieves the alphabetic identifier associated with the voice
* mail number for a subscription.
* @param subId whose alphabetic identifier associated with the
* voice mail number is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@UnsupportedAppUsage
public String getVoiceMailAlphaTag(int subId) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getVoiceMailAlphaTagForSubscriber(subId, getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Send the special dialer code. The IPC caller must be the current default dialer or have
* carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param inputCode The special dialer code to send
*
* @throws SecurityException if the caller does not have carrier privileges or is not the
* current default dialer
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void sendDialerSpecialCode(String inputCode) {
try {
final ITelephony telephony = getITelephony();
if (telephony == null) {
return;
}
telephony.sendDialerSpecialCode(mContext.getOpPackageName(), inputCode);
} catch (RemoteException ex) {
Rlog.e(TAG, "Telephony#sendDialerSpecialCode RemoteException" + ex);
}
}
/**
* Returns the IMS private user identity (IMPI) that was loaded from the ISIM.
* @return the IMPI, or null if not present or not loaded
* @hide
* @deprecated use {@link #getImsPrivateUserIdentity()}
*/
@UnsupportedAppUsage
public String getIsimImpi() {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
//get the Isim Impi based on subId
return info.getIsimImpi(getSubId());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns the IMS private user identity (IMPI) of the subscription that was loaded from the
* ISIM records {@link #APPTYPE_ISIM}. This value is fetched from the Elementary file EF_IMPI.
* The contents of the file is a Ip Multimedia Service Private User Identity of the user
* as defined in the section 4.2.2 of 3GPP TS 131 103.
*
* @return IMPI (IMS private user identity) of type string.
* @throws IllegalStateException in case the ISIM has’t been loaded
* @throws SecurityException if the caller does not have the required permission/privileges
* @hide
*/
@NonNull
@RequiresPermission(android.Manifest.permission.USE_ICC_AUTH_WITH_DEVICE_IDENTIFIER)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getImsPrivateUserIdentity() {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null) {
Rlog.e(TAG, "getImsPrivateUserIdentity(): IPhoneSubInfo instance is NULL");
throw new RuntimeException("IMPI error: Subscriber Info is null");
}
return info.getImsPrivateUserIdentity(getSubId(), getOpPackageName(),
getAttributionTag());
} catch (RemoteException | NullPointerException | IllegalArgumentException ex) {
Rlog.e(TAG, "getImsPrivateUserIdentity() Exception = " + ex);
throw new RuntimeException(ex.getMessage());
}
}
/**
* Returns the IMS home network domain name that was loaded from the ISIM {@see #APPTYPE_ISIM}.
* @return the IMS domain name. Returns {@code null} if ISIM hasn't been loaded or IMS domain
* hasn't been loaded or isn't present on the ISIM.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@Nullable
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getIsimDomain() {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
//get the Isim Domain based on subId
return info.getIsimDomain(getSubId());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns the IMS public user identities (IMPU) that were loaded from the ISIM.
* @return an array of IMPU strings, with one IMPU per string, or null if
* not present or not loaded
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated use {@link #getImsPublicUserIdentities()}
*/
@UnsupportedAppUsage
@Nullable
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public String[] getIsimImpu() {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
//get the Isim Impu based on subId
return info.getIsimImpu(getSubId());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns the IMS public user identities (IMPU) of the subscription that was loaded from the
* ISIM records {@link #APPTYPE_ISIM}. This value is fetched from the Elementary file EF_IMPU.
* The contents of the file are Ip Multimedia Service Public User Identities of the user
* as defined in the section 4.2.4 of 3GPP TS 131 103. It contains one or more records.
*
* @return List of public user identities of type android.net.Uri or empty list if
* EF_IMPU is not available.
* @throws IllegalStateException in case the ISIM hasn’t been loaded
* @throws SecurityException if the caller does not have the required permission/privilege
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@NonNull
@RequiresPermission(anyOf = {android.Manifest.permission.READ_PHONE_NUMBERS,
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public List
* This method considers not only calls in the Telephony stack, but also calls via other
* {@link android.telecom.ConnectionService} implementations.
*
* Note: The call state returned via this method may differ from what is reported by {@link
* TelephonyCallback.CallStateListener#onCallStateChanged(int)}, as that callback only considers
* Telephony (mobile) calls.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
* targeting API level 31+.
*
* @return the current call state.
* @deprecated Use {@link #getCallStateForSubscription} to retrieve the call state for a
* specific telephony subscription (which allows carrier privileged apps),
* {@link TelephonyCallback.CallStateListener} for real-time call state updates, or
* {@link TelecomManager#isInCall()}, which supplies an aggregate "in call" state for the entire
* device.
*/
@RequiresPermission(value = android.Manifest.permission.READ_PHONE_STATE, conditional = true)
@Deprecated
public @CallState int getCallState() {
if (mContext != null) {
TelecomManager telecomManager = mContext.getSystemService(TelecomManager.class);
if (telecomManager != null) {
return telecomManager.getCallState();
}
}
return CALL_STATE_IDLE;
}
/**
* Retrieve the call state for a specific subscription that was specified when this
* TelephonyManager instance was created.
* Requires Permission:
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} or that the calling
* application has carrier privileges (see {@link #hasCarrierPrivileges}).
* @see TelephonyManager#createForSubscriptionId(int)
* @see TelephonyManager#createForPhoneAccountHandle(PhoneAccountHandle)
* @return The call state of the subscription associated with this TelephonyManager instance.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public @CallState int getCallStateForSubscription() {
return getCallState(getSubId());
}
/**
* Returns the Telephony call state for calls on a specific subscription.
*
* Note: This method considers ONLY telephony/mobile calls, where {@link #getCallState()}
* considers the state of calls from other {@link android.telecom.ConnectionService}
* implementations.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
* targeting API level 31+ or that the calling application has carrier privileges
* (see {@link #hasCarrierPrivileges()}).
*
* @param subId the subscription to check call state for.
* @hide
*/
@UnsupportedAppUsage
@RequiresPermission(value = android.Manifest.permission.READ_PHONE_STATE, conditional = true)
public @CallState int getCallState(int subId) {
ITelephony telephony = getITelephony();
if (telephony == null) {
return CALL_STATE_IDLE;
}
try {
return telephony.getCallStateForSubscription(subId, mContext.getPackageName(),
mContext.getAttributionTag());
} catch (RemoteException e) {
return CALL_STATE_IDLE;
}
}
/** Data connection activity: No traffic. */
public static final int DATA_ACTIVITY_NONE = 0x00000000;
/** Data connection activity: Currently receiving IP PPP traffic. */
public static final int DATA_ACTIVITY_IN = 0x00000001;
/** Data connection activity: Currently sending IP PPP traffic. */
public static final int DATA_ACTIVITY_OUT = 0x00000002;
/** Data connection activity: Currently both sending and receiving
* IP PPP traffic. */
public static final int DATA_ACTIVITY_INOUT = DATA_ACTIVITY_IN | DATA_ACTIVITY_OUT;
/**
* Data connection is active, but physical link is down
*/
public static final int DATA_ACTIVITY_DORMANT = 0x00000004;
/**
* Returns a constant indicating the type of activity on a data connection
* (cellular).
*
* @see #DATA_ACTIVITY_NONE
* @see #DATA_ACTIVITY_IN
* @see #DATA_ACTIVITY_OUT
* @see #DATA_ACTIVITY_INOUT
* @see #DATA_ACTIVITY_DORMANT
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public int getDataActivity() {
try {
ITelephony telephony = getITelephony();
if (telephony == null)
return DATA_ACTIVITY_NONE;
return telephony.getDataActivityForSubId(
getSubId(SubscriptionManager.getActiveDataSubscriptionId()));
} catch (RemoteException ex) {
// the phone process is restarting.
return DATA_ACTIVITY_NONE;
} catch (NullPointerException ex) {
// the phone process is restarting.
return DATA_ACTIVITY_NONE;
}
}
/** @hide */
@IntDef(prefix = {"DATA_"}, value = {
DATA_UNKNOWN,
DATA_DISCONNECTED,
DATA_CONNECTING,
DATA_CONNECTED,
DATA_SUSPENDED,
DATA_DISCONNECTING,
DATA_HANDOVER_IN_PROGRESS,
})
@Retention(RetentionPolicy.SOURCE)
public @interface DataState{}
/** Data connection state: Unknown. Used before we know the state. */
public static final int DATA_UNKNOWN = -1;
/** Data connection state: Disconnected. IP traffic not available. */
public static final int DATA_DISCONNECTED = 0;
/** Data connection state: Currently setting up a data connection. */
public static final int DATA_CONNECTING = 1;
/** Data connection state: Connected. IP traffic should be available. */
public static final int DATA_CONNECTED = 2;
/** Data connection state: Suspended. The connection is up, but IP
* traffic is temporarily unavailable. For example, in a 2G network,
* data activity may be suspended when a voice call arrives. */
public static final int DATA_SUSPENDED = 3;
/**
* Data connection state: Disconnecting.
*
* IP traffic may be available but will cease working imminently.
*/
public static final int DATA_DISCONNECTING = 4;
/**
* Data connection state: Handover in progress. The connection is being transited from cellular
* network to IWLAN, or from IWLAN to cellular network.
*/
public static final int DATA_HANDOVER_IN_PROGRESS = 5;
/**
* Used for checking if the SDK version for {@link TelephonyManager#getDataState} is above Q.
*/
@ChangeId
@EnabledAfter(targetSdkVersion = Build.VERSION_CODES.Q)
private static final long GET_DATA_STATE_R_VERSION = 148534348L;
/**
* Returns a constant indicating the current data connection state
* (cellular).
*
* @see #DATA_DISCONNECTED
* @see #DATA_CONNECTING
* @see #DATA_CONNECTED
* @see #DATA_SUSPENDED
* @see #DATA_DISCONNECTING
* @see #DATA_HANDOVER_IN_PROGRESS
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public int getDataState() {
try {
ITelephony telephony = getITelephony();
if (telephony == null)
return DATA_DISCONNECTED;
int state = telephony.getDataStateForSubId(
getSubId(SubscriptionManager.getActiveDataSubscriptionId()));
if (state == TelephonyManager.DATA_DISCONNECTING
&& !Compatibility.isChangeEnabled(GET_DATA_STATE_R_VERSION)) {
return TelephonyManager.DATA_CONNECTED;
}
return state;
} catch (RemoteException ex) {
// the phone process is restarting.
return DATA_DISCONNECTED;
} catch (NullPointerException ex) {
return DATA_DISCONNECTED;
}
}
private static ITelephony getITelephony() {
// Keeps cache disabled until test fixes are checked into AOSP.
if (!sServiceHandleCacheEnabled) {
return ITelephony.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getTelephonyServiceRegisterer()
.get());
}
if (sITelephony == null) {
ITelephony temp = ITelephony.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getTelephonyServiceRegisterer()
.get());
synchronized (sCacheLock) {
if (sITelephony == null && temp != null) {
try {
sITelephony = temp;
sITelephony.asBinder().linkToDeath(sServiceDeath, 0);
} catch (Exception e) {
// something has gone horribly wrong
sITelephony = null;
}
}
}
}
return sITelephony;
}
private IOns getIOns() {
return IOns.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getOpportunisticNetworkServiceRegisterer()
.get());
}
//
//
// PhoneStateListener
//
//
/**
* Registers a listener object to receive notification of changes
* in specified telephony states.
*
* To register a listener, pass a {@link PhoneStateListener} and specify at least one telephony
* state of interest in the events argument.
*
* At registration, and when a specified telephony state changes, the telephony manager invokes
* the appropriate callback method on the listener object and passes the current (updated)
* values.
*
* To un-register a listener, pass the listener object and set the events argument to
* {@link PhoneStateListener#LISTEN_NONE LISTEN_NONE} (0).
*
* If this TelephonyManager object has been created with {@link #createForSubscriptionId},
* applies to the given subId. Otherwise, applies to
* {@link SubscriptionManager#getDefaultSubscriptionId()}. To listen events for multiple subIds,
* pass a separate listener object to each TelephonyManager object created with
* {@link #createForSubscriptionId}.
*
* Note: if you call this method while in the middle of a binder transaction, you must
* call {@link android.os.Binder#clearCallingIdentity()} before calling this method. A
* {@link SecurityException} will be thrown otherwise.
*
* This API should be used sparingly -- large numbers of listeners will cause system
* instability. If a process has registered too many listeners without unregistering them, it
* may encounter an {@link IllegalStateException} when trying to register more listeners.
*
* @param listener The {@link PhoneStateListener} object to register
* (or unregister)
* @param events The telephony state(s) of interest to the listener,
* as a bitwise-OR combination of {@link PhoneStateListener}
* LISTEN_ flags.
* @deprecated Use {@link #registerTelephonyCallback(Executor, TelephonyCallback)}.
*/
@Deprecated
public void listen(PhoneStateListener listener, int events) {
if (mContext == null) return;
boolean notifyNow = (getITelephony() != null);
TelephonyRegistryManager telephonyRegistry =
(TelephonyRegistryManager)
mContext.getSystemService(Context.TELEPHONY_REGISTRY_SERVICE);
if (telephonyRegistry != null) {
Set
* "Voice capable" means that this device supports circuit-switched
* (i.e. voice) phone calls over the telephony network, and is allowed
* to display the in-call UI while a cellular voice call is active.
* This will be false on "data only" devices which can't make voice
* calls and don't support any in-call UI.
*
* Note: the meaning of this flag is subtly different from the
* PackageManager.FEATURE_TELEPHONY system feature, which is available
* on any device with a telephony radio, even if the device is
* data-only.
* @deprecated Replaced by {@code #isDeviceVoiceCapable()}. Starting from Android 15, voice
* capability may also be overridden by carriers for a given subscription. For voice capable
* device (when {@code #isDeviceVoiceCapable} return {@code true}), caller should check for
* subscription-level voice capability as well. See {@code #isDeviceVoiceCapable} for details.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
@Deprecated
public boolean isVoiceCapable() {
if (mContext == null) return true;
return mContext.getResources().getBoolean(
com.android.internal.R.bool.config_voice_capable);
}
/**
* @return true if the current device is "voice capable".
*
* "Voice capable" means that this device supports circuit-switched or IMS packet switched
* (i.e. voice) phone calls over the telephony network, and is allowed to display the in-call
* UI while a cellular voice call is active. This will be false on "data only" devices which
* can't make voice calls and don't support any in-call UI.
*
* Note: the meaning of this flag is subtly different from the PackageManager
* .FEATURE_TELEPHONY system feature, which is available on any device with a telephony
* radio, even if the device is data-only.
*
* Starting from Android 15, voice capability may also be overridden by carrier for a given
* subscription on a voice capable device. To check if a subscription is "voice capable",
* call method {@code SubscriptionInfo#getServiceCapabilities()} and check if
* {@code SubscriptionManager#SERVICE_CAPABILITY_VOICE} is included.
*
* @see SubscriptionInfo#getServiceCapabilities()
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
@FlaggedApi(Flags.FLAG_DATA_ONLY_CELLULAR_SERVICE)
public boolean isDeviceVoiceCapable() {
return isVoiceCapable();
}
/**
* @return true if the current device supports sms service.
*
* If true, this means that the device supports both sending and
* receiving sms via the telephony network.
*
* Note: Voicemail waiting sms, cell broadcasting sms, and MMS are
* disabled when device doesn't support sms.
* @deprecated Replaced by {@code #isDeviceSmsCapable()}. Starting from Android 15, SMS
* capability may also be overridden by carriers for a given subscription. For SMS capable
* device (when {@code #isDeviceSmsCapable} return {@code true}), caller should check for
* subscription-level SMS capability as well. See {@code #isDeviceSmsCapable} for details.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_MESSAGING)
public boolean isSmsCapable() {
if (mContext == null) return true;
return mContext.getResources().getBoolean(
com.android.internal.R.bool.config_sms_capable);
}
/**
* @return true if the current device supports SMS service.
*
* If true, this means that the device supports both sending and
* receiving SMS via the telephony network.
*
* Note: Voicemail waiting SMS, cell broadcasting SMS, and MMS are
* disabled when device doesn't support SMS.
*
* Starting from Android 15, SMS capability may also be overridden by carriers for a given
* subscription on an SMS capable device. To check if a subscription is "SMS capable",
* call method {@code SubscriptionInfo#getServiceCapabilities()} and check if
* {@code SubscriptionManager#SERVICE_CAPABILITY_SMS} is included.
*
* @see SubscriptionInfo#getServiceCapabilities()
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_MESSAGING)
@FlaggedApi(Flags.FLAG_DATA_ONLY_CELLULAR_SERVICE)
public boolean isDeviceSmsCapable() {
return isSmsCapable();
}
/**
* Requests all available cell information from all radios on the device including the
* camped/registered, serving, and neighboring cells.
*
* The response can include one or more {@link android.telephony.CellInfoGsm CellInfoGsm},
* {@link android.telephony.CellInfoCdma CellInfoCdma},
* {@link android.telephony.CellInfoTdscdma CellInfoTdscdma},
* {@link android.telephony.CellInfoLte CellInfoLte}, and
* {@link android.telephony.CellInfoWcdma CellInfoWcdma} objects, in any combination.
* It is typical to see instances of one or more of any these in the list. In addition, zero
* or more of the returned objects may be considered registered; that is, their
* {@link android.telephony.CellInfo#isRegistered CellInfo.isRegistered()}
* methods may return true, indicating that the cell is being used or would be used for
* signaling communication if necessary.
*
* Beginning with {@link android.os.Build.VERSION_CODES#Q Android Q},
* if this API results in a change of the cached CellInfo, that change will be reported via
* {@link TelephonyCallback.CellInfoListener#onCellInfoChanged(List) onCellInfoChanged()}.
*
* Apps targeting {@link android.os.Build.VERSION_CODES#Q Android Q} or higher will no
* longer trigger a refresh of the cached CellInfo by invoking this API. Instead, those apps
* will receive the latest cached results, which may not be current. Apps targeting
* {@link android.os.Build.VERSION_CODES#Q Android Q} or higher that wish to request updated
* CellInfo should call
* {@link android.telephony.TelephonyManager#requestCellInfoUpdate requestCellInfoUpdate()};
* however, in all cases, updates will be rate-limited and are not guaranteed. To determine the
* recency of CellInfo data, callers should check
* {@link android.telephony.CellInfo#getTimeStamp CellInfo#getTimeStamp()}.
*
* This method returns valid data for devices with
* {@link android.content.pm.PackageManager#FEATURE_TELEPHONY FEATURE_TELEPHONY}. In cases
* where only partial information is available for a particular CellInfo entry, unavailable
* fields will be reported as {@link android.telephony.CellInfo#UNAVAILABLE}. All reported
* cells will include at least a valid set of technology-specific identification info and a
* power level measurement.
*
* This method is preferred over using {@link
* android.telephony.TelephonyManager#getCellLocation getCellLocation()}.
*
* @return List of {@link android.telephony.CellInfo}; null if cell
* information is unavailable.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public List Applies to the following methods:
* {@link #requestCellInfoUpdate},
* {@link #setPreferredOpportunisticDataSubscription},
* {@link #updateAvailableNetworks},
* requestNumberVerification(),
* setSimPowerStateForSlot(),
*/
@ChangeId
@EnabledAfter(targetSdkVersion = Build.VERSION_CODES.R)
private static final long NULL_TELEPHONY_THROW_NO_CB = 182185642L;
/**
* Requests all available cell information from the current subscription for observed
* camped/registered, serving, and neighboring cells.
*
* Any available results from this request will be provided by calls to
* {@link TelephonyCallback.CellInfoListener#onCellInfoChanged(List) onCellInfoChanged()}
* for each active subscription.
*
* This method returns valid data for devices with
* {@link android.content.pm.PackageManager#FEATURE_TELEPHONY FEATURE_TELEPHONY}. On devices
* that do not implement this feature, the behavior is not reliable.
*
* @param executor the executor on which callback will be invoked.
* @param callback a callback to receive CellInfo.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.ACCESS_FINE_LOCATION)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void requestCellInfoUpdate(
@NonNull @CallbackExecutor Executor executor, @NonNull CellInfoCallback callback) {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
if (Compatibility.isChangeEnabled(NULL_TELEPHONY_THROW_NO_CB)) {
throw new IllegalStateException("Telephony is null");
} else {
return;
}
}
telephony.requestCellInfoUpdate(
getSubId(),
new ICellInfoCallback.Stub() {
@Override
public void onCellInfo(List Any available results from this request will be provided by calls to
* {@link TelephonyCallback.CellInfoListener#onCellInfoChanged(List) onCellInfoChanged()}
* for each active subscription.
*
* This method returns valid data for devices with
* {@link android.content.pm.PackageManager#FEATURE_TELEPHONY FEATURE_TELEPHONY}. On devices
* that do not implement this feature, the behavior is not reliable.
*
* @param workSource the requestor to whom the power consumption for this should be attributed.
* @param executor the executor on which callback will be invoked.
* @param callback a callback to receive CellInfo.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(allOf = {android.Manifest.permission.ACCESS_FINE_LOCATION,
android.Manifest.permission.MODIFY_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void requestCellInfoUpdate(@NonNull WorkSource workSource,
@NonNull @CallbackExecutor Executor executor, @NonNull CellInfoCallback callback) {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
if (Compatibility.isChangeEnabled(NULL_TELEPHONY_THROW_NO_CB)) {
throw new IllegalStateException("Telephony is null");
} else {
return;
}
}
telephony.requestCellInfoUpdateWithWorkSource(
getSubId(),
new ICellInfoCallback.Stub() {
@Override
public void onCellInfo(List
* The default, 0, means invoke onCellInfoChanged when any of the reported
* information changes. Setting the value to INT_MAX(0x7fffffff) means never issue
* A onCellInfoChanged.
*
* @param rateInMillis the rate
*
* @hide
*/
public void setCellInfoListRate(int rateInMillis, int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.setCellInfoListRate(rateInMillis, subId);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
}
/**
* Returns the MMS user agent.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_MESSAGING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_MESSAGING)
public String getMmsUserAgent() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getMmsUserAgent(getSubId());
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Returns the MMS user agent profile URL.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_MESSAGING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_MESSAGING)
public String getMmsUAProfUrl() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getMmsUAProfUrl(getSubId());
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Get the first active portIndex from the corresponding physical slot index.
* @param physicalSlotIndex physical slot index
* @return first active port index or INVALID_PORT_INDEX if no port is active
*/
private int getFirstActivePortIndex(int physicalSlotIndex) {
UiccSlotInfo[] slotInfos = getUiccSlotsInfo();
if (slotInfos != null && physicalSlotIndex >= 0 && physicalSlotIndex < slotInfos.length
&& slotInfos[physicalSlotIndex] != null) {
Optional Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param AID Application id. See ETSI 102.221 and 101.220.
* @return an IccOpenLogicalChannelResponse object.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @deprecated Replaced by {@link #iccOpenLogicalChannel(String, int)}
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@Deprecated
public IccOpenLogicalChannelResponse iccOpenLogicalChannel(String AID) {
return iccOpenLogicalChannel(getSubId(), AID, -1);
}
/**
* Opens a logical channel to the ICC card using the physical slot index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index.
*
* This operation wraps two APDU instructions:
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param slotIndex the physical slot index of the ICC card
* @param aid Application id. See ETSI 102.221 and 101.220.
* @param p2 P2 parameter (described in ISO 7816-4).
* @return an IccOpenLogicalChannelResponse object.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated This API is not compatible on eUICC supporting Multiple Enabled Profile(MEP),
* instead use {@link #iccOpenLogicalChannelByPort(int, int, String, int)}
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@Nullable
@Deprecated
public IccOpenLogicalChannelResponse iccOpenLogicalChannelBySlot(int slotIndex,
@Nullable String aid, int p2) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
IccLogicalChannelRequest request = new IccLogicalChannelRequest();
request.slotIndex = slotIndex;
request.portIndex = getFirstActivePortIndex(slotIndex);
request.aid = aid;
request.p2 = p2;
request.callingPackage = getOpPackageName();
request.binder = new Binder();
return telephony.iccOpenLogicalChannel(request);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Opens a logical channel to the ICC card using the physical slot index and port index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index and port index.
*
* This operation wraps two APDU instructions:
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param AID Application id. See ETSI 102.221 and 101.220.
* @param p2 P2 parameter (described in ISO 7816-4).
* @return an IccOpenLogicalChannelResponse object.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public IccOpenLogicalChannelResponse iccOpenLogicalChannel(String AID, int p2) {
return iccOpenLogicalChannel(getSubId(), AID, p2);
}
/**
* Opens a logical channel to the ICC card.
*
* This operation wraps two APDU instructions:
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param AID Application id. See ETSI 102.221 and 101.220.
* @param p2 P2 parameter (described in ISO 7816-4).
* @return an IccOpenLogicalChannelResponse object.
* @hide
*/
public IccOpenLogicalChannelResponse iccOpenLogicalChannel(int subId, String AID, int p2) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
IccLogicalChannelRequest request = new IccLogicalChannelRequest();
request.subId = subId;
request.callingPackage = getOpPackageName();
request.aid = AID;
request.p2 = p2;
request.binder = new Binder();
return telephony.iccOpenLogicalChannel(request);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Closes a previously opened logical channel to the ICC card using the physical slot index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index.
*
* Input parameters equivalent to TS 27.007 AT+CCHC command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param slotIndex the physical slot index of the ICC card
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @return true if the channel was closed successfully.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated This API is not compatible on eUICC supporting Multiple Enabled Profile(MEP),
* instead use {@link #iccCloseLogicalChannelByPort(int, int, int)}
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@Deprecated
public boolean iccCloseLogicalChannelBySlot(int slotIndex, int channel) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
IccLogicalChannelRequest request = new IccLogicalChannelRequest();
request.slotIndex = slotIndex;
request.portIndex = getFirstActivePortIndex(slotIndex);
request.channel = channel;
return telephony.iccCloseLogicalChannel(request);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
} catch (IllegalStateException ex) {
Rlog.e(TAG, "iccCloseLogicalChannel IllegalStateException", ex);
}
return false;
}
/**
* Closes a previously opened logical channel to the ICC card using the physical slot index and
* port index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index and port index.
*
* Input parameters equivalent to TS 27.007 AT+CCHC command.
*
* @param slotIndex the physical slot index of the ICC card
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
*
* @throws IllegalStateException if the Telephony process is not currently available or modem
* currently can't process this command.
* @throws IllegalArgumentException if invalid arguments are passed.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
public void iccCloseLogicalChannelByPort(int slotIndex, int portIndex, int channel) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
IccLogicalChannelRequest request = new IccLogicalChannelRequest();
request.slotIndex = slotIndex;
request.portIndex = portIndex;
request.channel = channel;
telephony.iccCloseLogicalChannel(request);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
throw ex.rethrowAsRuntimeException();
}
}
/**
* Closes a previously opened logical channel to the ICC card.
*
* Input parameters equivalent to TS 27.007 AT+CCHC command.
* It is strongly recommended that callers of this API should firstly create
* new TelephonyManager instance by calling
* {@link TelephonyManager#createForSubscriptionId(int)}. Failure to do so can result in
* unpredictable and detrimental behavior like callers can end up talking to the wrong SIM card.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @return true if the channel was closed successfully.
* @throws IllegalArgumentException if input parameters are wrong. e.g., invalid channel
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean iccCloseLogicalChannel(int channel) {
try {
return iccCloseLogicalChannel(getSubId(), channel);
} catch (IllegalStateException ex) {
Rlog.e(TAG, "iccCloseLogicalChannel IllegalStateException", ex);
}
return false;
}
/**
* Closes a previously opened logical channel to the ICC card.
*
* Input parameters equivalent to TS 27.007 AT+CCHC command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @return true if the channel was closed successfully.
* @hide
*/
public boolean iccCloseLogicalChannel(int subId, int channel) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
IccLogicalChannelRequest request = new IccLogicalChannelRequest();
request.subId = subId;
request.channel = channel;
return telephony.iccCloseLogicalChannel(request);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
} catch (IllegalStateException ex) {
Rlog.e(TAG, "iccCloseLogicalChannel IllegalStateException", ex);
}
return false;
}
/**
* Transmit an APDU to the ICC card over a logical channel using the physical slot index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index.
*
* Input parameters equivalent to TS 27.007 AT+CGLA command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param slotIndex the physical slot index of the ICC card
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at the end, or null if
* there is an issue connecting to the Telephony service.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated This API is not compatible on eUICC supporting Multiple Enabled Profile(MEP),
* instead use
* {@link #iccTransmitApduLogicalChannelByPort(int, int, int, int, int, int, int, int, String)}
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@Nullable
@Deprecated
public String iccTransmitApduLogicalChannelBySlot(int slotIndex, int channel, int cla,
int instruction, int p1, int p2, int p3, @Nullable String data) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.iccTransmitApduLogicalChannelByPort(slotIndex,
getFirstActivePortIndex(slotIndex), channel, cla, instruction,
p1, p2, p3, data);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Transmit an APDU to the ICC card over a logical channel using the physical slot index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index.
*
* Input parameters equivalent to TS 27.007 AT+CGLA command.
*
* @param slotIndex the physical slot index of the ICC card
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at the end, or null if
* there is an issue connecting to the Telephony service.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@NonNull
public String iccTransmitApduLogicalChannelByPort(int slotIndex, int portIndex, int channel,
int cla, int instruction, int p1, int p2, int p3, @Nullable String data) {
String response;
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
response = telephony.iccTransmitApduLogicalChannelByPort(slotIndex, portIndex,
channel, cla, instruction, p1, p2, p3, data);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
throw ex.rethrowAsRuntimeException();
}
return response;
}
/**
* Transmit an APDU to the ICC card over a logical channel.
*
* Input parameters equivalent to TS 27.007 AT+CGLA command.
*
* It is strongly recommended that callers of this API should firstly create a new
* TelephonyManager instance by calling
* {@link TelephonyManager#createForSubscriptionId(int)}. Failure to do so can result in
* unpredictable and detrimental behavior like callers can end up talking to the wrong SIM card.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at
* the end.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String iccTransmitApduLogicalChannel(int channel, int cla,
int instruction, int p1, int p2, int p3, String data) {
return iccTransmitApduLogicalChannel(getSubId(), channel, cla,
instruction, p1, p2, p3, data);
}
/**
* Transmit an APDU to the ICC card over a logical channel.
*
* Input parameters equivalent to TS 27.007 AT+CGLA command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param channel is the channel id to be closed as returned by a successful
* iccOpenLogicalChannel.
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at
* the end.
* @hide
*/
public String iccTransmitApduLogicalChannel(int subId, int channel, int cla,
int instruction, int p1, int p2, int p3, String data) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.iccTransmitApduLogicalChannel(subId, channel, cla,
instruction, p1, p2, p3, data);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return "";
}
/**
* Transmit an APDU to the ICC card over the basic channel using the physical slot index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index.
*
* Input parameters equivalent to TS 27.007 AT+CSIM command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param slotIndex the physical slot index of the ICC card to target
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at
* the end.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
* @deprecated This API is not compatible on eUICC supporting Multiple Enabled Profile(MEP),
* instead use
* {@link #iccTransmitApduBasicChannelByPort(int, int, int, int, int, int, int, String)}
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@NonNull
@Deprecated
public String iccTransmitApduBasicChannelBySlot(int slotIndex, int cla, int instruction, int p1,
int p2, int p3, @Nullable String data) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.iccTransmitApduBasicChannelByPort(slotIndex,
getFirstActivePortIndex(slotIndex), getOpPackageName(),
cla, instruction, p1, p2, p3, data);
}
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Transmit an APDU to the ICC card over the basic channel using the physical slot index.
*
* Use this method when no subscriptions are available on the SIM and the operation must be
* performed using the physical slot index.
*
* Input parameters equivalent to TS 27.007 AT+CSIM command.
*
* @param slotIndex the physical slot index of the ICC card to target
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at
* the end.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@NonNull
public String iccTransmitApduBasicChannelByPort(int slotIndex, int portIndex, int cla,
int instruction, int p1, int p2, int p3, @Nullable String data) {
String response;
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
response = telephony.iccTransmitApduBasicChannelByPort(slotIndex, portIndex,
getOpPackageName(), cla, instruction, p1, p2, p3, data);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
throw ex.rethrowAsRuntimeException();
}
return response;
}
/**
* Transmit an APDU to the ICC card over the basic channel.
*
* Input parameters equivalent to TS 27.007 AT+CSIM command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at
* the end.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String iccTransmitApduBasicChannel(int cla,
int instruction, int p1, int p2, int p3, String data) {
return iccTransmitApduBasicChannel(getSubId(), cla,
instruction, p1, p2, p3, data);
}
/**
* Transmit an APDU to the ICC card over the basic channel.
*
* Input parameters equivalent to TS 27.007 AT+CSIM command.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param cla Class of the APDU command.
* @param instruction Instruction of the APDU command.
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU
* is sent to the SIM.
* @param data Data to be sent with the APDU.
* @return The APDU response from the ICC card with the status appended at
* the end.
* @hide
*/
public String iccTransmitApduBasicChannel(int subId, int cla,
int instruction, int p1, int p2, int p3, String data) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.iccTransmitApduBasicChannel(subId, getOpPackageName(), cla,
instruction, p1, p2, p3, data);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return "";
}
/**
* Returns the response APDU for a command APDU sent through SIM_IO.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param fileID
* @param command
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command.
* @param filePath
* @return The APDU response.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public byte[] iccExchangeSimIO(int fileID, int command, int p1, int p2, int p3,
String filePath) {
return iccExchangeSimIO(getSubId(), fileID, command, p1, p2, p3, filePath);
}
/**
* Returns the response APDU for a command APDU sent through SIM_IO.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param fileID
* @param command
* @param p1 P1 value of the APDU command.
* @param p2 P2 value of the APDU command.
* @param p3 P3 value of the APDU command.
* @param filePath
* @return The APDU response.
* @hide
*/
public byte[] iccExchangeSimIO(int subId, int fileID, int command, int p1, int p2,
int p3, String filePath) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.iccExchangeSimIO(subId, fileID, command, p1, p2, p3, filePath);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return null;
}
/**
* Send ENVELOPE to the SIM and return the response.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param content String containing SAT/USAT response in hexadecimal
* format starting with command tag. See TS 102 223 for
* details.
* @return The APDU response from the ICC card in hexadecimal format
* with the last 4 bytes being the status word. If the command fails,
* returns an empty string.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String sendEnvelopeWithStatus(String content) {
return sendEnvelopeWithStatus(getSubId(), content);
}
/**
* Send ENVELOPE to the SIM and return the response.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param content String containing SAT/USAT response in hexadecimal
* format starting with command tag. See TS 102 223 for
* details.
* @return The APDU response from the ICC card in hexadecimal format
* with the last 4 bytes being the status word. If the command fails,
* returns an empty string.
* @hide
*/
public String sendEnvelopeWithStatus(int subId, String content) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.sendEnvelopeWithStatus(subId, content);
} catch (RemoteException ex) {
} catch (NullPointerException ex) {
}
return "";
}
/**
* Read one of the NV items defined in com.android.internal.telephony.RadioNVItems.
* Used for device configuration by some CDMA operators.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param itemID the ID of the item to read.
* @return the NV item as a String, or null on any failure.
*
* @hide
*/
@UnsupportedAppUsage
public String nvReadItem(int itemID) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.nvReadItem(itemID);
} catch (RemoteException ex) {
Rlog.e(TAG, "nvReadItem RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "nvReadItem NPE", ex);
}
return "";
}
/**
* Write one of the NV items defined in com.android.internal.telephony.RadioNVItems.
* Used for device configuration by some CDMA operators.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param itemID the ID of the item to read.
* @param itemValue the value to write, as a String.
* @return true on success; false on any failure.
*
* @hide
*/
public boolean nvWriteItem(int itemID, String itemValue) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.nvWriteItem(itemID, itemValue);
} catch (RemoteException ex) {
Rlog.e(TAG, "nvWriteItem RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "nvWriteItem NPE", ex);
}
return false;
}
/**
* Update the CDMA Preferred Roaming List (PRL) in the radio NV storage.
* Used for device configuration by some CDMA operators.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param preferredRoamingList byte array containing the new PRL.
* @return true on success; false on any failure.
*
* @hide
*/
public boolean nvWriteCdmaPrl(byte[] preferredRoamingList) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.nvWriteCdmaPrl(preferredRoamingList);
} catch (RemoteException ex) {
Rlog.e(TAG, "nvWriteCdmaPrl RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "nvWriteCdmaPrl NPE", ex);
}
return false;
}
/**
* Perform the specified type of NV config reset. The radio will be taken offline
* and the device must be rebooted after the operation. Used for device
* configuration by some CDMA operators.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* TODO: remove this one. use {@link #rebootModem()} for reset type 1 and
* {@link #resetRadioConfig()} for reset type 3 (b/116476729)
*
* @param resetType reset type: 1: reload NV reset, 2: erase NV reset, 3: factory NV reset
* @return true on success; false on any failure.
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public boolean nvResetConfig(int resetType) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
if (resetType == 1 /*1: reload NV reset */) {
return telephony.rebootModem(getSlotIndex());
} else if (resetType == 3 /*3: factory NV reset */) {
return telephony.resetModemConfig(getSlotIndex());
} else {
Rlog.e(TAG, "nvResetConfig unsupported reset type");
}
}
} catch (RemoteException ex) {
Rlog.e(TAG, "nvResetConfig RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "nvResetConfig NPE", ex);
}
return false;
}
/**
* Rollback modem configurations to factory default except some config which are in allowlist.
* Used for device configuration by some carriers.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return {@code true} on success; {@code false} on any failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean resetRadioConfig() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.resetModemConfig(getSlotIndex());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "resetRadioConfig RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "resetRadioConfig NPE", ex);
}
return false;
}
/**
* Generate a radio modem reset. Used for device configuration by some carriers.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return {@code true} on success; {@code false} on any failure.
*
* @deprecated Using {@link #rebootModem()} instead.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean rebootRadio() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.rebootModem(getSlotIndex());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "rebootRadio RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "rebootRadio NPE", ex);
}
return false;
}
/**
* Generate a radio modem reset. Used for device configuration by some carriers.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws RuntimeException
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void rebootModem() {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
throw new IllegalStateException("telephony service is null.");
}
telephony.rebootModem(getSlotIndex());
} catch (RemoteException ex) {
Rlog.e(TAG, "rebootRadio RemoteException", ex);
throw ex.rethrowAsRuntimeException();
}
}
/**
* Return an appropriate subscription ID for any situation.
*
* If this object has been created with {@link #createForSubscriptionId}, then the provided
* subscription ID is returned. Otherwise, the default subscription ID will be returned.
*
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int getSubscriptionId() {
return getSubId();
}
/**
* Return an appropriate subscription ID for any situation.
*
* If this object has been created with {@link #createForSubscriptionId}, then the provided
* subscription ID is returned. Otherwise, the default subscription ID will be returned.
*
*/
private int getSubId() {
if (SubscriptionManager.isUsableSubIdValue(mSubId)) {
return mSubId;
}
return SubscriptionManager.getDefaultSubscriptionId();
}
/**
* Return an appropriate subscription ID for any situation.
*
* If this object has been created with {@link #createForSubscriptionId}, then the provided
* subId is returned. Otherwise, the preferred subId which is based on caller's context is
* returned.
* {@see SubscriptionManager#getDefaultDataSubscriptionId()}
* {@see SubscriptionManager#getDefaultVoiceSubscriptionId()}
* {@see SubscriptionManager#getDefaultSmsSubscriptionId()}
*/
@UnsupportedAppUsage
private int getSubId(int preferredSubId) {
if (SubscriptionManager.isUsableSubIdValue(mSubId)) {
return mSubId;
}
return preferredSubId;
}
/**
* Return an appropriate phone ID for any situation.
*
* If this object has been created with {@link #createForSubscriptionId}, then the phoneId
* associated with the provided subId is returned. Otherwise, the default phoneId associated
* with the default subId will be returned.
*/
private int getPhoneId() {
return SubscriptionManager.getPhoneId(getSubId());
}
/**
* Return an appropriate phone ID for any situation.
*
* If this object has been created with {@link #createForSubscriptionId}, then the phoneId
* associated with the provided subId is returned. Otherwise, return the phoneId associated
* with the preferred subId based on caller's context.
* {@see SubscriptionManager#getDefaultDataSubscriptionId()}
* {@see SubscriptionManager#getDefaultVoiceSubscriptionId()}
* {@see SubscriptionManager#getDefaultSmsSubscriptionId()}
*/
@UnsupportedAppUsage
private int getPhoneId(int preferredSubId) {
return SubscriptionManager.getPhoneId(getSubId(preferredSubId));
}
/**
* Return an appropriate slot index for any situation.
*
* if this object has been created with {@link #createForSubscriptionId}, then the slot index
* associated with the provided subId is returned. Otherwise, return the slot index associated
* with the default subId.
* If SIM is not inserted, return default SIM slot index.
*
* {@hide}
*/
@VisibleForTesting
@UnsupportedAppUsage
public int getSlotIndex() {
int slotIndex = SubscriptionManager.getSlotIndex(getSubId());
if (slotIndex == SubscriptionManager.SIM_NOT_INSERTED) {
slotIndex = SubscriptionManager.DEFAULT_SIM_SLOT_INDEX;
}
return slotIndex;
}
/**
* Request that the next incoming call from a number matching {@code range} be intercepted.
*
* This API is intended for OEMs to provide a service for apps to verify the device's phone
* number. When called, the Telephony stack will store the provided {@link PhoneNumberRange} and
* intercept the next incoming call from a number that lies within the range, within a timeout
* specified by {@code timeoutMillis}.
*
* If such a phone call is received, the caller will be notified via
* {@link NumberVerificationCallback#onCallReceived(String)} on the provided {@link Executor}.
* If verification fails for any reason, the caller will be notified via
* {@link NumberVerificationCallback#onVerificationFailed(int)}
* on the provided {@link Executor}.
*
* In addition to the {@link Manifest.permission#MODIFY_PHONE_STATE} permission, callers of this
* API must also be listed in the device configuration as an authorized app in
* {@code packages/services/Telephony/res/values/config.xml} under the
* {@code platform_number_verification_package} key.
*
* @hide
* @param range The range of phone numbers the caller expects a phone call from.
* @param timeoutMillis The amount of time to wait for such a call, or the value of
* {@link #getMaxNumberVerificationTimeoutMillis()}, whichever is lesser.
* @param executor The {@link Executor} that callbacks should be executed on.
* @param callback The callback to use for delivering results.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@SystemApi
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void requestNumberVerification(@NonNull PhoneNumberRange range, long timeoutMillis,
@NonNull @CallbackExecutor Executor executor,
@NonNull NumberVerificationCallback callback) {
if (executor == null) {
throw new NullPointerException("Executor must be non-null");
}
if (callback == null) {
throw new NullPointerException("Callback must be non-null");
}
INumberVerificationCallback internalCallback = new INumberVerificationCallback.Stub() {
@Override
public void onCallReceived(String phoneNumber) {
final long identity = Binder.clearCallingIdentity();
try {
executor.execute(() ->
callback.onCallReceived(phoneNumber));
} finally {
Binder.restoreCallingIdentity(identity);
}
}
@Override
public void onVerificationFailed(int reason) {
final long identity = Binder.clearCallingIdentity();
try {
executor.execute(() ->
callback.onVerificationFailed(reason));
} finally {
Binder.restoreCallingIdentity(identity);
}
}
};
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
if (Compatibility.isChangeEnabled(NULL_TELEPHONY_THROW_NO_CB)) {
throw new IllegalStateException("Telephony is null");
} else {
return;
}
}
telephony.requestNumberVerification(range, timeoutMillis, internalCallback,
getOpPackageName());
} catch (RemoteException ex) {
Rlog.e(TAG, "requestNumberVerification RemoteException", ex);
runOnBackgroundThread(() -> executor.execute(
() -> callback.onVerificationFailed(
NumberVerificationCallback.REASON_UNSPECIFIED)));
}
}
/**
* Inserts or updates a list property. Expands the list if its length is not enough.
*/
private static
* This version does not take a default value. If the setting has not
* been set, or the string value is not a number,
* it throws {@link SettingNotFoundException}.
*
* @param cr The ContentResolver to access.
* @param name The name of the setting to retrieve.
* @param index The index of the list
*
* @throws SettingNotFoundException Thrown if a setting by the given
* name can't be found or the setting value is not an integer.
*
* @return The value at the given index of settings.
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static int getIntAtIndex(android.content.ContentResolver cr,
String name, int index)
throws android.provider.Settings.SettingNotFoundException {
String v = android.provider.Settings.Global.getString(cr, name);
if (v != null) {
String valArray[] = v.split(",");
if ((index >= 0) && (index < valArray.length) && (valArray[index] != null)) {
try {
return Integer.parseInt(valArray[index]);
} catch (NumberFormatException e) {
//Log.e(TAG, "Exception while parsing Integer: ", e);
}
}
}
throw new android.provider.Settings.SettingNotFoundException(name);
}
/**
* Convenience function for updating settings value as coma separated
* integer values. This will either create a new entry in the table if the
* given name does not exist, or modify the value of the existing row
* with that name. Note that internally setting values are always
* stored as strings, so this function converts the given value to a
* string before storing it.
*
* @param cr The ContentResolver to access.
* @param name The name of the setting to modify.
* @param index The index of the list
* @param value The new value for the setting to be added to the list.
* @return true if the value was set, false on database errors
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static boolean putIntAtIndex(android.content.ContentResolver cr,
String name, int index, int value) {
String data = "";
String valArray[] = null;
String v = android.provider.Settings.Global.getString(cr, name);
if (index == Integer.MAX_VALUE) {
throw new IllegalArgumentException("putIntAtIndex index == MAX_VALUE index=" + index);
}
if (index < 0) {
throw new IllegalArgumentException("putIntAtIndex index < 0 index=" + index);
}
if (v != null) {
valArray = v.split(",");
}
// Copy the elements from valArray till index
for (int i = 0; i < index; i++) {
String str = "";
if ((valArray != null) && (i < valArray.length)) {
str = valArray[i];
}
data = data + str + ",";
}
data = data + value;
// Copy the remaining elements from valArray if any.
if (valArray != null) {
for (int i = index+1; i < valArray.length; i++) {
data = data + "," + valArray[i];
}
}
return android.provider.Settings.Global.putString(cr, name, data);
}
/**
* Gets a per-phone telephony property from a property name.
*
* @hide
*/
@UnsupportedAppUsage
public static String getTelephonyProperty(int phoneId, String property, String defaultVal) {
String propVal = null;
String prop = SystemProperties.get(property);
if ((prop != null) && (prop.length() > 0)) {
String values[] = prop.split(",");
if ((phoneId >= 0) && (phoneId < values.length) && (values[phoneId] != null)) {
propVal = values[phoneId];
}
}
return propVal == null ? defaultVal : propVal;
}
/**
* Gets a typed per-phone telephony property from a schematized list property.
*/
private static Requires one of the following permissions:
* See {@link #getIccAuthentication(int, int, String)} for details on the required
* permissions.
*
* @param subId subscription ID used for authentication
* @param appType the icc application type, like {@link #APPTYPE_USIM}
* @param authType the authentication type, any one of {@link #AUTHTYPE_EAP_AKA} or
* {@link #AUTHTYPE_EAP_SIM} or {@link #AUTHTYPE_GBA_BOOTSTRAP} or
* {@link #AUTHTYPE_GBA_NAF_KEY_EXTERNAL}
* @param data authentication challenge data, base64 encoded.
* See 3GPP TS 31.102 7.1.2 for more details.
* @return the response of authentication. This value will be null in the following cases only
* (see 3GPP TS 31.102 7.3.1):
* Authentication error, incorrect MAC
* Authentication error, security context not supported
* Key freshness failure
* Authentication error, no memory space available
* Authentication error, no memory space available in EFMUK
* @hide
*/
@UnsupportedAppUsage
public String getIccAuthentication(int subId, int appType,@AuthType int authType, String data) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getIccSimChallengeResponse(subId, appType, authType, data,
getOpPackageName(), getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone starts
return null;
}
}
/**
* Returns an array of Forbidden PLMNs from the USIM App
* Returns null if the query fails.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return an array of forbidden PLMNs or null if not available
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String[] getForbiddenPlmns() {
return getForbiddenPlmns(getSubId(), APPTYPE_USIM);
}
/**
* Returns an array of Forbidden PLMNs from the specified SIM App
* Returns null if the query fails.
*
* @param subId subscription ID used for authentication
* @param appType the icc application type, like {@link #APPTYPE_USIM}
* @return fplmns an array of forbidden PLMNs
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
public String[] getForbiddenPlmns(int subId, int appType) {
try {
ITelephony telephony = getITelephony();
if (telephony == null)
return null;
return telephony.getForbiddenPlmns(subId, appType, mContext.getOpPackageName(),
getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone starts
return null;
}
}
/**
* Replace the contents of the forbidden PLMN SIM file with the provided values.
* Passing an empty list will clear the contents of the EFfplmn file.
* If the provided list is shorter than the size of EFfplmn, then the list will be padded
* up to the file size with 'FFFFFF'. (required by 3GPP TS 31.102 spec 4.2.16)
* If the list is longer than the size of EFfplmn, then the file will be written from the
* beginning of the list up to the file size.
*
* Requires Permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE
* MODIFY_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param fplmns a list of PLMNs to be forbidden.
*
* @return number of PLMNs that were successfully written to the SIM FPLMN list.
* This may be less than the number of PLMNs passed in where the SIM file does not have enough
* room for all of the values passed in. Return -1 in the event of an unexpected failure
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int setForbiddenPlmns(@NonNull List This constant is used in case of nothing is set in
* TelephonyProperties#default_network().
*
* @hide
*/
public static final int DEFAULT_PREFERRED_NETWORK_MODE =
RILConstants.PREFERRED_NETWORK_MODE;
/**
* Get the preferred network type.
* Used for device configuration by some CDMA operators.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return the preferred network type.
* @hide
* @deprecated Use {@link #getAllowedNetworkTypesBitmask} instead.
*/
@Deprecated
@RequiresPermission((android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE))
@UnsupportedAppUsage
public @PrefNetworkMode int getPreferredNetworkType(int subId) {
return RadioAccessFamily.getNetworkTypeFromRaf((int) getAllowedNetworkTypesBitmask());
}
/**
* Get the preferred network type bitmask.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return The bitmask of preferred network types.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
* @deprecated Use {@link #getAllowedNetworkTypesBitmask} instead.
*/
@Deprecated
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NetworkTypeBitMask long getPreferredNetworkTypeBitmask() {
return getAllowedNetworkTypesBitmask();
}
/**
* Get the allowed network type bitmask.
* Note that the device can only register on the network of {@link NetworkTypeBitmask}
* (except for emergency call cases).
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return The bitmask of allowed network types.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NetworkTypeBitMask long getAllowedNetworkTypesBitmask() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return (long) telephony.getAllowedNetworkTypesBitmask(getSubId());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getAllowedNetworkTypesBitmask RemoteException", ex);
}
return 0;
}
/**
* Get the allowed network types by carriers.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return the allowed network type bitmask
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
* @deprecated Use {@link #getAllowedNetworkTypesForReason} instead.
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
@SystemApi
@Deprecated
public @NetworkTypeBitMask long getAllowedNetworkTypes() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getAllowedNetworkTypesForReason(getSubId(),
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_CARRIER);
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getAllowedNetworkTypes RemoteException", ex);
}
return -1;
}
/**
* Sets the network selection mode to automatic.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void setNetworkSelectionModeAutomatic() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setNetworkSelectionModeAutomatic(getSubId());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setNetworkSelectionModeAutomatic RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "setNetworkSelectionModeAutomatic NPE", ex);
}
}
/**
* Perform a radio scan and return the list of available networks.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Note that this scan can take a long time (sometimes minutes) to happen.
*
* Requires Permissions:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the calling app has carrier
* privileges (see {@link #hasCarrierPrivileges})
* and {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}.
*
* @return {@link CellNetworkScanResult} with the status
* {@link CellNetworkScanResult#STATUS_SUCCESS} and a list of
* {@link com.android.internal.telephony.OperatorInfo} if it's available. Otherwise, the failure
* caused will be included in the result.
*
* @hide
*/
@RequiresPermission(allOf = {
android.Manifest.permission.MODIFY_PHONE_STATE,
Manifest.permission.ACCESS_COARSE_LOCATION
})
public CellNetworkScanResult getAvailableNetworks() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getCellNetworkScanResults(getSubId(), getOpPackageName(),
getAttributionTag());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getAvailableNetworks RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "getAvailableNetworks NPE", ex);
}
return new CellNetworkScanResult(
CellNetworkScanResult.STATUS_UNKNOWN_ERROR, null /* OperatorInfo */);
}
/**
* Request a network scan.
*
* This method is asynchronous, so the network scan results will be returned by callback.
* The returned NetworkScan will contain a callback method which can be used to stop the scan.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges})
* and {@link android.Manifest.permission#ACCESS_FINE_LOCATION}.
*
* If the system-wide location switch is off, apps may still call this API, with the
* following constraints:
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges})
* and {@link android.Manifest.permission#ACCESS_FINE_LOCATION} if includeLocationData is
* set to {@link #INCLUDE_LOCATION_DATA_FINE}.
*
* If the system-wide location switch is off, apps may still call this API, with the
* following constraints:
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param operatorNumeric the PLMN ID of the network to select.
* @param persistSelection whether the selection will persist until reboot. If true, only allows
* attaching to the selected PLMN until reboot; otherwise, attach to the chosen PLMN and resume
* normal network selection next time.
* @return {@code true} on success; {@code false} on any failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean setNetworkSelectionModeManual(String operatorNumeric, boolean persistSelection) {
return setNetworkSelectionModeManual(
new OperatorInfo(
"" /* operatorAlphaLong */, "" /* operatorAlphaShort */, operatorNumeric),
persistSelection);
}
/**
* Ask the radio to connect to the input network and change selection mode to manual.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param operatorNumeric the PLMN ID of the network to select.
* @param persistSelection whether the selection will persist until reboot.
* If true, only allows attaching to the selected PLMN until reboot; otherwise,
* attach to the chosen PLMN and resume normal network selection next time.
* @param ran the initial suggested radio access network type.
* If registration fails, the RAN is not available after, the RAN is not within the
* network types specified by the preferred network types, or the value is
* {@link AccessNetworkConstants.AccessNetworkType#UNKNOWN}, modem will select
* the next best RAN for network registration.
* @return {@code true} on success; {@code false} on any failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean setNetworkSelectionModeManual(@NonNull String operatorNumeric,
boolean persistSelection, @AccessNetworkConstants.RadioAccessNetworkType int ran) {
return setNetworkSelectionModeManual(new OperatorInfo("" /* operatorAlphaLong */,
"" /* operatorAlphaShort */, operatorNumeric, ran), persistSelection);
}
/**
* Ask the radio to connect to the input network and change selection mode to manual.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param operatorInfo included the PLMN id, long name, short name of the operator to attach to.
* @param persistSelection whether the selection will persist until reboot. If true, only allows
* attaching to the selected PLMN until reboot; otherwise, attach to the chosen PLMN and resume
* normal network selection next time.
* @return {@code true} on success; {@code true} on any failure.
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public boolean setNetworkSelectionModeManual(
OperatorInfo operatorInfo, boolean persistSelection) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.setNetworkSelectionModeManual(
getSubId(), operatorInfo, persistSelection);
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setNetworkSelectionModeManual RemoteException", ex);
}
return false;
}
/**
* Get the network selection mode.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
* Requires Permission: {@link android.Manifest.permission#READ_PRECISE_PHONE_STATE
* READ_PRECISE_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return the network selection mode.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // No support for carrier privileges (b/72967236).
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PRECISE_PHONE_STATE
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NetworkSelectionMode int getNetworkSelectionMode() {
int mode = NETWORK_SELECTION_MODE_UNKNOWN;
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
mode = telephony.getNetworkSelectionMode(getSubId());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getNetworkSelectionMode RemoteException", ex);
}
return mode;
}
/**
* Get the PLMN chosen for Manual Network Selection if active.
* Return empty string if in automatic selection.
*
* Requires Permission: {@link android.Manifest.permission#READ_PRECISE_PHONE_STATE
* READ_PRECISE_PHONE_STATE} or that the calling app has carrier privileges
* (see {@link #hasCarrierPrivileges})
*
* @return manually selected network info on success or empty string on failure
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // No support carrier privileges (b/72967236).
@RequiresPermission(android.Manifest.permission.READ_PRECISE_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NonNull String getManualNetworkSelectionPlmn() {
try {
ITelephony telephony = getITelephony();
if (telephony != null && isManualNetworkSelectionAllowed()) {
return telephony.getManualNetworkSelectionPlmn(getSubId());
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getManualNetworkSelectionPlmn RemoteException", ex);
}
return "";
}
/**
* Query Telephony to see if there has recently been an emergency SMS sent to the network by the
* user and we are still within the time interval after the emergency SMS was sent that we are
* considered in Emergency SMS mode.
*
* This mode is used by other applications to allow them to perform special functionality,
* such as allow the GNSS service to provide user location to the carrier network for emergency
* when an emergency SMS is sent. This interval is set by
* {@link CarrierConfigManager#KEY_EMERGENCY_SMS_MODE_TIMER_MS_INT}. If
* the carrier does not support this mode, this function will always return false.
*
* @return {@code true} if this device is in emergency SMS mode, {@code false} otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_MESSAGING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_MESSAGING)
public boolean isInEmergencySmsMode() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isInEmergencySmsMode();
}
} catch (RemoteException ex) {
Rlog.e(TAG, "isInEmergencySmsMode RemoteException", ex);
}
return false;
}
/**
* Set the preferred network type.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* If {@link android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported}
* ({@link TelephonyManager#CAPABILITY_USES_ALLOWED_NETWORK_TYPES_BITMASK}) returns true, then
* setAllowedNetworkTypesBitmap is used on the radio interface. Otherwise,
* setPreferredNetworkTypesBitmap is used instead.
*
* @param subId the id of the subscription to set the preferred network type for.
* @param networkType the preferred network type
* @return true on success; false on any failure.
* @hide
* @deprecated Use {@link #setAllowedNetworkTypesForReason} instead.
*/
@Deprecated
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public boolean setPreferredNetworkType(int subId, @PrefNetworkMode int networkType) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.setAllowedNetworkTypesForReason(subId,
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_USER,
RadioAccessFamily.getRafFromNetworkType(networkType));
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setPreferredNetworkType RemoteException", ex);
}
return false;
}
/**
* Set the preferred network type bitmask but if {@link #setAllowedNetworkTypes} has been set,
* only the allowed network type will set to the modem.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* If {@link android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported}
* ({@link TelephonyManager#CAPABILITY_USES_ALLOWED_NETWORK_TYPES_BITMASK}) returns true, then
* setAllowedNetworkTypesBitmap is used on the radio interface. Otherwise,
* setPreferredNetworkTypesBitmap is used instead.
*
* @param networkTypeBitmask The bitmask of preferred network types.
* @return true on success; false on any failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
* @deprecated Use {@link #setAllowedNetworkTypesForReason} instead.
*/
@Deprecated
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
@SystemApi
public boolean setPreferredNetworkTypeBitmask(@NetworkTypeBitMask long networkTypeBitmask) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
networkTypeBitmask = checkNetworkTypeBitmask(networkTypeBitmask);
return telephony.setAllowedNetworkTypesForReason(getSubId(),
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_USER, networkTypeBitmask);
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setPreferredNetworkTypeBitmask RemoteException", ex);
}
return false;
}
/**
* If {@link #NETWORK_TYPE_BITMASK_LTE_CA} bit is set, convert it to NETWORK_TYPE_BITMASK_LTE.
*
* @param networkTypeBitmask The networkTypeBitmask being checked
* @return The checked/converted networkTypeBitmask
*/
private long checkNetworkTypeBitmask(@NetworkTypeBitMask long networkTypeBitmask) {
if ((networkTypeBitmask & NETWORK_TYPE_BITMASK_LTE_CA) != 0) {
networkTypeBitmask ^= NETWORK_TYPE_BITMASK_LTE_CA;
networkTypeBitmask |= NETWORK_TYPE_BITMASK_LTE;
}
return networkTypeBitmask;
}
/**
* Set the allowed network types of the device. This is for carrier or privileged apps to
* enable/disable certain network types on the device. The user preferred network types should
* be set through {@link #setPreferredNetworkTypeBitmask}.
*
* If {@link android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported}
* ({@link TelephonyManager#CAPABILITY_USES_ALLOWED_NETWORK_TYPES_BITMASK}) returns true, then
* setAllowedNetworkTypesBitmap is used on the radio interface. Otherwise,
* setPreferredNetworkTypesBitmap is used instead.
*
* @param allowedNetworkTypes The bitmask of allowed network types.
* @return true on success; false on any failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*
* @hide
* @deprecated Use {@link #setAllowedNetworkTypesForReason} instead with reason
* {@link #ALLOWED_NETWORK_TYPES_REASON_CARRIER}.
*/
@Deprecated
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(
enforcement = "android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported",
value = TelephonyManager.CAPABILITY_USES_ALLOWED_NETWORK_TYPES_BITMASK)
@SystemApi
public boolean setAllowedNetworkTypes(@NetworkTypeBitMask long allowedNetworkTypes) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
allowedNetworkTypes = checkNetworkTypeBitmask(allowedNetworkTypes);
return telephony.setAllowedNetworkTypesForReason(getSubId(),
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_CARRIER, allowedNetworkTypes);
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setAllowedNetworkTypes RemoteException", ex);
}
return false;
}
/** @hide */
@IntDef({
ALLOWED_NETWORK_TYPES_REASON_USER,
ALLOWED_NETWORK_TYPES_REASON_POWER,
ALLOWED_NETWORK_TYPES_REASON_CARRIER,
ALLOWED_NETWORK_TYPES_REASON_ENABLE_2G,
})
@Retention(RetentionPolicy.SOURCE)
public @interface AllowedNetworkTypesReason {
}
/**
* To indicate allowed network type change is requested by user.
*/
public static final int ALLOWED_NETWORK_TYPES_REASON_USER = 0;
/**
* To indicate allowed network type change is requested by power manager.
* Power Manger configuration won't affect the settings configured through
* other reasons and will result in allowing network types that are in both
* configurations (i.e intersection of both sets).
*
* @hide
*/
@SystemApi
public static final int ALLOWED_NETWORK_TYPES_REASON_POWER = 1;
/**
* To indicate allowed network type change is requested by carrier.
* Carrier configuration won't affect the settings configured through
* other reasons and will result in allowing network types that are in both
* configurations (i.e intersection of both sets).
*/
public static final int ALLOWED_NETWORK_TYPES_REASON_CARRIER = 2;
/**
* To indicate allowed network type change is requested by the user via the 2G toggle.
*
* @hide
*/
@SystemApi
public static final int ALLOWED_NETWORK_TYPES_REASON_ENABLE_2G = 3;
/**
* Set the allowed network types of the device and provide the reason triggering the allowed
* network change.
* Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or
* that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* This can be called for following reasons:
* Requires permission: android.Manifest.READ_PRIVILEGED_PHONE_STATE or
* that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param reason the reason the allowed network type change is taking place
* @return the allowed network type bitmask
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws IllegalArgumentException if invalid AllowedNetworkTypesReason is passed.
* @throws SecurityException if the caller does not have the required permission/privileges
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(
enforcement = "android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported",
value = TelephonyManager.CAPABILITY_USES_ALLOWED_NETWORK_TYPES_BITMASK)
public @NetworkTypeBitMask long getAllowedNetworkTypesForReason(
@AllowedNetworkTypesReason int reason) {
if (!isValidAllowedNetworkTypesReason(reason)) {
throw new IllegalArgumentException("invalid AllowedNetworkTypesReason.");
}
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getAllowedNetworkTypesForReason(getSubId(), reason);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getAllowedNetworkTypesForReason RemoteException", ex);
ex.rethrowFromSystemServer();
}
return -1;
}
/**
* Verifies that the reason provided is valid.
* @hide
*/
public static boolean isValidAllowedNetworkTypesReason(@AllowedNetworkTypesReason int reason) {
switch (reason) {
case TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_USER:
case TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_POWER:
case TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_CARRIER:
case TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_ENABLE_2G:
return true;
}
return false;
}
/**
* Get bit mask of all network types.
*
* @return bit mask of all network types
* @hide
*/
public static @NetworkTypeBitMask long getAllNetworkTypesBitmask() {
return NETWORK_STANDARDS_FAMILY_BITMASK_3GPP | NETWORK_STANDARDS_FAMILY_BITMASK_3GPP2;
}
/**
* Returns a string representation of the allowed network types{@link NetworkTypeBitMask}.
*
* @param networkTypeBitmask The bitmask of allowed network types.
* @return the name of the allowed network types
* @hide
*/
public static String convertNetworkTypeBitmaskToString(
@NetworkTypeBitMask long networkTypeBitmask) {
String networkTypeName = IntStream.rangeClosed(NETWORK_TYPE_GPRS, NETWORK_TYPE_NR)
.filter(x -> {
return (networkTypeBitmask & getBitMaskForNetworkType(x))
== getBitMaskForNetworkType(x);
})
.mapToObj(x -> getNetworkTypeName(x))
.collect(Collectors.joining("|"));
return TextUtils.isEmpty(networkTypeName) ? "UNKNOWN" : networkTypeName;
}
/**
* Set the preferred network type to global mode which includes NR, LTE, CDMA, EvDo
* and GSM/WCDMA.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return true on success; false on any failure.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean setPreferredNetworkTypeToGlobal() {
return setPreferredNetworkTypeToGlobal(getSubId());
}
/**
* Set the preferred network type to global mode which includes NR, LTE, CDMA, EvDo
* and GSM/WCDMA.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return true on success; false on any failure.
* @hide
*/
public boolean setPreferredNetworkTypeToGlobal(int subId) {
return setPreferredNetworkType(subId, RILConstants.NETWORK_MODE_NR_LTE_CDMA_EVDO_GSM_WCDMA);
}
/**
* Check whether DUN APN is required for tethering.
*
* Requires Permission: MODIFY_PHONE_STATE.
*
* @return {@code true} if DUN APN is required for tethering.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isTetheringApnRequired() {
return isTetheringApnRequired(getSubId(SubscriptionManager.getActiveDataSubscriptionId()));
}
/**
* Check whether DUN APN is required for tethering with subId.
*
* @param subId the id of the subscription to require tethering.
* @return {@code true} if DUN APN is required for tethering.
* @hide
*/
public boolean isTetheringApnRequired(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.isTetheringApnRequiredForSubscriber(subId);
} catch (RemoteException ex) {
Rlog.e(TAG, "hasMatchedTetherApnSetting RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "hasMatchedTetherApnSetting NPE", ex);
}
return false;
}
/**
* Values used to return status for hasCarrierPrivileges call.
*/
/** @hide */ @SystemApi
public static final int CARRIER_PRIVILEGE_STATUS_HAS_ACCESS = 1;
/** @hide */ @SystemApi
public static final int CARRIER_PRIVILEGE_STATUS_NO_ACCESS = 0;
/** @hide */ @SystemApi
public static final int CARRIER_PRIVILEGE_STATUS_RULES_NOT_LOADED = -1;
/** @hide */ @SystemApi
public static final int CARRIER_PRIVILEGE_STATUS_ERROR_LOADING_RULES = -2;
/**
* Has the calling application been granted carrier privileges by the carrier.
*
* If any of the packages in the calling UID has carrier privileges, the
* call will return true. This access is granted by the owner of the UICC
* card and does not depend on the registered carrier.
*
* Note that this API applies to both physical and embedded subscriptions and
* is a superset of the checks done in SubscriptionManager#canManageSubscription.
*
* @return true if the app has carrier privileges.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean hasCarrierPrivileges() {
return hasCarrierPrivileges(getSubId());
}
/**
* Has the calling application been granted carrier privileges by the carrier.
*
* If any of the packages in the calling UID has carrier privileges, the
* call will return true. This access is granted by the owner of the UICC
* card and does not depend on the registered carrier.
*
* Note that this API applies to both physical and embedded subscriptions and
* is a superset of the checks done in SubscriptionManager#canManageSubscription.
*
* @param subId The subscription to use.
* @return true if the app has carrier privileges.
* @hide
*/
public boolean hasCarrierPrivileges(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getCarrierPrivilegeStatus(subId)
== CARRIER_PRIVILEGE_STATUS_HAS_ACCESS;
}
} catch (RemoteException ex) {
Rlog.e(TAG, "hasCarrierPrivileges RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "hasCarrierPrivileges NPE", ex);
}
return false;
}
/**
* Override the branding for the current ICCID.
*
* Once set, whenever the SIM is present in the device, the service
* provider name (SPN) and the operator name will both be replaced by the
* brand value input. To unset the value, the same function should be
* called with a null brand value.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param brand The brand name to display/set.
* @return true if the operation was executed correctly.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean setOperatorBrandOverride(String brand) {
return setOperatorBrandOverride(getSubId(), brand);
}
/**
* Override the branding for the current ICCID.
*
* Once set, whenever the SIM is present in the device, the service
* provider name (SPN) and the operator name will both be replaced by the
* brand value input. To unset the value, the same function should be
* called with a null brand value.
*
* Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param subId The subscription to use.
* @param brand The brand name to display/set.
* @return true if the operation was executed correctly.
* @hide
*/
public boolean setOperatorBrandOverride(int subId, String brand) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.setOperatorBrandOverride(subId, brand);
} catch (RemoteException ex) {
Rlog.e(TAG, "setOperatorBrandOverride RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "setOperatorBrandOverride NPE", ex);
}
return false;
}
/**
* Override the roaming preference for the current ICCID.
*
* Using this call, the carrier app (see #hasCarrierPrivileges) can override
* the platform's notion of a network operator being considered roaming or not.
* The change only affects the ICCID that was active when this call was made.
*
* If null is passed as any of the input, the corresponding value is deleted.
*
* Requires that the caller have carrier privilege. See #hasCarrierPrivileges.
*
* @param gsmRoamingList - List of MCCMNCs to be considered roaming for 3GPP RATs.
* @param gsmNonRoamingList - List of MCCMNCs to be considered not roaming for 3GPP RATs.
* @param cdmaRoamingList - List of SIDs to be considered roaming for 3GPP2 RATs.
* @param cdmaNonRoamingList - List of SIDs to be considered not roaming for 3GPP2 RATs.
* @return true if the operation was executed correctly.
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public boolean setRoamingOverride(List Requires that the caller have carrier privilege. See #hasCarrierPrivileges.
*
* @param subId for which the roaming overrides apply.
* @param gsmRoamingList - List of MCCMNCs to be considered roaming for 3GPP RATs.
* @param gsmNonRoamingList - List of MCCMNCs to be considered not roaming for 3GPP RATs.
* @param cdmaRoamingList - List of SIDs to be considered roaming for 3GPP2 RATs.
* @param cdmaNonRoamingList - List of SIDs to be considered not roaming for 3GPP2 RATs.
* @return true if the operation was executed correctly.
*
* @hide
*/
public boolean setRoamingOverride(int subId, List If this object has been created with {@link #createForSubscriptionId}, then the provided
* subscription ID is used. Otherwise, the default subscription ID will be used.
*
* @return The system-selected package that provides the {@link CarrierService} implementation
* for the current subscription, or {@code null} if none is resolved
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @Nullable String getCarrierServicePackageName() {
return getCarrierServicePackageNameForLogicalSlot(getPhoneId());
}
/**
* Returns the package name that provides the {@link CarrierService} implementation for the
* specified {@code logicalSlotIndex}, or {@code null} if no package with carrier privileges
* declares one.
*
* @param logicalSlotIndex The slot index to fetch the {@link CarrierService} package for
* @return The system-selected package that provides the {@link CarrierService} implementation
* for the slot, or {@code null} if none is resolved
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @Nullable String getCarrierServicePackageNameForLogicalSlot(int logicalSlotIndex) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getCarrierServicePackageNameForLogicalSlot(logicalSlotIndex);
}
} catch (RemoteException ex) {
Rlog.e(TAG, "getCarrierServicePackageNameForLogicalSlot RemoteException", ex);
} catch (NullPointerException ex) {
Rlog.e(TAG, "getCarrierServicePackageNameForLogicalSlot NPE", ex);
}
return null;
}
/** @hide */
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public List If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* @throws IllegalArgumentException if requested state is invalid.
* @throws SecurityException if the caller does not have the permission.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void setCallComposerStatus(@CallComposerStatus int status) {
if (com.android.server.telecom.flags.Flags.businessCallComposer()) {
if (status > CALL_COMPOSER_STATUS_BUSINESS_ONLY
|| status < CALL_COMPOSER_STATUS_OFF) {
throw new IllegalArgumentException("requested status is invalid");
}
} else {
if (status > CALL_COMPOSER_STATUS_ON
|| status < CALL_COMPOSER_STATUS_OFF) {
throw new IllegalArgumentException("requested status is invalid");
}
}
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setCallComposerStatus(getSubId(), status);
}
} catch (RemoteException ex) {
Log.e(TAG, "Error calling ITelephony#setCallComposerStatus", ex);
ex.rethrowFromSystemServer();
}
}
/**
* Get the user-set status for enriched calling with call composer.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* @throws SecurityException if the caller does not have the permission.
*
* @return the user-set status for enriched calling with call composer, either of
* {@link #CALL_COMPOSER_STATUS_ON} or {@link #CALL_COMPOSER_STATUS_OFF}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public @CallComposerStatus int getCallComposerStatus() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getCallComposerStatus(getSubId());
}
} catch (RemoteException ex) {
Log.e(TAG, "Error calling ITelephony#getCallComposerStatus", ex);
ex.rethrowFromSystemServer();
}
return CALL_COMPOSER_STATUS_OFF;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@SuppressLint("RequiresPermission")
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void dial(String number) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.dial(number);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#dial", e);
}
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*
* @deprecated Use {@link android.telecom.TelecomManager#placeCall(Uri address,
* Bundle extras)} instead.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.CALL_PHONE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void call(String callingPackage, String number) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.call(callingPackage, number);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#call", e);
}
}
/**
* @removed Use {@link android.telecom.TelecomManager#endCall()} instead.
* @hide
* @removed
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.CALL_PHONE)
public boolean endCall() {
return false;
}
/**
* @removed Use {@link android.telecom.TelecomManager#acceptRingingCall} instead
* @hide
* @removed
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public void answerRingingCall() {
// No-op
}
/**
* @removed Use {@link android.telecom.TelecomManager#silenceRinger} instead
* @hide
*/
@Deprecated
@SystemApi
@SuppressLint("RequiresPermission")
public void silenceRinger() {
// No-op
}
/**
* @deprecated Use {@link android.telecom.TelecomManager#isInCall} instead
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE
})
public boolean isOffhook() {
TelecomManager tm = (TelecomManager) mContext.getSystemService(TELECOM_SERVICE);
return tm.isInCall();
}
/**
* @deprecated Use {@link android.telecom.TelecomManager#isRinging} instead
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE
})
public boolean isRinging() {
TelecomManager tm = (TelecomManager) mContext.getSystemService(TELECOM_SERVICE);
return tm.isRinging();
}
/**
* @deprecated Use {@link android.telecom.TelecomManager#isInCall} instead
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE
})
public boolean isIdle() {
TelecomManager tm = (TelecomManager) mContext.getSystemService(TELECOM_SERVICE);
return !tm.isInCall();
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @deprecated Use {@link android.telephony.TelephonyManager#getServiceState} instead
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean isRadioOn() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.isRadioOnWithFeature(getOpPackageName(), getAttributionTag());
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isRadioOn", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean supplyPin(String pin) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.supplyPinForSubscriber(getSubId(), pin);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#supplyPinForSubscriber", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean supplyPuk(String puk, String pin) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.supplyPukForSubscriber(getSubId(), puk, pin);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#supplyPukForSubscriber", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*
* @deprecated use {@link #supplyIccLockPin(String)} instead.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@Deprecated
public int[] supplyPinReportResult(String pin) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.supplyPinReportResultForSubscriber(getSubId(), pin);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#supplyPinReportResultForSubscriber", e);
}
return new int[0];
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*
* @deprecated use {@link #supplyIccLockPuk(String, String)} instead.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@Deprecated
public int[] supplyPukReportResult(String puk, String pin) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.supplyPukReportResultForSubscriber(getSubId(), puk, pin);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#supplyPukReportResultForSubscriber", e);
}
return new int[0];
}
/**
* Supplies a PIN to unlock the ICC and returns the corresponding {@link PinResult}.
* Used when the user enters their ICC unlock PIN to attempt an unlock.
*
* @param pin The user entered PIN.
* @return The result of the PIN.
* @throws SecurityException if the caller doesn't have the permission.
* @throws IllegalStateException if the Telephony process is not currently available.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@NonNull
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public PinResult supplyIccLockPin(@NonNull String pin) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
int[] result = telephony.supplyPinReportResultForSubscriber(getSubId(), pin);
return new PinResult(result[0], result[1]);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#supplyIccLockPin", e);
e.rethrowFromSystemServer();
}
return PinResult.getDefaultFailedResult();
}
/**
* Supplies a PUK and PIN to unlock the ICC and returns the corresponding {@link PinResult}.
* Used when the user enters their ICC unlock PUK and PIN to attempt an unlock.
*
* @param puk The product unlocking key.
* @param pin The user entered PIN.
* @return The result of the PUK and PIN.
* @throws SecurityException if the caller doesn't have the permission.
* @throws IllegalStateException if the Telephony process is not currently available.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@NonNull
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public PinResult supplyIccLockPuk(@NonNull String puk, @NonNull String pin) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
int[] result = telephony.supplyPukReportResultForSubscriber(getSubId(), puk, pin);
return new PinResult(result[0], result[1]);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#supplyIccLockPuk", e);
e.rethrowFromSystemServer();
}
return PinResult.getDefaultFailedResult();
}
/**
* Used to notify callers of
* {@link TelephonyManager#sendUssdRequest(String, UssdResponseCallback, Handler)} when the
* network either successfully executes a USSD request, or if there was a failure while
* executing the request.
*
* {@link #onReceiveUssdResponse(TelephonyManager, String, CharSequence)} will be called if the
* USSD request has succeeded.
* {@link #onReceiveUssdResponseFailed(TelephonyManager, String, int)} will be called if the
* USSD request has failed.
*/
public static abstract class UssdResponseCallback {
/**
* Called when a USSD request has succeeded. The {@code response} contains the USSD
* response received from the network. The calling app can choose to either display the
* response to the user or perform some operation based on the response.
*
* USSD responses are unstructured text and their content is determined by the mobile network
* operator.
*
* @param telephonyManager the TelephonyManager the callback is registered to.
* @param request the USSD request sent to the mobile network.
* @param response the response to the USSD request provided by the mobile network.
**/
public void onReceiveUssdResponse(final TelephonyManager telephonyManager,
String request, CharSequence response) {};
/**
* Called when a USSD request has failed to complete.
*
* @param telephonyManager the TelephonyManager the callback is registered to.
* @param request the USSD request sent to the mobile network.
* @param failureCode failure code indicating why the request failed. Will be either
* {@link TelephonyManager#USSD_RETURN_FAILURE} or
* {@link TelephonyManager#USSD_ERROR_SERVICE_UNAVAIL}.
**/
public void onReceiveUssdResponseFailed(final TelephonyManager telephonyManager,
String request, int failureCode) {};
}
/**
* Sends an Unstructured Supplementary Service Data (USSD) request to the mobile network and
* informs the caller of the response via the supplied {@code callback}.
* Carriers define USSD codes which can be sent by the user to request information such as
* the user's current data balance or minutes balance.
* Requires permission:
* {@link android.Manifest.permission#CALL_PHONE}
* @param ussdRequest the USSD command to be executed.
* @param callback called by the framework to inform the caller of the result of executing the
* USSD request (see {@link UssdResponseCallback}).
* @param handler the {@link Handler} to run the request on.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.CALL_PHONE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void sendUssdRequest(String ussdRequest,
final UssdResponseCallback callback, Handler handler) {
checkNotNull(callback, "UssdResponseCallback cannot be null.");
final TelephonyManager telephonyManager = this;
ResultReceiver wrappedCallback = new ResultReceiver(handler) {
@Override
protected void onReceiveResult(int resultCode, Bundle ussdResponse) {
Rlog.d(TAG, "USSD:" + resultCode);
checkNotNull(ussdResponse, "ussdResponse cannot be null.");
UssdResponse response = ussdResponse.getParcelable(USSD_RESPONSE, android.telephony.UssdResponse.class);
if (resultCode == USSD_RETURN_SUCCESS) {
callback.onReceiveUssdResponse(telephonyManager, response.getUssdRequest(),
response.getReturnMessage());
} else {
callback.onReceiveUssdResponseFailed(telephonyManager,
response.getUssdRequest(), resultCode);
}
}
};
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.handleUssdRequest(getSubId(), ussdRequest, wrappedCallback);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#sendUSSDCode", e);
UssdResponse response = new UssdResponse(ussdRequest, "");
Bundle returnData = new Bundle();
returnData.putParcelable(USSD_RESPONSE, response);
wrappedCallback.send(USSD_ERROR_SERVICE_UNAVAIL, returnData);
}
}
/**
* Whether the device is currently on a technology (e.g. UMTS or LTE) which can support
* voice and data simultaneously. This can change based on location or network condition.
*
* @return {@code true} if simultaneous voice and data supported, and {@code false} otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isConcurrentVoiceAndDataSupported() {
try {
ITelephony telephony = getITelephony();
return (telephony == null ? false : telephony.isConcurrentVoiceAndDataAllowed(
getSubId()));
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isConcurrentVoiceAndDataAllowed", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide */
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean handlePinMmi(String dialString) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.handlePinMmi(dialString);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#handlePinMmi", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean handlePinMmiForSubscriber(int subId, String dialString) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.handlePinMmiForSubscriber(subId, dialString);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#handlePinMmi", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void toggleRadioOnOff() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.toggleRadioOnOff();
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#toggleRadioOnOff", e);
}
}
/**
* @deprecated - use the APIs {@link requestRadioPowerOffForReason} and
* {@link clearRadioPowerOffForReason}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean setRadio(boolean turnOn) {
boolean result = true;
try {
if (turnOn) {
clearRadioPowerOffForReason(RADIO_POWER_REASON_USER);
} else {
requestRadioPowerOffForReason(RADIO_POWER_REASON_USER);
}
} catch (Exception e) {
String calledFunction =
turnOn ? "clearRadioPowerOffForReason" : "requestRadioPowerOffForReason";
Log.e(TAG, "Error calling " + calledFunction, e);
result = false;
}
return result;
}
/**
* @deprecated - use the APIs {@link requestRadioPowerOffForReason} and
* {@link clearRadioPowerOffForReason}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean setRadioPower(boolean turnOn) {
boolean result = true;
try {
if (turnOn) {
clearRadioPowerOffForReason(RADIO_POWER_REASON_USER);
} else {
requestRadioPowerOffForReason(RADIO_POWER_REASON_USER);
}
} catch (Exception e) {
String calledFunction =
turnOn ? "clearRadioPowerOffForReason" : "requestRadioPowerOffForReason";
Log.e(TAG, "Error calling " + calledFunction, e);
result = false;
}
return result;
}
/**
* Vote on powering off the radio for a reason. The radio will be turned on only when there is
* no reason to power it off. When any of the voters want to power it off, it will be turned
* off. In case of emergency, the radio will be turned on even if there are some reasons for
* powering it off, and these radio off votes will be cleared.
*
* Each API call is for one reason. However, an app can call the API multiple times for multiple
* reasons. Multiple apps can vote for the same reason but the vote of one app does not affect
* the vote of another app.
*
* Each app is responsible for its vote. A powering-off vote for a reason of an app will be
* maintained until it is cleared by calling {@link #clearRadioPowerOffForReason(int)} for that
* reason by the app, or an emergency call is made, or the device is rebooted. When an app
* comes backup from a crash, it needs to make sure if its vote is as expected. An app can use
* the API {@link #getRadioPowerOffReasons()} to check its votes. Votes won't be removed when
* an app crashes.
*
* User setting for power state is persistent across device reboots. This applies to all users,
* callers must be careful to update the off reasons when the current user changes.
*
* @param reason The reason for powering off radio.
* @throws SecurityException if the caller does not have MODIFY_PHONE_STATE permission.
* @throws IllegalStateException if the Telephony service is not currently available.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void requestRadioPowerOffForReason(@RadioPowerReason int reason) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
if (!telephony.requestRadioPowerOffForReason(getSubId(), reason)) {
throw new IllegalStateException("Telephony service is not available.");
}
} else {
throw new IllegalStateException("Telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#requestRadioPowerOffForReason", e);
e.rethrowAsRuntimeException();
}
}
/**
* Remove the vote on powering off the radio for a reason, as requested by
* {@link requestRadioPowerOffForReason}.
*
* @param reason The reason for powering off radio.
* @throws SecurityException if the caller does not have MODIFY_PHONE_STATE permission.
* @throws IllegalStateException if the Telephony service is not currently available.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void clearRadioPowerOffForReason(@RadioPowerReason int reason) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
if (!telephony.clearRadioPowerOffForReason(getSubId(), reason)) {
throw new IllegalStateException("Telephony service is not available.");
}
} else {
throw new IllegalStateException("Telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#clearRadioPowerOffForReason", e);
e.rethrowAsRuntimeException();
}
}
/**
* Get reasons for powering off radio of the calling app, as requested by
* {@link #requestRadioPowerOffForReason(int)}.
*
* @return Set of reasons for powering off radio of the calling app.
* @throws SecurityException if the caller does not have READ_PRIVILEGED_PHONE_STATE permission.
* @throws IllegalStateException if the Telephony service is not currently available.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
@NonNull
public Set To know when the radio has completed powering off, use
* {@link TelephonyCallback.ServiceStateListener}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void shutdownAllRadios() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.shutdownMobileRadios();
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#shutdownAllRadios", e);
e.rethrowAsRuntimeException();
}
}
/**
* Check if any radio is on over all the slot indexes.
*
* @return {@code true} if any radio is on over any slot index.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean isAnyRadioPoweredOn() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.needMobileRadioShutdown();
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isAnyRadioPoweredOn", e);
e.rethrowAsRuntimeException();
}
return false;
}
/**
* Radio explicitly powered off (e.g, airplane mode).
* @hide
*/
@SystemApi
public static final int RADIO_POWER_OFF = 0;
/**
* Radio power is on.
* @hide
*/
@SystemApi
public static final int RADIO_POWER_ON = 1;
/**
* Radio power unavailable (eg, modem resetting or not booted).
* @hide
*/
@SystemApi
public static final int RADIO_POWER_UNAVAILABLE = 2;
/**
* @return current modem radio state.
*
* Requires permission: {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE} or
* {@link android.Manifest.permission#READ_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(anyOf = {android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @RadioPowerState int getRadioPowerState() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getRadioPowerState(getSlotIndex(), mContext.getOpPackageName(),
mContext.getAttributionTag());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return RADIO_POWER_UNAVAILABLE;
}
/**
* This method should not be used due to privacy and stability concerns.
*
* @hide
*/
@SystemApi
public void updateServiceLocation() {
Log.e(TAG, "Do not call TelephonyManager#updateServiceLocation()");
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean enableDataConnectivity() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.enableDataConnectivity(getOpPackageName());
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#enableDataConnectivity", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean disableDataConnectivity() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.disableDataConnectivity(getOpPackageName());
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#disableDataConnectivity", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isDataConnectivityPossible() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.isDataConnectivityPossible(getSubId(SubscriptionManager
.getActiveDataSubscriptionId()));
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isDataAllowed", e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean needsOtaServiceProvisioning() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.needsOtaServiceProvisioning();
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#needsOtaServiceProvisioning", e);
}
return false;
}
/**
* Get the mobile provisioning url that is used to launch a browser to allow users to manage
* their mobile plan.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE}.
*
* TODO: The legacy design only supports single sim design. Ideally, this should support
* multi-sim design in current world.
*
* {@hide}
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public @Nullable String getMobileProvisioningUrl() {
try {
final ITelephony service = getITelephony();
if (service != null) {
return service.getMobileProvisioningUrl();
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Rlog.e(TAG, "Telephony#getMobileProvisioningUrl RemoteException" + ex);
}
return null;
}
/**
* Turns mobile data on or off.
* If this object has been created with {@link #createForSubscriptionId}, applies to the given
* subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param enable Whether to enable mobile data.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @deprecated use setDataEnabledForReason with reason DATA_ENABLED_REASON_USER instead.
*
*/
@Deprecated
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setDataEnabled(boolean enable) {
setDataEnabled(getSubId(SubscriptionManager.getDefaultDataSubscriptionId()), enable);
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
* @deprecated use {@link #setDataEnabledForReason(int, boolean)} instead.
*/
@SystemApi
@Deprecated
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setDataEnabled(int subId, boolean enable) {
try {
setDataEnabledForReason(subId, DATA_ENABLED_REASON_USER, enable);
} catch (RuntimeException e) {
Log.e(TAG, "Error calling setDataEnabledForReason e:" + e);
}
}
/**
* @deprecated use {@link #isDataEnabled()} instead.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@Deprecated
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean getDataEnabled() {
return isDataEnabled();
}
/**
* Returns whether mobile data is enabled or not per user setting. There are other factors
* that could disable mobile data, but they are not considered here.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the given
* subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires one of the following permissions:
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE},
* {@link android.Manifest.permission#MODIFY_PHONE_STATE}, or
* {@link android.Manifest.permission#READ_BASIC_PHONE_STATE
* READ_BASIC_PHONE_STATE} or that the calling app has carrier
* privileges (see {@link #hasCarrierPrivileges}).
*
* Note that this does not take into account any data restrictions that may be present on the
* calling app. Such restrictions may be inspected with
* {@link ConnectivityManager#getRestrictBackgroundStatus}.
*
* @return true if mobile data is enabled.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresPermission(anyOf = {android.Manifest.permission.ACCESS_NETWORK_STATE,
android.Manifest.permission.MODIFY_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_BASIC_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isDataEnabled() {
try {
return isDataEnabledForReason(DATA_ENABLED_REASON_USER);
} catch (IllegalStateException ise) {
// TODO(b/176163590): Remove this catch once TelephonyManager is booting safely.
Log.e(TAG, "Error calling #isDataEnabled, returning default (false).", ise);
return false;
}
}
/**
* Returns whether mobile data roaming is enabled on the subscription.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires one of the following permissions:
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE},
* {@link android.Manifest.permission#READ_PHONE_STATE} or
* {@link android.Manifest.permission#READ_BASIC_PHONE_STATE
* READ_BASIC_PHONE_STATE} or that the calling app
* has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return {@code true} if the data roaming is enabled on the subscription, otherwise return
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* {@code false}.
*/
@RequiresPermission(anyOf = {android.Manifest.permission.ACCESS_NETWORK_STATE,
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_BASIC_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isDataRoamingEnabled() {
boolean isDataRoamingEnabled = false;
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
isDataRoamingEnabled = telephony.isDataRoamingEnabled(
getSubId(SubscriptionManager.getDefaultDataSubscriptionId()));
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isDataRoamingEnabled", e);
}
return isDataRoamingEnabled;
}
/**
* Gets the roaming mode for CDMA phone.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* @return the CDMA roaming mode.
* @throws SecurityException if the caller does not have the permission.
* @throws IllegalStateException if the Telephony process is not currently available.
*
* @see #CDMA_ROAMING_MODE_RADIO_DEFAULT
* @see #CDMA_ROAMING_MODE_HOME
* @see #CDMA_ROAMING_MODE_AFFILIATED
* @see #CDMA_ROAMING_MODE_ANY
*
* Requires permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CDMA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CDMA)
public @CdmaRoamingMode int getCdmaRoamingMode() {
int mode = CDMA_ROAMING_MODE_RADIO_DEFAULT;
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
mode = telephony.getCdmaRoamingMode(getSubId());
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "Error calling ITelephony#getCdmaRoamingMode", ex);
ex.rethrowFromSystemServer();
}
return mode;
}
/**
* Sets the roaming mode for CDMA phone to the given mode {@code mode}. If the phone is not
* CDMA capable, this method throws an IllegalStateException.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* @param mode CDMA roaming mode.
* @throws SecurityException if the caller does not have the permission.
* @throws IllegalStateException if the Telephony process or radio is not currently available,
* the device is not CDMA capable, or the request fails.
*
* @see #CDMA_ROAMING_MODE_RADIO_DEFAULT
* @see #CDMA_ROAMING_MODE_HOME
* @see #CDMA_ROAMING_MODE_AFFILIATED
* @see #CDMA_ROAMING_MODE_ANY
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CDMA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CDMA)
public void setCdmaRoamingMode(@CdmaRoamingMode int mode) {
if (getPhoneType() != PHONE_TYPE_CDMA) {
throw new IllegalStateException("Phone does not support CDMA.");
}
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
boolean result = telephony.setCdmaRoamingMode(getSubId(), mode);
if (!result) throw new IllegalStateException("radio is unavailable.");
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "Error calling ITelephony#setCdmaRoamingMode", ex);
ex.rethrowFromSystemServer();
}
}
/** @hide */
@IntDef(prefix = { "CDMA_SUBSCRIPTION_" }, value = {
CDMA_SUBSCRIPTION_UNKNOWN,
CDMA_SUBSCRIPTION_RUIM_SIM,
CDMA_SUBSCRIPTION_NV
})
@Retention(RetentionPolicy.SOURCE)
public @interface CdmaSubscription{}
/**
* Used for CDMA subscription mode, it'll be UNKNOWN if there is no Subscription source.
* @hide
*/
@SystemApi
public static final int CDMA_SUBSCRIPTION_UNKNOWN = -1;
/**
* Used for CDMA subscription mode: RUIM/SIM (default)
* @hide
*/
@SystemApi
public static final int CDMA_SUBSCRIPTION_RUIM_SIM = 0;
/**
* Used for CDMA subscription mode: NV -> non-volatile memory
* @hide
*/
@SystemApi
public static final int CDMA_SUBSCRIPTION_NV = 1;
/**
* Gets the subscription mode for CDMA phone.
*
* @return the CDMA subscription mode.
* @throws SecurityException if the caller does not have the permission.
* @throws IllegalStateException if the Telephony process or radio is not currently available.
*
* @see #CDMA_SUBSCRIPTION_UNKNOWN
* @see #CDMA_SUBSCRIPTION_RUIM_SIM
* @see #CDMA_SUBSCRIPTION_NV
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CDMA}.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CDMA)
public @CdmaSubscription int getCdmaSubscriptionMode() {
int mode = CDMA_SUBSCRIPTION_RUIM_SIM;
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
mode = telephony.getCdmaSubscriptionMode(getSubId());
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "Error calling ITelephony#getCdmaSubscriptionMode", ex);
ex.rethrowFromSystemServer();
}
return mode;
}
/**
* Sets the subscription mode for CDMA phone to the given mode {@code mode}. If the phone is not
* CDMA capable, this method throws an IllegalStateException.
*
* @param mode CDMA subscription mode.
* @throws SecurityException if the caller does not have the permission.
* @throws IllegalStateException if the Telephony process or radio is not currently available,
* the device is not CDMA capable, or the request fails.
*
* @see #CDMA_SUBSCRIPTION_UNKNOWN
* @see #CDMA_SUBSCRIPTION_RUIM_SIM
* @see #CDMA_SUBSCRIPTION_NV
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CDMA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CDMA)
public void setCdmaSubscriptionMode(@CdmaSubscription int mode) {
if (getPhoneType() != PHONE_TYPE_CDMA) {
throw new IllegalStateException("Phone does not support CDMA.");
}
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
boolean result = telephony.setCdmaSubscriptionMode(getSubId(), mode);
if (!result) throw new IllegalStateException("radio is unavailable.");
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "Error calling ITelephony#setCdmaSubscriptionMode", ex);
ex.rethrowFromSystemServer();
}
}
/**
* Enables/Disables the data roaming on the subscription.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the calling app has carrier
* privileges (see {@link #hasCarrierPrivileges}).
*
* @param isEnabled {@code true} to enable mobile data roaming, otherwise disable it.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setDataRoamingEnabled(boolean isEnabled) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setDataRoamingEnabled(
getSubId(SubscriptionManager.getDefaultDataSubscriptionId()), isEnabled);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#setDataRoamingEnabled", e);
}
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*
* @deprecated use {@link #isDataEnabled()} instead.
* @hide
*/
@Deprecated
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean getDataEnabled(int subId) {
try {
return isDataEnabledForReason(subId, DATA_ENABLED_REASON_USER);
} catch (RuntimeException e) {
Log.e(TAG, "Error calling isDataEnabledForReason e:" + e);
}
return false;
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_IMS}.
* @deprecated Use {@link android.telephony.ims.ImsMmTelManager#setVtSettingEnabled(boolean)}
* instead.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_IMS)
public void enableVideoCalling(boolean enable) {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
telephony.enableVideoCalling(enable);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#enableVideoCalling", e);
}
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_IMS}.
* @deprecated Use {@link ImsMmTelManager#isVtSettingEnabled()} instead to check if the user
* has enabled the Video Calling setting, {@link ImsMmTelManager#isAvailable(int, int)} to
* determine if video calling is available, or {@link ImsMmTelManager#isCapable(int, int)} to
* determine if video calling is capable.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_IMS)
public boolean isVideoCallingEnabled() {
try {
ITelephony telephony = getITelephony();
if (telephony != null)
return telephony.isVideoCallingEnabled(getOpPackageName(), getAttributionTag());
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isVideoCallingEnabled", e);
}
return false;
}
/**
* Whether the device supports configuring the DTMF tone length.
*
* @return {@code true} if the DTMF tone length can be changed, and {@code false} otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean canChangeDtmfToneLength() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.canChangeDtmfToneLength(mSubId, getOpPackageName(),
getAttributionTag());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#canChangeDtmfToneLength", e);
} catch (SecurityException e) {
Log.e(TAG, "Permission error calling ITelephony#canChangeDtmfToneLength", e);
}
return false;
}
/**
* Whether the device is a world phone.
*
* @return {@code true} if the device is a world phone, and {@code false} otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY)
public boolean isWorldPhone() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isWorldPhone(mSubId, getOpPackageName(), getAttributionTag());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isWorldPhone", e);
} catch (SecurityException e) {
Log.e(TAG, "Permission error calling ITelephony#isWorldPhone", e);
}
return false;
}
/**
* @deprecated Use {@link TelecomManager#isTtySupported()} instead
* Whether the phone supports TTY mode.
*
* @return {@code true} if the device supports TTY mode, and {@code false} otherwise.
*
*/
@Deprecated
public boolean isTtyModeSupported() {
try {
TelecomManager telecomManager = null;
if (mContext != null) {
telecomManager = mContext.getSystemService(TelecomManager.class);
}
if (telecomManager != null) {
return telecomManager.isTtySupported();
}
} catch (SecurityException e) {
Log.e(TAG, "Permission error calling TelecomManager#isTtySupported", e);
}
return false;
}
/**
* Determines whether the device currently supports RTT (Real-time text). Based both on carrier
* support for the feature and device firmware support.
*
* @return {@code true} if the device and carrier both support RTT, {@code false} otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_IMS}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_IMS)
public boolean isRttSupported() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isRttSupported(mSubId);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isRttSupported", e);
} catch (SecurityException e) {
Log.e(TAG, "Permission error calling ITelephony#isWorldPhone", e);
}
return false;
}
/**
* Whether the phone supports hearing aid compatibility.
*
* @return {@code true} if the device supports hearing aid compatibility, and {@code false}
* otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean isHearingAidCompatibilitySupported() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isHearingAidCompatibilitySupported();
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isHearingAidCompatibilitySupported", e);
} catch (SecurityException e) {
Log.e(TAG, "Permission error calling ITelephony#isHearingAidCompatibilitySupported", e);
}
return false;
}
/**
* Returns the IMS Registration Status for a particular Subscription ID.
*
* @param subId Subscription ID
* @return true if IMS status is registered, false if the IMS status is not registered or a
* RemoteException occurred.
* Use {@link ImsMmTelManager.RegistrationCallback} instead.
* @hide
*/
public boolean isImsRegistered(int subId) {
try {
return getITelephony().isImsRegistered(subId);
} catch (RemoteException | NullPointerException ex) {
return false;
}
}
/**
* Returns the IMS Registration Status for a particular Subscription ID, which is determined
* when the TelephonyManager is created using {@link #createForSubscriptionId(int)}. If an
* invalid subscription ID is used during creation, will the default subscription ID will be
* used.
*
* @return true if IMS status is registered, false if the IMS status is not registered or a
* RemoteException occurred.
* @see SubscriptionManager#getDefaultSubscriptionId()
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public boolean isImsRegistered() {
try {
return getITelephony().isImsRegistered(getSubId());
} catch (RemoteException | NullPointerException ex) {
return false;
}
}
/**
* The current status of Voice over LTE for the subscription associated with this instance when
* it was created using {@link #createForSubscriptionId(int)}. If an invalid subscription ID was
* used during creation, the default subscription ID will be used.
* @return true if Voice over LTE is available or false if it is unavailable or unknown.
* @see SubscriptionManager#getDefaultSubscriptionId()
*
* Use {@link ImsMmTelManager#isAvailable(int, int)} instead.
* @hide
*/
@UnsupportedAppUsage
public boolean isVolteAvailable() {
try {
return getITelephony().isAvailable(getSubId(),
MmTelFeature.MmTelCapabilities.CAPABILITY_TYPE_VOICE,
ImsRegistrationImplBase.REGISTRATION_TECH_LTE);
} catch (RemoteException | NullPointerException ex) {
return false;
}
}
/**
* The availability of Video Telephony (VT) for the subscription ID specified when this instance
* was created using {@link #createForSubscriptionId(int)}. If an invalid subscription ID was
* used during creation, the default subscription ID will be used. To query the
* underlying technology that VT is available on, use {@link #getImsRegTechnologyForMmTel}.
* @return true if VT is available, or false if it is unavailable or unknown.
* Use {@link ImsMmTelManager#isAvailable(int, int)} instead.
* @hide
*/
@UnsupportedAppUsage
public boolean isVideoTelephonyAvailable() {
try {
return getITelephony().isVideoTelephonyAvailable(getSubId());
} catch (RemoteException | NullPointerException ex) {
return false;
}
}
/**
* Returns the Status of Wi-Fi calling (Voice over WiFi) for the subscription ID specified.
* @param subId the subscription ID.
* @return true if VoWiFi is available, or false if it is unavailable or unknown.
* Use {@link ImsMmTelManager#isAvailable(int, int)} instead.
* @hide
*/
@UnsupportedAppUsage
public boolean isWifiCallingAvailable() {
try {
return getITelephony().isWifiCallingAvailable(getSubId());
} catch (RemoteException | NullPointerException ex) {
return false;
}
}
/**
* The technology that IMS is registered for for the MMTEL feature.
* @param subId subscription ID to get IMS registration technology for.
* @return The IMS registration technology that IMS is registered to for the MMTEL feature.
* Valid return results are:
* - {@link ImsRegistrationImplBase#REGISTRATION_TECH_LTE} for LTE registration,
* - {@link ImsRegistrationImplBase#REGISTRATION_TECH_IWLAN} for IWLAN registration, or
* - {@link ImsRegistrationImplBase#REGISTRATION_TECH_CROSS_SIM} for registration over
* other sim's internet, or
* - {@link ImsRegistrationImplBase#REGISTRATION_TECH_NONE} if we are not registered or the
* result is unavailable.
* Use {@link ImsMmTelManager.RegistrationCallback} instead.
* @hide
*/
public @ImsRegistrationImplBase.ImsRegistrationTech int getImsRegTechnologyForMmTel() {
try {
return getITelephony().getImsRegTechnologyForMmTel(getSubId());
} catch (RemoteException ex) {
return ImsRegistrationImplBase.REGISTRATION_TECH_NONE;
}
}
/**
* Set TelephonyProperties.icc_operator_numeric for the given phone.
*
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public void setSimOperatorNumericForPhone(int phoneId, String numeric) {
if (SubscriptionManager.isValidPhoneId(phoneId)) {
List Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* {@hide}
**/
@SystemApi
@Deprecated
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void setSimPowerState(int state) {
setSimPowerStateForSlot(getSlotIndex(), state);
}
/**
* Set SIM card power state.
*
* @param slotIndex SIM slot id
* @param state State of SIM (power down, power up, pass through)
* @see #CARD_POWER_DOWN
* @see #CARD_POWER_UP
* @see #CARD_POWER_UP_PASS_THROUGH
* Callers should monitor for {@link TelephonyIntents#ACTION_SIM_STATE_CHANGED}
* broadcasts to determine success or failure and timeout if needed.
*
* @deprecated prefer {@link setSimPowerStateForSlot(int, int, Executor, Consumer Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* {@hide}
**/
@SystemApi
@Deprecated
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void setSimPowerStateForSlot(int slotIndex, int state) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setSimPowerStateForSlot(slotIndex, state);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#setSimPowerStateForSlot", e);
} catch (SecurityException e) {
Log.e(TAG, "Permission error calling ITelephony#setSimPowerStateForSlot", e);
}
}
/**
* Set SIM card power state.
*
* @param state State of SIM (power down, power up, pass through)
* @see #CARD_POWER_DOWN
* @see #CARD_POWER_UP
* @see #CARD_POWER_UP_PASS_THROUGH
* @param executor The executor of where the callback will execute.
* @param callback Callback will be triggered once it succeeds or failed.
* @see #SET_SIM_POWER_STATE_SUCCESS
* @see #SET_SIM_POWER_STATE_ALREADY_IN_STATE
* @see #SET_SIM_POWER_STATE_MODEM_ERROR
* @see #SET_SIM_POWER_STATE_SIM_ERROR
* @see #SET_SIM_POWER_STATE_NOT_SUPPORTED
* @throws IllegalArgumentException if requested SIM state is invalid
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* {@hide}
**/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void setSimPowerState(@SimPowerState int state, @NonNull Executor executor,
@NonNull @SetSimPowerStateResult Consumer Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* {@hide}
**/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void setSimPowerStateForSlot(int slotIndex, @SimPowerState int state,
@NonNull Executor executor,
@NonNull @SetSimPowerStateResult Consumer If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* Requires Permission android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges})
*
* @return The {@link PhoneAccountHandle} associated with the TelphonyManager, or {@code null}
* if there is no associated {@link PhoneAccountHandle}; this can happen if the subscription is
* data-only or an opportunistic subscription.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public @Nullable PhoneAccountHandle getPhoneAccountHandle() {
return getPhoneAccountHandleForSubscriptionId(getSubId());
}
/**
* Determines the {@link PhoneAccountHandle} associated with a subscription Id.
*
* @param subscriptionId The subscription Id to check.
* @return The {@link PhoneAccountHandle} associated with a subscription Id, or {@code null} if
* there is no associated {@link PhoneAccountHandle}.
* @hide
*/
public @Nullable PhoneAccountHandle getPhoneAccountHandleForSubscriptionId(int subscriptionId) {
PhoneAccountHandle returnValue = null;
try {
ITelephony service = getITelephony();
if (service != null) {
returnValue = service.getPhoneAccountHandleForSubscriptionId(subscriptionId);
}
} catch (RemoteException e) {
}
return returnValue;
}
/**
* Returns the subscription ID for the given phone account handle.
*
* @param phoneAccountHandle the phone account handle for outgoing calls
* @return subscription ID for the given phone account handle; or
* {@link SubscriptionManager#INVALID_SUBSCRIPTION_ID}
* if not available; or throw a SecurityException if the caller doesn't have the
* permission.
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int getSubscriptionId(@NonNull PhoneAccountHandle phoneAccountHandle) {
return mPhoneAccountHandleToSubIdCache.query(phoneAccountHandle);
}
/**
* Resets telephony manager settings back to factory defaults.
*
* @hide
*/
public void factoryReset(int subId) {
try {
Log.d(TAG, "factoryReset: subId=" + subId);
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.factoryReset(subId, getOpPackageName());
}
} catch (RemoteException e) {
}
}
/**
* Resets Telephony and IMS settings back to factory defaults only for the subscription
* associated with this instance.
* @see #createForSubscriptionId(int)
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY}.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.CONNECTIVITY_INTERNAL)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY)
public void resetSettings() {
try {
Log.d(TAG, "resetSettings: subId=" + getSubId());
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.factoryReset(getSubId(), getOpPackageName());
}
} catch (RemoteException e) {
}
}
/**
* Returns a locale based on the country and language from the SIM. Returns {@code null} if
* no locale could be derived from subscriptions.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
*
* @see Locale#toLanguageTag()
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@Nullable public Locale getSimLocale() {
try {
final ITelephony telephony = getITelephony();
if (telephony != null) {
String languageTag = telephony.getSimLocaleForSubscriber(getSubId());
if (!TextUtils.isEmpty(languageTag)) {
return Locale.forLanguageTag(languageTag);
}
}
} catch (RemoteException ex) {
}
return null;
}
/**
* Exception that may be supplied to the callback provided in {@link #requestModemActivityInfo}.
* @hide
*/
@SystemApi
public static class ModemActivityInfoException extends Exception {
/** Indicates that an unknown error occurred */
public static final int ERROR_UNKNOWN = 0;
/**
* Indicates that the modem or phone processes are not available (such as when the device
* is in airplane mode).
*/
public static final int ERROR_PHONE_NOT_AVAILABLE = 1;
/**
* Indicates that the modem supplied an invalid instance of {@link ModemActivityInfo}
*/
public static final int ERROR_INVALID_INFO_RECEIVED = 2;
/**
* Indicates that the modem encountered an internal failure when processing the request
* for activity info.
*/
public static final int ERROR_MODEM_RESPONSE_ERROR = 3;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"ERROR_"},
value = {
ERROR_UNKNOWN,
ERROR_PHONE_NOT_AVAILABLE,
ERROR_INVALID_INFO_RECEIVED,
ERROR_MODEM_RESPONSE_ERROR,
})
public @interface ModemActivityInfoError {}
private final int mErrorCode;
/**
* An exception with ModemActivityInfo specific error codes.
*
* @param errorCode a ModemActivityInfoError code.
*/
public ModemActivityInfoException(@ModemActivityInfoError int errorCode) {
mErrorCode = errorCode;
}
public @ModemActivityInfoError int getErrorCode() {
return mErrorCode;
}
@Override
public String toString() {
switch (mErrorCode) {
case ERROR_UNKNOWN: return "ERROR_UNKNOWN";
case ERROR_PHONE_NOT_AVAILABLE: return "ERROR_PHONE_NOT_AVAILABLE";
case ERROR_INVALID_INFO_RECEIVED: return "ERROR_INVALID_INFO_RECEIVED";
case ERROR_MODEM_RESPONSE_ERROR: return "ERROR_MODEM_RESPONSE_ERROR";
default: return "UNDEFINED";
}
}
}
/**
* Requests the current modem activity info.
*
* The provided instance of {@link ModemActivityInfo} represents the cumulative activity since
* the last restart of the phone process.
*
* @param callback A callback object to which the result will be delivered. If there was an
* error processing the request, {@link OutcomeReceiver#onError} will be called
* with more details about the error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY}.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY)
public void requestModemActivityInfo(@NonNull @CallbackExecutor Executor executor,
@NonNull OutcomeReceiver If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* If you want continuous updates of service state info, register a {@link TelephonyCallback}
* that implements {@link TelephonyCallback.ServiceStateListener} through {@link
* #registerTelephonyCallback}.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges})
* and {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}.
* May return {@code null} when the subscription is inactive or when there was an error
* communicating with the phone process.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(allOf = {
Manifest.permission.READ_PHONE_STATE,
Manifest.permission.ACCESS_COARSE_LOCATION
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @Nullable ServiceState getServiceState() {
return getServiceState(getLocationData());
}
/**
* Returns the current {@link ServiceState} information.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* If you want continuous updates of service state info, register a {@link TelephonyCallback}
* that implements {@link TelephonyCallback.ServiceStateListener} through {@link
* #registerTelephonyCallback}.
*
* There's another way to renounce permissions with a custom context
* {@code AttributionSource.Builder#setRenouncedPermissions(Set Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges})
* and {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}.
* @param includeLocationData Specifies if the caller would like to receive
* location related information.
* May return {@code null} when the subscription is inactive or when there was an error
* communicating with the phone process.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(allOf = {
Manifest.permission.READ_PHONE_STATE,
Manifest.permission.ACCESS_COARSE_LOCATION
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @Nullable ServiceState getServiceState(@IncludeLocationData int includeLocationData) {
return getServiceStateForSlot(SubscriptionManager.getSlotIndex(getSubId()),
includeLocationData != INCLUDE_LOCATION_DATA_FINE,
includeLocationData == INCLUDE_LOCATION_DATA_NONE);
}
/**
* Returns the service state information on specified SIM slot.
*
* May return {@code null} when the {@code slotIndex} is invalid or when there was an error
* communicating with the phone process.
*
* @param slotIndex of phone whose service state is returned
* @param renounceFineLocationAccess Set this to true if the caller would not like to receive
* location related information which will be sent if the caller already possess
* {@link android.Manifest.permission#ACCESS_FINE_LOCATION} and do not renounce the permission
* @param renounceCoarseLocationAccess Set this to true if the caller would not like to
* receive location related information which will be sent if the caller already possess
* {@link Manifest.permission#ACCESS_COARSE_LOCATION} and do not renounce the permissions.
* @return Service state on specified SIM slot.
*/
private ServiceState getServiceStateForSlot(int slotIndex, boolean renounceFineLocationAccess,
boolean renounceCoarseLocationAccess) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getServiceStateForSlot(slotIndex,
renounceFineLocationAccess, renounceCoarseLocationAccess,
getOpPackageName(), getAttributionTag());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getServiceStateForSlot", e);
} catch (NullPointerException e) {
AnomalyReporter.reportAnomaly(
UUID.fromString("e2bed88e-def9-476e-bd71-3e572a8de6d1"),
"getServiceStateForSlot " + slotIndex + " NPE");
}
return null;
}
/**
* Returns the service state information on specified subscription. Callers require
* either READ_PRIVILEGED_PHONE_STATE or READ_PHONE_STATE to retrieve the information.
*
* May return {@code null} when the subscription is inactive or when there was an error
* communicating with the phone process.
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public ServiceState getServiceStateForSubscriber(int subId) {
return getServiceStateForSlot(
SubscriptionManager.getSlotIndex(subId), false, false);
}
/**
* Returns the service state information on specified SIM slot.
*
* If you want continuous updates of service state info, register a {@link TelephonyCallback}
* that implements {@link TelephonyCallback.ServiceStateListener} through
* {@link #registerTelephonyCallback}.
*
* May return {@code null} when the {@code slotIndex} is invalid or when there was an error
* communicating with the phone process
*
* See {@link #getActiveModemCount()} to get the total number of slots
* that are active on the device.
*
* @param slotIndex of phone whose service state is returned
* @return ServiceState on specified SIM slot.
*
* @hide
*/
@RequiresPermission(allOf = {
Manifest.permission.READ_PHONE_STATE,
Manifest.permission.ACCESS_COARSE_LOCATION
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @Nullable ServiceState getServiceStateForSlot(int slotIndex) {
return getServiceStateForSlot(slotIndex, false, false);
}
/**
* Returns the URI for the per-account voicemail ringtone set in Phone settings.
*
* @param accountHandle The handle for the {@link PhoneAccount} for which to retrieve the
* voicemail ringtone.
* @return The URI for the ringtone to play when receiving a voicemail from a specific
* PhoneAccount. May be {@code null} if no ringtone is set.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public @Nullable Uri getVoicemailRingtoneUri(PhoneAccountHandle accountHandle) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getVoicemailRingtoneUri(accountHandle);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getVoicemailRingtoneUri", e);
}
return null;
}
/**
* Sets the per-account voicemail ringtone.
*
* Requires that the calling app is the default dialer, or has carrier privileges (see
* {@link #hasCarrierPrivileges}, or has permission
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param phoneAccountHandle The handle for the {@link PhoneAccount} for which to set the
* voicemail ringtone.
* @param uri The URI for the ringtone to play when receiving a voicemail from a specific
* PhoneAccount.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @deprecated Use {@link android.provider.Settings#ACTION_CHANNEL_NOTIFICATION_SETTINGS}
* instead.
*/
@Deprecated
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void setVoicemailRingtoneUri(PhoneAccountHandle phoneAccountHandle, Uri uri) {
try {
ITelephony service = getITelephony();
if (service != null) {
service.setVoicemailRingtoneUri(getOpPackageName(), phoneAccountHandle, uri);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#setVoicemailRingtoneUri", e);
}
}
/**
* Returns whether vibration is set for voicemail notification in Phone settings.
*
* @param accountHandle The handle for the {@link PhoneAccount} for which to retrieve the
* voicemail vibration setting.
* @return {@code true} if the vibration is set for this PhoneAccount, {@code false} otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean isVoicemailVibrationEnabled(PhoneAccountHandle accountHandle) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.isVoicemailVibrationEnabled(accountHandle);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isVoicemailVibrationEnabled", e);
}
return false;
}
/**
* Sets the per-account preference whether vibration is enabled for voicemail notifications.
*
* Requires that the calling app is the default dialer, or has carrier privileges (see
* {@link #hasCarrierPrivileges}, or has permission
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param phoneAccountHandle The handle for the {@link PhoneAccount} for which to set the
* voicemail vibration setting.
* @param enabled Whether to enable or disable vibration for voicemail notifications from a
* specific PhoneAccount.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @deprecated Use {@link android.provider.Settings#ACTION_CHANNEL_NOTIFICATION_SETTINGS}
* instead.
*/
@Deprecated
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void setVoicemailVibrationEnabled(PhoneAccountHandle phoneAccountHandle,
boolean enabled) {
try {
ITelephony service = getITelephony();
if (service != null) {
service.setVoicemailVibrationEnabled(getOpPackageName(), phoneAccountHandle,
enabled);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isVoicemailVibrationEnabled", e);
}
}
/**
* Returns carrier id of the current subscription.
* To recognize a carrier (including MVNO) as a first-class identity, Android assigns each
* carrier with a canonical integer a.k.a. carrier id. The carrier ID is an Android
* platform-wide identifier for a carrier. AOSP maintains carrier ID assignments in
* here
*
* Apps which have carrier-specific configurations or business logic can use the carrier id
* as an Android platform-wide identifier for carriers.
*
* @return Carrier id of the current subscription. Return {@link #UNKNOWN_CARRIER_ID} if the
* subscription is unavailable or the carrier cannot be identified.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int getSimCarrierId() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getSubscriptionCarrierId(getSubId());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return UNKNOWN_CARRIER_ID;
}
/**
* Returns carrier id name of the current subscription.
* Carrier id name is a user-facing name of carrier id returned by
* {@link #getSimCarrierId()}, usually the brand name of the subsidiary
* (e.g. T-Mobile). Each carrier could configure multiple {@link #getSimOperatorName() SPN} but
* should have a single carrier name. Carrier name is not a canonical identity,
* use {@link #getSimCarrierId()} instead.
* The returned carrier name is unlocalized.
*
* @return Carrier name of the current subscription. Return {@code null} if the subscription is
* unavailable or the carrier cannot be identified.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @Nullable CharSequence getSimCarrierIdName() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getSubscriptionCarrierName(getSubId());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return null;
}
/**
* Returns fine-grained carrier ID of the current subscription.
*
* A specific carrier ID can represent the fact that a carrier may be in effect an aggregation
* of other carriers (ie in an MVNO type scenario) where each of these specific carriers which
* are used to make up the actual carrier service may have different carrier configurations.
* A specific carrier ID could also be used, for example, in a scenario where a carrier requires
* different carrier configuration for different service offering such as a prepaid plan.
*
* the specific carrier ID would be used for configuration purposes, but apps wishing to know
* about the carrier itself should use the regular carrier ID returned by
* {@link #getSimCarrierId()}.
*
* e.g, Tracfone SIMs could return different specific carrier ID based on IMSI from current
* subscription while carrier ID remains the same.
*
* For carriers without fine-grained specific carrier ids, return {@link #getSimCarrierId()}
* Specific carrier ids are defined in the same way as carrier id
* here
* except each with a "parent" id linking to its top-level carrier id.
*
* @return Returns fine-grained carrier id of the current subscription.
* Return {@link #UNKNOWN_CARRIER_ID} if the subscription is unavailable or the carrier cannot
* be identified.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int getSimSpecificCarrierId() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getSubscriptionSpecificCarrierId(getSubId());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return UNKNOWN_CARRIER_ID;
}
/**
* Similar like {@link #getSimCarrierIdName()}, returns user-facing name of the
* specific carrier id returned by {@link #getSimSpecificCarrierId()}.
*
* The specific carrier ID would be used for configuration purposes, but apps wishing to know
* about the carrier itself should use the regular carrier ID returned by
* {@link #getSimCarrierIdName()}.
*
* The returned name is unlocalized.
*
* @return user-facing name of the subscription specific carrier id. Return {@code null} if the
* subscription is unavailable or the carrier cannot be identified.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @Nullable CharSequence getSimSpecificCarrierIdName() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getSubscriptionSpecificCarrierName(getSubId());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return null;
}
/**
* Returns carrier id based on sim MCCMNC (returned by {@link #getSimOperator()}) only.
* This is used for fallback when configurations/logic for exact carrier id
* {@link #getSimCarrierId()} are not found.
*
* Android carrier id table here
* can be updated out-of-band, its possible a MVNO (Mobile Virtual Network Operator) carrier
* was not fully recognized and assigned to its MNO (Mobile Network Operator) carrier id
* by default. After carrier id table update, a new carrier id was assigned. If apps don't
* take the update with the new id, it might be helpful to always fallback by using carrier
* id based on MCCMNC if there is no match.
*
* @return matching carrier id from sim MCCMNC. Return {@link #UNKNOWN_CARRIER_ID} if the
* subscription is unavailable or the carrier cannot be identified.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int getCarrierIdFromSimMccMnc() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getCarrierIdFromMccMnc(getSlotIndex(), getSimOperator(), true);
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return UNKNOWN_CARRIER_ID;
}
/**
* Returns carrier id based on MCCMNC (returned by {@link #getSimOperator()}) only. This is
* used for fallback when configurations/logic for exact carrier id {@link #getSimCarrierId()}
* are not found.
*
* Android carrier id table here
* can be updated out-of-band, its possible a MVNO (Mobile Virtual Network Operator) carrier
* was not fully recognized and assigned to its MNO (Mobile Network Operator) carrier id
* by default. After carrier id table update, a new carrier id was assigned. If apps don't
* take the update with the new id, it might be helpful to always fallback by using carrier
* id based on MCCMNC if there is no match.
*
* @return matching carrier id from passing MCCMNC. Return {@link #UNKNOWN_CARRIER_ID} if the
* subscription is unavailable or the carrier cannot be identified.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public int getCarrierIdFromMccMnc(String mccmnc) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getCarrierIdFromMccMnc(getSlotIndex(), mccmnc, false);
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return UNKNOWN_CARRIER_ID;
}
/**
* Return a list of certs as hex strings from loaded carrier privileges access rules.
*
* @return a list of certificates as hex strings, or an empty list if there are no certs or
* privilege rules are not loaded yet.
* @hide
*/
@TestApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@NonNull
public List Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE}
*
* @param appType the uicc app type.
* @return Application ID for specified app type or {@code null} if no uicc or error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@Nullable
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getAidForAppType(@UiccAppType int appType) {
return getAidForAppType(getSubId(), appType);
}
/**
* same as {@link #getAidForAppType(int)}
* @hide
*/
public String getAidForAppType(int subId, int appType) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getAidForAppType(subId, appType);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getAidForAppType", e);
}
return null;
}
/**
* Return the Electronic Serial Number.
*
* Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission
*
* @return ESN or null if error.
* @hide
*/
public String getEsn() {
return getEsn(getSubId());
}
/**
* Return the Electronic Serial Number.
*
* Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission
*
* @param subId the subscription ID that this request applies to.
* @return ESN or null if error.
* @hide
*/
public String getEsn(int subId) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getEsn(subId);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getEsn", e);
}
return null;
}
/**
* Return the Preferred Roaming List Version
*
* Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission
*
* @return PRLVersion or null if error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CDMA}.
* @hide
*/
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CDMA)
public String getCdmaPrlVersion() {
return getCdmaPrlVersion(getSubId());
}
/**
* Return the Preferred Roaming List Version
*
* Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission
*
* @param subId the subscription ID that this request applies to.
* @return PRLVersion or null if error.
* @hide
*/
public String getCdmaPrlVersion(int subId) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getCdmaPrlVersion(subId);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getCdmaPrlVersion", e);
}
return null;
}
/**
* Get snapshot of Telephony histograms
* @return List of Telephony histograms
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
* Or the calling app has carrier privileges.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public List Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE}
*
* This method works only on devices with {@link
* android.content.pm.PackageManager#FEATURE_TELEPHONY_CARRIERLOCK} enabled.
*
* @deprecated use setCarrierRestrictionRules instead
*
* @return The number of carriers set successfully. Should be length of
* carrierList on success; -1 if carrierList null or on error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CARRIERLOCK}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CARRIERLOCK)
public int setAllowedCarriers(int slotIndex, List Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE}
*
* This method works only on devices with {@link
* android.content.pm.PackageManager#FEATURE_TELEPHONY_CARRIERLOCK} enabled.
*
* @return {@link #SET_CARRIER_RESTRICTION_SUCCESS} in case of success.
* {@link #SET_CARRIER_RESTRICTION_NOT_SUPPORTED} if the modem does not support the
* configuration. {@link #SET_CARRIER_RESTRICTION_ERROR} in all other error cases.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CARRIERLOCK}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@SetCarrierRestrictionResult
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CARRIERLOCK)
public int setCarrierRestrictionRules(@NonNull CarrierRestrictionRules rules) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.setAllowedCarriers(rules);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#setAllowedCarriers", e);
} catch (NullPointerException e) {
Log.e(TAG, "Error calling ITelephony#setAllowedCarriers", e);
}
return SET_CARRIER_RESTRICTION_ERROR;
}
/**
* Get the allowed carrier list for slotIndex.
* Requires system privileges.
*
* This method returns valid data on devices with {@link
* android.content.pm.PackageManager#FEATURE_TELEPHONY_CARRIERLOCK} enabled.
*
* @deprecated Apps should use {@link #getCarrierRestrictionRules} to retrieve the list of
* allowed and excliuded carriers, as the result of this API is valid only when the excluded
* list is empty. This API could return an empty list, even if some restrictions are present.
*
* @return List of {@link android.service.carrier.CarrierIdentifier}; empty list
* means all carriers are allowed.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CARRIERLOCK}.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CARRIERLOCK)
public List This method returns valid data on devices with {@link
* android.content.pm.PackageManager#FEATURE_TELEPHONY_CARRIERLOCK} enabled.
*
* @return {@link CarrierRestrictionRules} which contains the allowed carrier list and the
* excluded carrier list with the priority between the two lists. Returns {@code null}
* in case of error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CARRIERLOCK}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CARRIERLOCK)
@Nullable
public CarrierRestrictionRules getCarrierRestrictionRules() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getAllowedCarriers();
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getAllowedCarriers", e);
} catch (NullPointerException e) {
Log.e(TAG, "Error calling ITelephony#getAllowedCarriers", e);
}
return null;
}
/**
* Carrier restriction status value is unknown, in case modem did not provide any
* information about carrier restriction status.
*/
public static final int CARRIER_RESTRICTION_STATUS_UNKNOWN = 0;
/** The device is not restricted to a carrier */
public static final int CARRIER_RESTRICTION_STATUS_NOT_RESTRICTED = 1;
/** The device is restricted to a carrier. */
public static final int CARRIER_RESTRICTION_STATUS_RESTRICTED = 2;
/** The device is restricted to the carrier of the calling application. */
public static final int CARRIER_RESTRICTION_STATUS_RESTRICTED_TO_CALLER = 3;
/** @hide */
@IntDef(prefix = {"CARRIER_RESTRICTION_STATUS_"}, value = {
CARRIER_RESTRICTION_STATUS_UNKNOWN,
CARRIER_RESTRICTION_STATUS_NOT_RESTRICTED,
CARRIER_RESTRICTION_STATUS_RESTRICTED,
CARRIER_RESTRICTION_STATUS_RESTRICTED_TO_CALLER
})
@Retention(RetentionPolicy.SOURCE)
public @interface CarrierRestrictionStatus {
}
/**
* Get the carrier restriction status of the device.
* To fetch the carrier restriction status of the device the calling application needs to be
* allowlisted to Android at here.
* The calling application also needs the READ_PHONE_STATE permission.
* The return value of the API is as follows.
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param enabled control enable or disable carrier data.
* @see #resetAllCarrierActions()
* @deprecated use {@link #setDataEnabledForReason(int, boolean) with
* reason {@link #DATA_ENABLED_REASON_CARRIER}} instead.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setCarrierDataEnabled(boolean enabled) {
try {
setDataEnabledForReason(DATA_ENABLED_REASON_CARRIER, enabled);
} catch (RuntimeException e) {
Log.e(TAG, "Error calling setDataEnabledForReason e:" + e);
}
}
/**
* Carrier action to enable or disable the radio.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param enabled control enable or disable radio.
* @see #resetAllCarrierActions()
*
* @deprecated - use the APIs {@link requestRadioPowerOffForReason} and
* {@link clearRadioPowerOffForReason}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void setRadioEnabled(boolean enabled) {
if (enabled) {
clearRadioPowerOffForReason(RADIO_POWER_REASON_CARRIER);
} else {
requestRadioPowerOffForReason(RADIO_POWER_REASON_CARRIER);
}
}
/**
* No error. Operation succeeded.
* @hide
*/
public static final int ENABLE_VONR_SUCCESS = 0;
/**
* Radio is not available.
* @hide
*/
public static final int ENABLE_VONR_RADIO_NOT_AVAILABLE = 2;
/**
* Internal Radio error.
* @hide
*/
public static final int ENABLE_VONR_RADIO_ERROR = 3;
/**
* Voice over NR enable/disable request is received when system is in invalid state.
* @hide
*/
public static final int ENABLE_VONR_RADIO_INVALID_STATE = 4;
/**
* Voice over NR enable/disable request is not supported.
* @hide
*/
public static final int ENABLE_VONR_REQUEST_NOT_SUPPORTED = 5;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"EnableVoNrResult"}, value = {
ENABLE_VONR_SUCCESS,
ENABLE_VONR_RADIO_NOT_AVAILABLE,
ENABLE_VONR_RADIO_ERROR,
ENABLE_VONR_RADIO_INVALID_STATE,
ENABLE_VONR_REQUEST_NOT_SUPPORTED})
public @interface EnableVoNrResult {}
/**
* Enable or disable Voice over NR (VoNR)
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param enabled enable or disable VoNR.
* @throws IllegalStateException if the Telephony process is not currently available.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public @EnableVoNrResult int setVoNrEnabled(boolean enabled) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.setVoNrEnabled(
getSubId(SubscriptionManager.getDefaultDataSubscriptionId()), enabled);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#setVoNrEnabled", e);
}
return ENABLE_VONR_RADIO_INVALID_STATE;
}
/**
* Is Voice over NR (VoNR) enabled.
* @return true if Voice over NR (VoNR) is enabled else false. Enabled state does not mean
* voice call over NR is active or voice ove NR is available. It means the device is allowed to
* register IMS over NR.
* @throws IllegalStateException if the Telephony process is not currently available.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public boolean isVoNrEnabled() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isVoNrEnabled(getSubId());
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Rlog.e(TAG, "isVoNrEnabled RemoteException", ex);
ex.rethrowFromSystemServer();
}
return false;
}
/**
* Carrier action to start or stop reporting default network available events.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param report control start/stop reporting network status.
* @see #resetAllCarrierActions()
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void reportDefaultNetworkStatus(boolean report) {
try {
ITelephony service = getITelephony();
if (service != null) {
service.carrierActionReportDefaultNetworkStatus(
getSubId(SubscriptionManager.getDefaultDataSubscriptionId()), report);
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#carrierActionReportDefaultNetworkStatus", e);
}
}
/**
* Reset all carrier actions previously set by {@link #setRadioEnabled},
* {@link #reportDefaultNetworkStatus} and {@link #setCarrierDataEnabled}.
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void resetAllCarrierActions() {
try {
ITelephony service = getITelephony();
if (service != null) {
service.carrierActionResetAll(
getSubId(SubscriptionManager.getDefaultDataSubscriptionId()));
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#carrierActionResetAll", e);
}
}
/**
* Policy control of data connection. Usually used when data limit is passed.
* @param enabled True if enabling the data, otherwise disabling.
* @deprecated use {@link #setDataEnabledForReason(int, boolean) with
* reason {@link #DATA_ENABLED_REASON_POLICY}} instead.
* @hide
*/
@Deprecated
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
public void setPolicyDataEnabled(boolean enabled) {
try {
setDataEnabledForReason(DATA_ENABLED_REASON_POLICY, enabled);
} catch (RuntimeException e) {
Log.e(TAG, "Error calling setDataEnabledForReason e:" + e);
}
}
/** @hide */
@IntDef({
DATA_ENABLED_REASON_USER,
DATA_ENABLED_REASON_POLICY,
DATA_ENABLED_REASON_CARRIER,
DATA_ENABLED_REASON_THERMAL
})
@Retention(RetentionPolicy.SOURCE)
public @interface DataEnabledReason{}
/** @hide */
@IntDef({
DATA_ENABLED_REASON_UNKNOWN,
DATA_ENABLED_REASON_USER,
DATA_ENABLED_REASON_POLICY,
DATA_ENABLED_REASON_CARRIER,
DATA_ENABLED_REASON_THERMAL,
DATA_ENABLED_REASON_OVERRIDE
})
@Retention(RetentionPolicy.SOURCE)
public @interface DataEnabledChangedReason{}
/**
* To indicate that data was enabled or disabled due to an unknown reason.
* Note that this is not a valid reason for {@link #setDataEnabledForReason(int, boolean)} and
* is only used to indicate that data enabled was changed.
*/
public static final int DATA_ENABLED_REASON_UNKNOWN = -1;
/**
* To indicate that user enabled or disabled data.
*/
public static final int DATA_ENABLED_REASON_USER = 0;
/**
* To indicate that data control due to policy. Usually used when data limit is passed.
* Policy data on/off won't affect user settings but will bypass the
* settings and turns off data internally if set to {@code false}.
*/
public static final int DATA_ENABLED_REASON_POLICY = 1;
/**
* To indicate enable or disable carrier data by the system based on carrier signalling or
* carrier privileged apps. Carrier data on/off won't affect user settings but will bypass the
* settings and turns off data internally if set to {@code false}.
*/
public static final int DATA_ENABLED_REASON_CARRIER = 2;
/**
* To indicate enable or disable data by thermal service.
* Thermal data on/off won't affect user settings but will bypass the
* settings and turns off data internally if set to {@code false}.
*/
public static final int DATA_ENABLED_REASON_THERMAL = 3;
/**
* To indicate data was enabled or disabled due to mobile data policy overrides.
* Note that this is not a valid reason for {@link #setDataEnabledForReason(int, boolean)} and
* is only used to indicate that data enabled was changed due to an override.
*/
public static final int DATA_ENABLED_REASON_OVERRIDE = 4;
/**
* Control of data connection and provide the reason triggering the data connection control.
* This can be called for following reasons
* If this object has been created with {@link #createForSubscriptionId}, applies
* to the given subId. Otherwise, applies to
* {@link SubscriptionManager#getDefaultDataSubscriptionId()}
*
*
* @param reason the reason the data enable change is taking place
* @param enabled True if enabling the data, otherwise disabling.
*
* Requires Permission:
* The calling app has carrier privileges (see {@link #hasCarrierPrivileges}) if the reason is
* {@link #DATA_ENABLED_REASON_USER} or {@link #DATA_ENABLED_REASON_CARRIER} or the call app
* has {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} irrespective of
* the reason.
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setDataEnabledForReason(@DataEnabledReason int reason, boolean enabled) {
setDataEnabledForReason(getSubId(), reason, enabled);
}
private void setDataEnabledForReason(int subId, @DataEnabledReason int reason,
boolean enabled) {
try {
ITelephony service = getITelephony();
if (service != null) {
service.setDataEnabledForReason(subId, reason, enabled, getOpPackageName());
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "Telephony#setDataEnabledForReason RemoteException", ex);
ex.rethrowFromSystemServer();
}
}
/**
* Return whether data is enabled for certain reason .
*
* If {@link #isDataEnabledForReason} returns false, it means in data enablement for a
* specific reason is turned off. If any of the reason is off, then it will result in
* bypassing user preference and result in data to be turned off. Call
* {@link #isDataConnectionAllowed} in order to know whether
* data connection is allowed on the device.
*
* If this object has been created with {@link #createForSubscriptionId}, applies
* to the given subId. Otherwise, applies to
* {@link SubscriptionManager#getDefaultDataSubscriptionId()}
* @param reason the reason the data enable change is taking place
* @return whether data is enabled for a reason.
* Requires Permission:
* The calling app has carrier privileges (see {@link #hasCarrierPrivileges}) or
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} or
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE} or
* {@link android.Manifest.permission#MODIFY_PHONE_STATE}
* {@link android.Manifest.permission#READ_BASIC_PHONE_STATE}
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresPermission(anyOf = {android.Manifest.permission.ACCESS_NETWORK_STATE,
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.MODIFY_PHONE_STATE,
android.Manifest.permission.READ_BASIC_PHONE_STATE
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isDataEnabledForReason(@DataEnabledReason int reason) {
return isDataEnabledForReason(getSubId(), reason);
}
private boolean isDataEnabledForReason(int subId, @DataEnabledReason int reason) {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.isDataEnabledForReason(subId, reason);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "Telephony#isDataEnabledForReason RemoteException", ex);
ex.rethrowFromSystemServer();
}
return false;
}
/**
* Get Client request stats which will contain statistical information
* on each request made by client.
* Callers require either READ_PRIVILEGED_PHONE_STATE or
* READ_PHONE_STATE to retrieve the information.
* @param subId sub id
* @return List of Client Request Stats
* @hide
*/
public List If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}
*
* @return true if phone is in emergency callback mode.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean getEmergencyCallbackMode() {
return getEmergencyCallbackMode(getSubId());
}
/**
* Check if phone is in emergency callback mode
* @return true if phone is in emergency callback mode
* @param subId the subscription ID that this action applies to.
* @hide
*/
public boolean getEmergencyCallbackMode(int subId) {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
return false;
}
return telephony.getEmergencyCallbackMode(subId);
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getEmergencyCallbackMode", e);
}
return false;
}
/**
* Checks if manual network selection is allowed.
*
* Requires Permission: {@link android.Manifest.permission#READ_PRECISE_PHONE_STATE
* READ_PRECISE_PHONE_STATE} or that the calling app has carrier privileges
* (see {@link #hasCarrierPrivileges})
*
* If this object has been created with {@link #createForSubscriptionId}, applies to the
* given subId. Otherwise, applies to {@link SubscriptionManager#getDefaultSubscriptionId()}.
*
* @return {@code true} if manual network selection is allowed, otherwise return {@code false}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // No support carrier privileges (b/72967236).
@RequiresPermission(anyOf = {android.Manifest.permission.READ_PRECISE_PHONE_STATE,
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean isManualNetworkSelectionAllowed() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isManualNetworkSelectionAllowed(getSubId());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#isManualNetworkSelectionAllowed", e);
}
return true;
}
/**
* Get the most recently available signal strength information.
*
* Get the most recent SignalStrength information reported by the modem. Due
* to power saving this information may not always be current.
* @return the most recent cached signal strength info from the modem
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@Nullable
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public SignalStrength getSignalStrength() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.getSignalStrength(getSubId());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#getSignalStrength", e);
}
return null;
}
/**
* Checks whether cellular data connection is allowed in the device.
*
* Whether cellular data connection is allowed considers all factors below:
*
* "Data capable" means that this device supports packet-switched
* data connections over the telephony network.
*
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isDataCapable() {
if (mContext == null) return true;
return mContext.getResources().getBoolean(
com.android.internal.R.bool.config_mobile_data_capable);
}
/**
* The indication for signal strength update.
* @hide
*/
public static final int INDICATION_FILTER_SIGNAL_STRENGTH = 0x1;
/**
* The indication for full network state update.
* @hide
*/
public static final int INDICATION_FILTER_FULL_NETWORK_STATE = 0x2;
/**
* The indication for data call dormancy changed update.
* @hide
*/
public static final int INDICATION_FILTER_DATA_CALL_DORMANCY_CHANGED = 0x4;
/**
* The indication for link capacity estimate update.
* @hide
*/
public static final int INDICATION_FILTER_LINK_CAPACITY_ESTIMATE = 0x8;
/**
* The indication for physical channel config update.
* @hide
*/
public static final int INDICATION_FILTER_PHYSICAL_CHANNEL_CONFIG = 0x10;
/**
* A test API to override carrier information including mccmnc, imsi, iccid, gid1, gid2,
* plmn and spn. This would be handy for, eg, forcing a particular carrier id, carrier's config
* (also any country or carrier overlays) to be loaded when using a test SIM with a call box.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
*
* @deprecated
* @hide
*/
@Deprecated
@TestApi
public void setCarrierTestOverride(String mccmnc, String imsi, String iccid, String gid1,
String gid2, String plmn, String spn) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setCarrierTestOverride(
getSubId(), mccmnc, imsi, iccid, gid1, gid2, plmn, spn,
null, null);
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
}
/**
* A test API to override carrier information including mccmnc, imsi, iccid, gid1, gid2,
* plmn, spn, apn and carrier priviledge. This would be handy for, eg, forcing a particular
* carrier id, carrier's config (also any country or carrier overlays) to be loaded when using
* a test SIM with a call box.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @hide
*/
@TestApi
public void setCarrierTestOverride(String mccmnc, String imsi, String iccid, String gid1,
String gid2, String plmn, String spn,
String carrierPriviledgeRules, String apn) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setCarrierTestOverride(
getSubId(), mccmnc, imsi, iccid, gid1, gid2, plmn, spn,
carrierPriviledgeRules, apn);
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
}
/**
* A test API to return installed carrier id list version
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
*
* @hide
*/
@UnsupportedAppUsage
@TestApi
public int getCarrierIdListVersion() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getCarrierIdListVersion(getSubId());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return UNKNOWN_CARRIER_ID_LIST_VERSION;
}
/**
* How many modems can have simultaneous data connections.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
public int getNumberOfModemsWithSimultaneousDataConnections() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getNumberOfModemsWithSimultaneousDataConnections(
getSubId(), getOpPackageName(), getAttributionTag());
}
} catch (RemoteException ex) {
// This could happen if binder process crashes.
}
return 0;
}
/**
* Enable or disable OpportunisticNetworkService.
*
* This method should be called to enable or disable
* OpportunisticNetwork service on the device.
*
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @param enable enable(True) or disable(False)
* @return returns true if successfully set.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean setOpportunisticNetworkState(boolean enable) {
String pkgForDebug = mContext != null ? mContext.getOpPackageName() : "
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public boolean isOpportunisticNetworkEnabled() {
String pkgForDebug = mContext != null ? mContext.getOpPackageName() : " Requires permission: android.Manifest.READ_PRIVILEGED_PHONE_STATE or
* that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws SecurityException if the caller does not have the required permission
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NetworkTypeBitMask long getSupportedRadioAccessFamily() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getRadioAccessFamily(getSlotIndex(), getOpPackageName());
} else {
// This can happen when the ITelephony interface is not up yet.
return NETWORK_TYPE_BITMASK_UNKNOWN;
}
} catch (RemoteException ex) {
// This shouldn't happen in the normal case
return NETWORK_TYPE_BITMASK_UNKNOWN;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return NETWORK_TYPE_BITMASK_UNKNOWN;
}
}
/**
* Indicates Emergency number database version is invalid.
*
* @hide
*/
@SystemApi
public static final int INVALID_EMERGENCY_NUMBER_DB_VERSION = -1;
/**
* Notify Telephony for OTA emergency number database installation complete.
*
* Requires permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
@SystemApi
public void notifyOtaEmergencyNumberDbInstalled() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.notifyOtaEmergencyNumberDbInstalled();
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "notifyOtaEmergencyNumberDatabaseInstalled RemoteException", ex);
ex.rethrowAsRuntimeException();
}
}
/**
* Override the file path for OTA emergency number database in a file partition.
*
* @param otaParcelFileDescriptor parcelable file descriptor for OTA emergency number database.
*
* Requires permission:
* {@link android.Manifest.permission#READ_ACTIVE_EMERGENCY_SESSION}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_ACTIVE_EMERGENCY_SESSION)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
@SystemApi
public void updateOtaEmergencyNumberDbFilePath(
@NonNull ParcelFileDescriptor otaParcelFileDescriptor) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.updateOtaEmergencyNumberDbFilePath(otaParcelFileDescriptor);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "updateOtaEmergencyNumberDbFilePath RemoteException", ex);
ex.rethrowAsRuntimeException();
}
}
/**
* Reset the file path to default for OTA emergency number database in a file partition.
*
* Requires permission:
* {@link android.Manifest.permission#READ_ACTIVE_EMERGENCY_SESSION}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_ACTIVE_EMERGENCY_SESSION)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
@SystemApi
public void resetOtaEmergencyNumberDbFilePath() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.resetOtaEmergencyNumberDbFilePath();
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "resetOtaEmergencyNumberDbFilePath RemoteException", ex);
ex.rethrowAsRuntimeException();
}
}
/**
* Returns whether {@link TelephonyManager#ACTION_EMERGENCY_ASSISTANCE emergency assistance} is
* available on the device.
*
* Requires permission: {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE}
*
* @return {@code true} if emergency assistance is available, {@code false} otherwise
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@SuppressWarnings("AndroidFrameworkClientSidePermissionCheck")
@SystemApi
public boolean isEmergencyAssistanceEnabled() {
mContext.enforceCallingOrSelfPermission(
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
"isEmergencyAssistanceEnabled");
return EMERGENCY_ASSISTANCE_ENABLED;
}
/**
* Get the emergency assistance package name.
*
* @return the package name of the emergency assistance app, or {@code null} if no app
* supports emergency assistance.
* @throws IllegalStateException if emergency assistance is not enabled or the device is
* not voice capable.
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@FlaggedApi(android.permission.flags.Flags.FLAG_GET_EMERGENCY_ROLE_HOLDER_API_ENABLED)
@Nullable
@SystemApi
public String getEmergencyAssistancePackageName() {
if (!isEmergencyAssistanceEnabled() || !isVoiceCapable()) {
throw new IllegalStateException("isEmergencyAssistanceEnabled() is false or device"
+ " not voice capable.");
}
return mContext.getSystemService(RoleManager.class)
.getEmergencyRoleHolder(mContext.getUserId());
}
/**
* Get the emergency number list based on current locale, sim, default, modem and network.
*
* In each returned list, the emergency number {@link EmergencyNumber} coming from higher
* priority sources will be located at the smaller index; the priority order of sources are:
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_NETWORK_SIGNALING} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_SIM} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_DATABASE} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_DEFAULT} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_MODEM_CONFIG}
*
* The subscriptions which the returned list would be based on, are all the active
* subscriptions, no matter which subscription could be used to create TelephonyManager.
*
* Requires permission {@link android.Manifest.permission#READ_PHONE_STATE} or the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return Map including the keys as the active subscription IDs (Note: if there is no active
* subscription, the key is {@link SubscriptionManager#getDefaultSubscriptionId}) and the value
* as the list of {@link EmergencyNumber}; empty Map if this information is not available;
* or throw a SecurityException if the caller does not have the permission.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@NonNull
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public Map In each returned list, the emergency number {@link EmergencyNumber} coming from higher
* priority sources will be located at the smaller index; the priority order of sources are:
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_NETWORK_SIGNALING} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_SIM} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_DATABASE} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_DEFAULT} >
* {@link EmergencyNumber#EMERGENCY_NUMBER_SOURCE_MODEM_CONFIG}
*
* The subscriptions which the returned list would be based on, are all the active
* subscriptions, no matter which subscription could be used to create TelephonyManager.
*
* Requires permission {@link android.Manifest.permission#READ_PHONE_STATE} or the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param categories the emergency service categories which are the bitwise-OR combination of
* the following constants:
* This method assumes that only dialable phone numbers are passed in; non-dialable
* numbers are not considered emergency numbers. A dialable phone number consists only
* of characters/digits identified by {@link PhoneNumberUtils#isDialable(char)}.
*
* The subscriptions which the identification would be based on, are all the active
* subscriptions, no matter which subscription could be used to create TelephonyManager.
*
* @param number - the number to look up
* @return {@code true} if the given number is an emergency number based on current locale,
* SIM card(s), Android database, modem, network or defaults; {@code false} otherwise.
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean isEmergencyNumber(@NonNull String number) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isEmergencyNumber(number, true);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "isEmergencyNumber RemoteException", ex);
ex.rethrowAsRuntimeException();
}
return false;
}
/**
* Checks if the supplied number is an emergency number based on current locale, sim, default,
* modem and network.
*
* Specifically, this method will return {@code true} if the specified number is an
* emergency number, *or* if the number simply starts with the same digits as any current
* emergency number.
*
* The subscriptions which the identification would be based on, are all the active
* subscriptions, no matter which subscription could be used to create TelephonyManager.
*
* Requires permission: {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE} or
* that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @param number - the number to look up
* @return {@code true} if the given number is an emergency number or it simply starts with
* the same digits of any current emergency number based on current locale, sim, modem and
* network; {@code false} if it is not; or throw an SecurityException if the caller does not
* have the required permission/privileges
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*
* @deprecated Please use {@link TelephonyManager#isEmergencyNumber(String)} instead.
* @hide
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public boolean isPotentialEmergencyNumber(@NonNull String number) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isEmergencyNumber(number, false);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Log.e(TAG, "isEmergencyNumber RemoteException", ex);
ex.rethrowAsRuntimeException();
}
return false;
}
/**
* Returns the emergency number database version.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public int getEmergencyNumberDbVersion() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getEmergencyNumberDbVersion(getSubId());
}
} catch (RemoteException ex) {
Log.e(TAG, "getEmergencyNumberDbVersion RemoteException", ex);
ex.rethrowAsRuntimeException();
}
return INVALID_EMERGENCY_NUMBER_DB_VERSION;
}
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"SET_OPPORTUNISTIC_SUB"}, value = {
SET_OPPORTUNISTIC_SUB_SUCCESS,
SET_OPPORTUNISTIC_SUB_VALIDATION_FAILED,
SET_OPPORTUNISTIC_SUB_INACTIVE_SUBSCRIPTION,
SET_OPPORTUNISTIC_SUB_NO_OPPORTUNISTIC_SUB_AVAILABLE,
SET_OPPORTUNISTIC_SUB_REMOTE_SERVICE_EXCEPTION})
public @interface SetOpportunisticSubscriptionResult {}
/**
* No error. Operation succeeded.
*/
public static final int SET_OPPORTUNISTIC_SUB_SUCCESS = 0;
/**
* Validation failed when trying to switch to preferred subscription.
*/
public static final int SET_OPPORTUNISTIC_SUB_VALIDATION_FAILED = 1;
/**
* The subscription is not valid. It must be an active opportunistic subscription.
*/
public static final int SET_OPPORTUNISTIC_SUB_INACTIVE_SUBSCRIPTION = 2;
/**
* The subscription is not valid. It must be an opportunistic subscription.
*/
public static final int SET_OPPORTUNISTIC_SUB_NO_OPPORTUNISTIC_SUB_AVAILABLE = 3;
/**
* Subscription service happened remote exception.
*/
public static final int SET_OPPORTUNISTIC_SUB_REMOTE_SERVICE_EXCEPTION = 4;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"UPDATE_AVAILABLE_NETWORKS"}, value = {
UPDATE_AVAILABLE_NETWORKS_SUCCESS,
UPDATE_AVAILABLE_NETWORKS_UNKNOWN_FAILURE,
UPDATE_AVAILABLE_NETWORKS_ABORTED,
UPDATE_AVAILABLE_NETWORKS_INVALID_ARGUMENTS,
UPDATE_AVAILABLE_NETWORKS_NO_CARRIER_PRIVILEGE,
UPDATE_AVAILABLE_NETWORKS_DISABLE_MODEM_FAIL,
UPDATE_AVAILABLE_NETWORKS_ENABLE_MODEM_FAIL,
UPDATE_AVAILABLE_NETWORKS_MULTIPLE_NETWORKS_NOT_SUPPORTED,
UPDATE_AVAILABLE_NETWORKS_NO_OPPORTUNISTIC_SUB_AVAILABLE,
UPDATE_AVAILABLE_NETWORKS_REMOTE_SERVICE_EXCEPTION,
UPDATE_AVAILABLE_NETWORKS_SERVICE_IS_DISABLED,
UPDATE_AVAILABLE_NETWORKS_SIM_PORT_NOT_AVAILABLE})
public @interface UpdateAvailableNetworksResult {}
/**
* No error. Operation succeeded.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_SUCCESS = 0;
/**
* There is a unknown failure happened.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_UNKNOWN_FAILURE = 1;
/**
* The request is aborted.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_ABORTED = 2;
/**
* The parameter passed in is invalid.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_INVALID_ARGUMENTS = 3;
/**
* No carrier privilege.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_NO_CARRIER_PRIVILEGE = 4;
/**
* Disable modem fail.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_DISABLE_MODEM_FAIL = 5;
/**
* Enable modem fail.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_ENABLE_MODEM_FAIL = 6;
/**
* Carrier app does not support multiple available networks.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_MULTIPLE_NETWORKS_NOT_SUPPORTED = 7;
/**
* The subscription is not valid. It must be an opportunistic subscription.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_NO_OPPORTUNISTIC_SUB_AVAILABLE = 8;
/**
* There is no OpportunisticNetworkService.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_REMOTE_SERVICE_EXCEPTION = 9;
/**
* OpportunisticNetworkService is disabled.
*/
public static final int UPDATE_AVAILABLE_NETWORKS_SERVICE_IS_DISABLED = 10;
/**
* SIM port is not available to switch to opportunistic subscription.
* @hide
*/
public static final int UPDATE_AVAILABLE_NETWORKS_SIM_PORT_NOT_AVAILABLE = 11;
/**
* Set preferred opportunistic data subscription id.
*
* Switch internet data to preferred opportunistic data subscription id. This api
* can result in lose of internet connectivity for short period of time while internet data
* is handed over.
* Requires that the calling app has carrier privileges on both primary and
* secondary subscriptions (see
* {@link #hasCarrierPrivileges}), or has permission
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}.
*
* @param subId which opportunistic subscription
* {@link SubscriptionManager#getOpportunisticSubscriptions} is preferred for cellular data.
* Pass {@link SubscriptionManager#DEFAULT_SUBSCRIPTION_ID} to unset the preference
* @param needValidation whether validation is needed before switch happens.
* @param executor The executor of where the callback will execute.
* @param callback Callback will be triggered once it succeeds or failed.
* See the {@code SET_OPPORTUNISTIC_SUB_*} constants
* for more details. Pass null if don't care about the result.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public void setPreferredOpportunisticDataSubscription(int subId, boolean needValidation,
@Nullable @CallbackExecutor Executor executor, @Nullable Consumer Requires that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}),
* or has either READ_PRIVILEGED_PHONE_STATE
* or {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} permission.
* @return subId preferred opportunistic subscription id or
* {@link SubscriptionManager#DEFAULT_SUBSCRIPTION_ID} if there are no preferred
* subscription id
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresPermission(anyOf = {
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_PHONE_STATE
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public int getPreferredOpportunisticDataSubscription() {
String packageName = mContext != null ? mContext.getOpPackageName() : " Requires Permission:
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE},
* READ_PRIVILEGED_PHONE_STATE or that the calling app has carrier privileges (see
* {@link #hasCarrierPrivileges()}).
*
* @param slotIndex which slot it's checking.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(anyOf = {android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY)
public boolean isModemEnabledForSlot(int slotIndex) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isModemEnabledForSlot(slotIndex, mContext.getOpPackageName(),
mContext.getAttributionTag());
}
} catch (RemoteException ex) {
Log.e(TAG, "enableModem RemoteException", ex);
}
return false;
}
/**
* Broadcast intent action for network country code changes.
*
*
* The {@link #EXTRA_NETWORK_COUNTRY} extra indicates the country code of the current
* network returned by {@link #getNetworkCountryIso()}.
*
* There may be a delay of several minutes before reporting that no country is detected.
*
* @see #EXTRA_NETWORK_COUNTRY
* @see #getNetworkCountryIso()
*/
public static final String ACTION_NETWORK_COUNTRY_CHANGED =
"android.telephony.action.NETWORK_COUNTRY_CHANGED";
/**
* The extra used with an {@link #ACTION_NETWORK_COUNTRY_CHANGED} to specify the
* the country code in ISO-3166-1 alpha-2 format. This is the same country code returned by
* {@link #getNetworkCountryIso()}. This might be an empty string when the country code is not
* available.
*
*
* Retrieve with {@link android.content.Intent#getStringExtra(String)}.
*/
public static final String EXTRA_NETWORK_COUNTRY =
"android.telephony.extra.NETWORK_COUNTRY";
/**
* The extra used with an {@link #ACTION_NETWORK_COUNTRY_CHANGED} to specify the
* last known the country code in ISO-3166-1 alpha-2 format. This might be an empty string when
* the country code was never available. The last known country code persists across reboot.
*
*
* Retrieve with {@link android.content.Intent#getStringExtra(String)}.
*/
public static final String EXTRA_LAST_KNOWN_NETWORK_COUNTRY =
"android.telephony.extra.LAST_KNOWN_NETWORK_COUNTRY";
/**
* Indicate if the user is allowed to use multiple SIM cards at the same time to register
* on the network (e.g. Dual Standby or Dual Active) when the device supports it, or if the
* usage is restricted. This API is used to prevent usage of multiple SIM card, based on
* policies of the carrier.
* Note: the API does not prevent access to the SIM cards for operations that don't require
* access to the network.
*
* @param isMultiSimCarrierRestricted true if usage of multiple SIMs is restricted, false
* otherwise.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CARRIERLOCK}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CARRIERLOCK)
public void setMultiSimCarrierRestriction(boolean isMultiSimCarrierRestricted) {
try {
ITelephony service = getITelephony();
if (service != null) {
service.setMultiSimCarrierRestriction(isMultiSimCarrierRestricted);
}
} catch (RemoteException e) {
Log.e(TAG, "setMultiSimCarrierRestriction RemoteException", e);
}
}
/**
* The usage of multiple SIM cards at the same time to register on the network (e.g. Dual
* Standby or Dual Active) is supported.
*/
public static final int MULTISIM_ALLOWED = 0;
/**
* The usage of multiple SIM cards at the same time to register on the network (e.g. Dual
* Standby or Dual Active) is not supported by the hardware.
*/
public static final int MULTISIM_NOT_SUPPORTED_BY_HARDWARE = 1;
/**
* The usage of multiple SIM cards at the same time to register on the network (e.g. Dual
* Standby or Dual Active) is supported by the hardware, but restricted by the carrier.
*/
public static final int MULTISIM_NOT_SUPPORTED_BY_CARRIER = 2;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"MULTISIM_"},
value = {
MULTISIM_ALLOWED,
MULTISIM_NOT_SUPPORTED_BY_HARDWARE,
MULTISIM_NOT_SUPPORTED_BY_CARRIER
})
public @interface IsMultiSimSupportedResult {}
/**
* Returns if the usage of multiple SIM cards at the same time to register on the network
* (e.g. Dual Standby or Dual Active) is supported by the device and by the carrier.
*
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return {@link #MULTISIM_ALLOWED} if the device supports multiple SIMs.
* {@link #MULTISIM_NOT_SUPPORTED_BY_HARDWARE} if the device does not support multiple SIMs.
* {@link #MULTISIM_NOT_SUPPORTED_BY_CARRIER} in the device supports multiple SIMs, but the
* functionality is restricted by the carrier.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@IsMultiSimSupportedResult
public int isMultiSimSupported() {
if (getSupportedModemCount() < 2) {
return TelephonyManager.MULTISIM_NOT_SUPPORTED_BY_HARDWARE;
}
try {
ITelephony service = getITelephony();
if (service != null) {
return service.isMultiSimSupported(getOpPackageName(), getAttributionTag());
}
} catch (RemoteException e) {
Log.e(TAG, "isMultiSimSupported RemoteException", e);
}
return MULTISIM_NOT_SUPPORTED_BY_HARDWARE;
}
/**
* Switch configs to enable multi-sim or switch back to single-sim
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* Note: with only carrier privileges, it is not allowed to switch from multi-sim
* to single-sim
*
* @param numOfSims number of live SIMs we want to switch to
* @throws android.os.RemoteException
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void switchMultiSimConfig(int numOfSims) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.switchMultiSimConfig(numOfSims);
}
} catch (RemoteException ex) {
Rlog.e(TAG, "switchMultiSimConfig RemoteException", ex);
}
}
/**
* Get whether making changes to modem configurations by {@link #switchMultiSimConfig(int)} will
* trigger device reboot.
* The modem configuration change refers to switching from single SIM configuration to DSDS
* or the other way around.
*
* Requires Permission:
* {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} or that the
* calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return {@code true} if reboot will be triggered after making changes to modem
* configurations, otherwise return {@code false}.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresPermission(Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public boolean doesSwitchMultiSimConfigTriggerReboot() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.doesSwitchMultiSimConfigTriggerReboot(getSubId(),
getOpPackageName(), getAttributionTag());
}
} catch (RemoteException e) {
Log.e(TAG, "doesSwitchMultiSimConfigTriggerReboot RemoteException", e);
}
return false;
}
/**
* Retrieve the Radio HAL Version for this device.
*
* Get the HAL version for the IRadio interface for test purposes.
*
* @return a Pair of (major version, minor version) or (-1,-1) if unknown.
*
* @hide
*
* @deprecated Use {@link #getHalVersion} instead.
*/
@Deprecated
@UnsupportedAppUsage
@TestApi
public Pair Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return a list of {@link RadioAccessSpecifier}, or an empty list if no bands are specified.
* @throws IllegalStateException if the Telephony process is not currently available.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @NonNull List Requires Permission:
* {@link android.Manifest.permission#READ_PRIVILEGED_PHONE_STATE READ_PRIVILEGED_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@WorkerThread
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
public boolean isIccLockEnabled() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isIccLockEnabled(getSubId());
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "isIccLockEnabled RemoteException", e);
e.rethrowFromSystemServer();
}
return false;
}
/**
* Enable or disable the ICC PIN lock.
*
* @param enabled "true" for locked, "false" for unlocked.
* @param pin needed to change the ICC PIN lock, aka. Pin1.
* @return the result of enabling or disabling the ICC PIN lock.
* @throws SecurityException if the caller doesn't have the permission.
* @throws IllegalStateException if the Telephony process is not currently available.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@NonNull
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public PinResult setIccLockEnabled(boolean enabled, @NonNull String pin) {
checkNotNull(pin, "setIccLockEnabled pin can't be null.");
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
int result = telephony.setIccLockEnabled(getSubId(), enabled, pin);
if (result == CHANGE_ICC_LOCK_SUCCESS) {
return new PinResult(PinResult.PIN_RESULT_TYPE_SUCCESS, 0);
} else if (result < 0) {
return PinResult.getDefaultFailedResult();
} else {
return new PinResult(PinResult.PIN_RESULT_TYPE_INCORRECT, result);
}
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "setIccLockEnabled RemoteException", e);
e.rethrowFromSystemServer();
}
return PinResult.getDefaultFailedResult();
}
/**
* Change the ICC lock PIN.
*
* @param oldPin is the old PIN
* @param newPin is the new PIN
* @return The result of changing the ICC lock PIN.
* @throws SecurityException if the caller doesn't have the permission.
* @throws IllegalStateException if the Telephony process is not currently available.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} or that the calling
* app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@NonNull
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public PinResult changeIccLockPin(@NonNull String oldPin, @NonNull String newPin) {
checkNotNull(oldPin, "changeIccLockPin oldPin can't be null.");
checkNotNull(newPin, "changeIccLockPin newPin can't be null.");
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
int result = telephony.changeIccLockPassword(getSubId(), oldPin, newPin);
if (result == CHANGE_ICC_LOCK_SUCCESS) {
return new PinResult(PinResult.PIN_RESULT_TYPE_SUCCESS, 0);
} else if (result < 0) {
return PinResult.getDefaultFailedResult();
} else {
return new PinResult(PinResult.PIN_RESULT_TYPE_INCORRECT, result);
}
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException e) {
Log.e(TAG, "changeIccLockPin RemoteException", e);
e.rethrowFromSystemServer();
}
return PinResult.getDefaultFailedResult();
}
/**
* Called when userActivity is signalled in the power manager.
* This should only be called from system Uid.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
public void notifyUserActivity() {
try {
ITelephony service = getITelephony();
if (service != null) {
service.userActivity();
}
} catch (RemoteException e) {
// one-way notification, if telephony is not available, it is okay to not throw
// exception here.
Log.w(TAG, "notifyUserActivity exception: " + e.getMessage());
}
}
/**
* No error. Operation succeeded.
* @hide
*/
@SystemApi
public static final int ENABLE_NR_DUAL_CONNECTIVITY_SUCCESS = 0;
/**
* NR Dual connectivity enablement is not supported.
* @hide
*/
@SystemApi
public static final int ENABLE_NR_DUAL_CONNECTIVITY_NOT_SUPPORTED = 1;
/**
* Radio is not available.
* @hide
*/
@SystemApi
public static final int ENABLE_NR_DUAL_CONNECTIVITY_RADIO_NOT_AVAILABLE = 2;
/**
* Internal Radio error.
* @hide
*/
@SystemApi
public static final int ENABLE_NR_DUAL_CONNECTIVITY_RADIO_ERROR = 3;
/**
* Currently in invalid state. Not able to process the request.
* @hide
*/
@SystemApi
public static final int ENABLE_NR_DUAL_CONNECTIVITY_INVALID_STATE = 4;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"ENABLE_NR_DUAL_CONNECTIVITY"}, value = {
ENABLE_NR_DUAL_CONNECTIVITY_SUCCESS,
ENABLE_NR_DUAL_CONNECTIVITY_NOT_SUPPORTED,
ENABLE_NR_DUAL_CONNECTIVITY_INVALID_STATE,
ENABLE_NR_DUAL_CONNECTIVITY_RADIO_NOT_AVAILABLE,
ENABLE_NR_DUAL_CONNECTIVITY_RADIO_ERROR})
public @interface EnableNrDualConnectivityResult {}
/**
* Enable NR dual connectivity. Enabled state does not mean dual connectivity
* is active. It means device is allowed to connect to both primary and secondary.
*
* @hide
*/
@SystemApi
public static final int NR_DUAL_CONNECTIVITY_ENABLE = 1;
/**
* Disable NR dual connectivity. Disabled state does not mean the secondary cell is released.
* Modem will release it only if the current bearer is released to avoid radio link failure.
* @hide
*/
@SystemApi
public static final int NR_DUAL_CONNECTIVITY_DISABLE = 2;
/**
* Disable NR dual connectivity and force the secondary cell to be released if dual connectivity
* was active. This will result in radio link failure.
* @hide
*/
@SystemApi
public static final int NR_DUAL_CONNECTIVITY_DISABLE_IMMEDIATE = 3;
/**
* @hide
*/
@IntDef(prefix = { "NR_DUAL_CONNECTIVITY_" }, value = {
NR_DUAL_CONNECTIVITY_ENABLE,
NR_DUAL_CONNECTIVITY_DISABLE,
NR_DUAL_CONNECTIVITY_DISABLE_IMMEDIATE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface NrDualConnectivityState {
}
/**
* Enable/Disable E-UTRA-NR Dual Connectivity.
*
* This api is supported only if
* {@link android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported}
* ({@link TelephonyManager#CAPABILITY_NR_DUAL_CONNECTIVITY_CONFIGURATION_AVAILABLE})
* returns true.
* @param nrDualConnectivityState expected NR dual connectivity state
* This can be passed following states
* Requires Permission: {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
* or that the calling app has carrier privileges (see {@link #hasCarrierPrivileges}).
*
* @return A list of equivalent home PLMNs. Returns an empty list if EF_EHPLMN is empty or
* does not exist on the SIM card.
*
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws SecurityException if the caller doesn't have the permission.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @NonNull List If {@link android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported}({@link
* #CAPABILITY_THERMAL_MITIGATION_DATA_THROTTLING}) returns false, then sending a {@link
* DataThrottlingRequest#DATA_THROTTLING_ACTION_HOLD}, {@link
* DataThrottlingRequest#DATA_THROTTLING_ACTION_THROTTLE_SECONDARY_CARRIER}, or {@link
* DataThrottlingRequest#DATA_THROTTLING_ACTION_THROTTLE_PRIMARY_CARRIER} will result in {@link
* IllegalArgumentException} being thrown. However, on devices that do not
* support data throttling, {@link
* DataThrottlingRequest#DATA_THROTTLING_ACTION_NO_DATA_THROTTLING} can still be requested in
* order to undo the mitigations above it (i.e {@link
* ThermalMitigationRequest#THERMAL_MITIGATION_ACTION_VOICE_ONLY} and/or {@link
* ThermalMitigationRequest#THERMAL_MITIGATION_ACTION_RADIO_OFF}). In addition to the {@link Manifest.permission#MODIFY_PHONE_STATE} permission, callers of
* this API must also be listed in the device configuration as an authorized app in
* {@code packages/services/Telephony/res/values/config.xml} under the
* {@code thermal_mitigation_allowlisted_packages} key.
* To register a callback, pass a {@link TelephonyCallback} which implements
* interfaces of events. For example,
* FakeServiceStateCallback extends {@link TelephonyCallback} implements
* {@link TelephonyCallback.ServiceStateListener}.
*
* At registration, and when a specified telephony state changes, the telephony manager invokes
* the appropriate callback method on the callback object and passes the current (updated)
* values.
*
* Note: Be aware of the permission requirements stated on the {@link TelephonyCallback}
* listeners you implement. Your application must be granted these permissions in order to
* register a {@link TelephonyCallback} which requires them; a {@link SecurityException} will be
* thrown if you do not hold the required permissions for all {@link TelephonyCallback}
* listeners you implement.
*
* If this TelephonyManager object has been created with {@link #createForSubscriptionId},
* applies to the given subId. Otherwise, applies to
* {@link SubscriptionManager#getDefaultSubscriptionId()}. To register events for multiple
* subIds, pass a separate callback object to each TelephonyManager object created with
* {@link #createForSubscriptionId}.
*
* Note: if you call this method while in the middle of a binder transaction, you must
* call {@link android.os.Binder#clearCallingIdentity()} before calling this method. A
* {@link SecurityException} will be thrown otherwise.
*
* This API should be used sparingly -- large numbers of callbacks will cause system
* instability. If a process has registered too many callbacks without unregistering them, it
* may encounter an {@link IllegalStateException} when trying to register more callbacks.
*
* @param executor The executor of where the callback will execute.
* @param callback The {@link TelephonyCallback} object to register. The caller should hold a
* reference to the callback. The framework only holds a weak reference.
*/
public void registerTelephonyCallback(@NonNull @CallbackExecutor Executor executor,
@NonNull TelephonyCallback callback) {
registerTelephonyCallback(getLocationData(), executor, callback);
}
private int getLocationData() {
boolean renounceCoarseLocation =
getRenouncedPermissions().contains(Manifest.permission.ACCESS_COARSE_LOCATION);
boolean renounceFineLocation =
getRenouncedPermissions().contains(Manifest.permission.ACCESS_FINE_LOCATION);
if (renounceCoarseLocation) {
return INCLUDE_LOCATION_DATA_NONE;
} else if (renounceFineLocation) {
return INCLUDE_LOCATION_DATA_COARSE;
} else {
return INCLUDE_LOCATION_DATA_FINE;
}
}
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"INCLUDE_LOCATION_DATA_"}, value = {
INCLUDE_LOCATION_DATA_NONE,
INCLUDE_LOCATION_DATA_COARSE,
INCLUDE_LOCATION_DATA_FINE})
public @interface IncludeLocationData {}
/**
* Specifies to not include any location related data.
*
* Indicates whether the caller would not like to receive
* location related information which will be sent if the caller already possess
* {@link android.Manifest.permission#ACCESS_COARSE_LOCATION} and do not renounce the
* permissions.
*/
public static final int INCLUDE_LOCATION_DATA_NONE = 0;
/**
* Include coarse location data.
*
* Indicates whether the caller would not like to receive
* location related information which will be sent if the caller already possess
* {@link android.Manifest.permission#ACCESS_COARSE_LOCATION} and do not renounce the
* permissions.
*/
public static final int INCLUDE_LOCATION_DATA_COARSE = 1;
/**
* Include fine location data.
*
* Indicates whether the caller would not like to receive
* location related information which will be sent if the caller already possess
* {@link android.Manifest.permission#ACCESS_FINE_LOCATION} and do not renounce the
* permissions.
*/
public static final int INCLUDE_LOCATION_DATA_FINE = 2;
/**
* Registers a callback object to receive notification of changes in specified telephony states.
*
* To register a callback, pass a {@link TelephonyCallback} which implements
* interfaces of events. For example,
* FakeServiceStateCallback extends {@link TelephonyCallback} implements
* {@link TelephonyCallback.ServiceStateListener}.
*
* At registration, and when a specified telephony state changes, the telephony manager invokes
* the appropriate callback method on the callback object and passes the current (updated)
* values.
*
*
* If this TelephonyManager object has been created with {@link #createForSubscriptionId},
* applies to the given subId. Otherwise, applies to
* {@link SubscriptionManager#getDefaultSubscriptionId()}. To register events for multiple
* subIds, pass a separate callback object to each TelephonyManager object created with
* {@link #createForSubscriptionId}.
*
* Note: if you call this method while in the middle of a binder transaction, you must
* call {@link android.os.Binder#clearCallingIdentity()} before calling this method. A
* {@link SecurityException} will be thrown otherwise.
*
* This API should be used sparingly -- large numbers of callbacks will cause system
* instability. If a process has registered too many callbacks without unregistering them, it
* may encounter an {@link IllegalStateException} when trying to register more callbacks.
*
*
* There's another way to renounce permissions with a custom context
* {@code AttributionSource.Builder#setRenouncedPermissions(Set The caller should retry a message that failed with this response.
* @hide
*/
@SystemApi
public static final int GBA_FAILURE_REASON_UNKNOWN = 0;
/**
* GBA Authentication is not supported by the carrier, SIM or android.
*
* Application should use other authentication mechanisms if possible.
* @hide
*/
@SystemApi
public static final int GBA_FAILURE_REASON_FEATURE_NOT_SUPPORTED = 1;
/**
* GBA Authentication service is not ready for use.
*
* Application could try again at a later time.
* @hide
*/
@SystemApi
public static final int GBA_FAILURE_REASON_FEATURE_NOT_READY = 2;
/**
* GBA Authentication has been failed by the network.
* @hide
*/
@SystemApi
public static final int GBA_FAILURE_REASON_NETWORK_FAILURE = 3;
/**
* GBA Authentication has failed due to incorrect NAF URL.
* @hide
*/
@SystemApi
public static final int GBA_FAILURE_REASON_INCORRECT_NAF_ID = 4;
/**
* GBA Authentication has failed due to unsupported security protocol
* @hide
*/
@SystemApi
public static final int GBA_FAILURE_REASON_SECURITY_PROTOCOL_NOT_SUPPORTED = 5;
/**
* The callback associated with a {@link #bootstrapAuthenticationRequest()}.
* @hide
*/
@SystemApi
public static class BootstrapAuthenticationCallback {
/**
* Invoked when the previously requested GBA keys are available (@see
* bootstrapAuthenticationRequest()).
* @param gbaKey Ks_NAF/Ks_ext_NAF Response
* @param transactionId Bootstrapping Transaction Identifier
*/
public void onKeysAvailable(@NonNull byte[] gbaKey, @NonNull String transactionId) {}
/**
* @param reason The reason for the authentication failure.
*/
public void onAuthenticationFailure(@AuthenticationFailureReason int reason) {}
}
/**
* Used to get the Generic Bootstrapping Architecture authentication keys
* KsNAF/Ks_ext_NAF for a particular NAF as defined in 3GPP spec TS 33.220 for
* the specified sub id.
*
* Application must be prepared to wait for receiving the Gba keys through the
* registered callback and not invoke the API on the main application thread.
* Application also must call the api to get the fresh key every time instead
* of caching the key.
*
* Following steps may be invoked on the API call depending on the state of the
* underlying GBA implementation:
* Requires Permission:
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
* or that the calling app has carrier privileges (see
* {@link TelephonyManager#hasCarrierPrivileges}).
*
* Note that the thresholds in the request will be used on a best-effort basis; the system may
* modify requests to multiplex various request sources or to optimize power consumption. The
* caller should not expect to be notified with the exactly the same thresholds.
*
* @see #clearSignalStrengthUpdateRequest(SignalStrengthUpdateRequest)
*
* @param request the SignalStrengthUpdateRequest to be set into the System
*
* @throws IllegalStateException if a new request is set with same subId from the same caller
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void setSignalStrengthUpdateRequest(@NonNull SignalStrengthUpdateRequest request) {
Objects.requireNonNull(request, "request must not be null");
try {
ITelephony service = getITelephony();
if (service != null) {
service.setSignalStrengthUpdateRequest(getSubId(), request, getOpPackageName());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#setSignalStrengthUpdateRequest", e);
}
}
/**
* Clear a {@link SignalStrengthUpdateRequest} from the system.
*
* Requires Permission:
* {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}
* or that the calling app has carrier privileges (see
* {@link TelephonyManager#hasCarrierPrivileges}).
*
* If the given request was not set before, this operation is a no-op.
*
* @see #setSignalStrengthUpdateRequest(SignalStrengthUpdateRequest)
*
* @param request the SignalStrengthUpdateRequest to be cleared from the System
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public void clearSignalStrengthUpdateRequest(@NonNull SignalStrengthUpdateRequest request) {
Objects.requireNonNull(request, "request must not be null");
try {
ITelephony service = getITelephony();
if (service != null) {
service.clearSignalStrengthUpdateRequest(getSubId(), request, getOpPackageName());
}
} catch (RemoteException e) {
Log.e(TAG, "Error calling ITelephony#clearSignalStrengthUpdateRequest", e);
}
}
/**
* Gets the current phone capability.
*
* @return the PhoneCapability which describes the data connection capability of modem.
* It's used to evaluate possible phone config change, for example from single
* SIM device to multi-SIM device.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public @NonNull PhoneCapability getPhoneCapability() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getPhoneCapability();
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
ex.rethrowAsRuntimeException();
}
if (getActiveModemCount() > 1) {
return PhoneCapability.DEFAULT_DSDS_CAPABILITY;
} else {
return PhoneCapability.DEFAULT_SSSS_CAPABILITY;
}
}
/**
* The unattended reboot was prepared successfully.
* @hide
*/
@SystemApi
public static final int PREPARE_UNATTENDED_REBOOT_SUCCESS = 0;
/**
* The unattended reboot was prepared, but the user will need to manually
* enter the PIN code of at least one SIM card present in the device.
* @hide
*/
@SystemApi
public static final int PREPARE_UNATTENDED_REBOOT_PIN_REQUIRED = 1;
/**
* The unattended reboot was not prepared due to a non-recoverable error. After this error,
* the client that manages the unattended reboot should not try to invoke the API again
* until the next power cycle.
* @hide
*/
@SystemApi
public static final int PREPARE_UNATTENDED_REBOOT_ERROR = 2;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"PREPARE_UNATTENDED_REBOOT_"},
value = {
PREPARE_UNATTENDED_REBOOT_SUCCESS,
PREPARE_UNATTENDED_REBOOT_PIN_REQUIRED,
PREPARE_UNATTENDED_REBOOT_ERROR
})
public @interface PrepareUnattendedRebootResult {}
/**
* Prepare TelephonyManager for an unattended reboot. The reboot is required to be done
* shortly (e.g. within 15 seconds) after the API is invoked.
*
* Requires Permission:
* {@link android.Manifest.permission#REBOOT}
*
* @return {@link #PREPARE_UNATTENDED_REBOOT_SUCCESS} in case of success.
* {@link #PREPARE_UNATTENDED_REBOOT_PIN_REQUIRED} if the device contains
* at least one SIM card for which the user needs to manually enter the PIN
* code after the reboot. {@link #PREPARE_UNATTENDED_REBOOT_ERROR} in case
* of error.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.REBOOT)
@PrepareUnattendedRebootResult
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public int prepareForUnattendedReboot() {
try {
ITelephony service = getITelephony();
if (service != null) {
return service.prepareForUnattendedReboot();
}
} catch (RemoteException e) {
Log.e(TAG, "Telephony#prepareForUnattendedReboot RemoteException", e);
e.rethrowFromSystemServer();
}
return PREPARE_UNATTENDED_REBOOT_ERROR;
}
/**
* Exception that may be supplied to the callback in {@link #getNetworkSlicingConfiguration} if
* something goes awry.
*/
public static class NetworkSlicingException extends Exception {
/**
* Getting the current slicing configuration successfully. Used internally only.
* @hide
*/
public static final int SUCCESS = 0;
/**
* The system timed out waiting for a response from the Radio.
* @hide
*/
public static final int ERROR_TIMEOUT = 1;
/**
* The modem returned a failure.
* @hide
*/
public static final int ERROR_MODEM_ERROR = 2;
/** @hide */
@IntDef(prefix = {"ERROR_"}, value = {
ERROR_TIMEOUT,
ERROR_MODEM_ERROR,
})
@Retention(RetentionPolicy.SOURCE)
public @interface NetworkSlicingError {}
private final int mErrorCode;
/** @hide */
public NetworkSlicingException(@NetworkSlicingError int errorCode) {
mErrorCode = errorCode;
}
@Override
public String toString() {
switch (mErrorCode) {
case ERROR_TIMEOUT: return "ERROR_TIMEOUT";
case ERROR_MODEM_ERROR: return "ERROR_MODEM_ERROR";
default: return "UNDEFINED";
}
}
}
/**
* Exception that is supplied to the callback in {@link #getNetworkSlicingConfiguration} if the
* system timed out waiting for a response from the Radio.
*/
public class TimeoutException extends NetworkSlicingException {
/** @hide */
public TimeoutException(int errorCode) {
super(errorCode);
}
}
/**
* Exception that is supplied to the callback in {@link #getNetworkSlicingConfiguration} if the
* modem returned a failure.
*/
public class ModemErrorException extends NetworkSlicingException {
/** @hide */
public ModemErrorException(int errorCode) {
super(errorCode);
}
}
/** @hide */
public static final String KEY_SLICING_CONFIG_HANDLE = "slicing_config_handle";
/**
* Request to get the current slicing configuration including URSP rules and
* NSSAIs (configured, allowed and rejected).
*
* This method can be invoked if one of the following requirements is met:
* Of note, when multiple callbacks are registered, they may be triggered one after another.
* The ordering of them is not guaranteed and thus should not be depend on.
*
* @hide
*/
@SystemApi
public interface CarrierPrivilegesCallback {
/**
* Called when the set of packages with carrier privileges has changed.
*
* Of note, this callback will not be fired if a carrier triggers a SIM profile
* switch and the same set of packages remains privileged after the switch.
*
* At registration, the callback will receive the current set of privileged packages.
*
* @param privilegedPackageNames The updated set of package names that have carrier
* privileges
* @param privilegedUids The updated set of UIDs that have carrier privileges
*/
void onCarrierPrivilegesChanged(
@NonNull Set This method does nothing by default. Clients that are interested in the carrier
* service change should override this method to get package name and UID info.
*
* At registration, the callback will receive the current carrier service info.
*
* Of note, this callback will not be fired if a carrier triggers a SIM profile
* switch and the same carrier service remains after switch.
*
* @param carrierServicePackageName package name of the {@link CarrierService}. May be
* {@code null} when no carrier service is detected.
* @param carrierServiceUid UID of the {@link CarrierService}. May be
* {@link android.os.Process#INVALID_UID} if no carrier
* service is detected.
*/
default void onCarrierServiceChanged(
@Nullable String carrierServicePackageName, int carrierServiceUid) {
// do nothing by default
}
}
/**
* Sets a voice service state override from telecom based on the current {@link PhoneAccount}s
* registered. See {@link PhoneAccount#CAPABILITY_VOICE_CALLING_AVAILABLE}.
*
* Currently, this API is only called to indicate over-the-top voice calling capability of
* the SIM call manager, which will get merged into {@link ServiceState#getState} and propagated
* to interested callers via {@link #getServiceState} and {@link
* TelephonyCallback.ServiceStateListener}.
*
* If callers are truly interested in the actual device <-> tower connection status and not
* an overall "device can make voice calls" boolean, they can use {@link
* ServiceState#getNetworkRegistrationInfo} to check CS registration state.
*
* @hide
*/
@TestApi
@SystemApi
@FlaggedApi(com.android.server.telecom.flags.Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
@RequiresPermission(Manifest.permission.BIND_TELECOM_CONNECTION_SERVICE)
public void setVoiceServiceStateOverride(boolean hasService) {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
throw new IllegalStateException("Telephony service is null");
}
telephony.setVoiceServiceStateOverride(getSubId(), hasService, getOpPackageName());
} catch (RemoteException ex) {
ex.rethrowAsRuntimeException();
}
}
/**
* Registers a {@link CarrierPrivilegesCallback} on the given {@code logicalSlotIndex} to
* receive callbacks when the set of packages with carrier privileges changes. The callback will
* immediately be called with the latest state.
*
* @param logicalSlotIndex The SIM slot to listen on
* @param executor The executor where {@code callback} will be invoked
* @param callback The callback to register
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public void registerCarrierPrivilegesCallback(
int logicalSlotIndex,
@NonNull @CallbackExecutor Executor executor,
@NonNull CarrierPrivilegesCallback callback) {
if (mContext == null) {
throw new IllegalStateException("Telephony service is null");
} else if (executor == null || callback == null) {
throw new IllegalArgumentException(
"CarrierPrivilegesCallback and executor must be non-null");
}
mTelephonyRegistryMgr = mContext.getSystemService(TelephonyRegistryManager.class);
if (mTelephonyRegistryMgr == null) {
throw new IllegalStateException("Telephony registry service is null");
}
mTelephonyRegistryMgr.addCarrierPrivilegesCallback(logicalSlotIndex, executor, callback);
}
/**
* Unregisters an existing {@link CarrierPrivilegesCallback}.
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public void unregisterCarrierPrivilegesCallback(@NonNull CarrierPrivilegesCallback callback) {
if (mContext == null) {
throw new IllegalStateException("Telephony service is null");
} else if (callback == null) {
throw new IllegalArgumentException("CarrierPrivilegesCallback must be non-null");
}
mTelephonyRegistryMgr = mContext.getSystemService(TelephonyRegistryManager.class);
if (mTelephonyRegistryMgr == null) {
throw new IllegalStateException("Telephony registry service is null");
}
mTelephonyRegistryMgr.removeCarrierPrivilegesCallback(callback);
}
/**
* set removable eSIM as default eUICC.
*
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_EUICC)
public void setRemovableEsimAsDefaultEuicc(boolean isDefault) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
telephony.setRemovableEsimAsDefaultEuicc(isDefault, getOpPackageName());
}
} catch (RemoteException e) {
Log.e(TAG, "Error in setRemovableEsimAsDefault: " + e);
}
}
/**
* Returns whether the removable eSIM is default eUICC or not.
*
* @hide
*/
@RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_EUICC)
public boolean isRemovableEsimDefaultEuicc() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isRemovableEsimDefaultEuicc(getOpPackageName());
}
} catch (RemoteException e) {
Log.e(TAG, "Error in isRemovableEsimDefaultEuicc: " + e);
}
return false;
}
/**
* Returns a constant indicating the state of sim for the slot index.
*
* @param slotIndex Logical SIM slot index.
*
* @see TelephonyManager.SimState
*
* @hide
*/
@SimState
public static int getSimStateForSlotIndex(int slotIndex) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.getSimStateForSlotIndex(slotIndex);
}
} catch (RemoteException e) {
Log.e(TAG, "Error in getSimStateForSlotIndex: " + e);
}
return TelephonyManager.SIM_STATE_UNKNOWN;
}
/**
* Captures parameters for collection of emergency
* call diagnostic data
* @hide
*/
@SystemApi
@FlaggedApi(com.android.server.telecom.flags.Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
public static final class EmergencyCallDiagnosticData {
public static final class Builder {
private boolean mCollectTelecomDumpsys;
private boolean mCollectTelephonyDumpsys;
// If this is set to a value other than -1L, then the logcat collection is enabled.
// Logcat lines with this time or greater are collected how much is collected is
// dependent on internal implementation. Time represented as milliseconds since boot.
private long mLogcatStartTimeMillis = sUnsetLogcatStartTime;
/**
* Allows enabling of telecom dumpsys collection.
* @param collectTelecomDumpsys Determines whether telecom dumpsys should be collected.
* @return Builder instance corresponding to the configured call diagnostic params.
*/
public @NonNull Builder setTelecomDumpsysCollectionEnabled(
boolean collectTelecomDumpsys) {
mCollectTelecomDumpsys = collectTelecomDumpsys;
return this;
}
/**
* Allows enabling of telephony dumpsys collection.
* @param collectTelephonyDumpsys Determines if telephony dumpsys should be collected.
* @return Builder instance corresponding to the configured call diagnostic params.
*/
public @NonNull Builder setTelephonyDumpsysCollectionEnabled(
boolean collectTelephonyDumpsys) {
mCollectTelephonyDumpsys = collectTelephonyDumpsys;
return this;
}
/**
* Allows enabling of logcat (system,radio) collection.
* @param startTimeMillis Enables logcat collection as of the indicated timestamp.
* @return Builder instance corresponding to the configured call diagnostic params.
*/
public @NonNull Builder setLogcatCollectionStartTimeMillis(
@CurrentTimeMillisLong long startTimeMillis) {
mLogcatStartTimeMillis = startTimeMillis;
return this;
}
/**
* Build the EmergencyCallDiagnosticData from the provided Builder config.
* @return {@link EmergencyCallDiagnosticData} instance from provided builder.
*/
public @NonNull EmergencyCallDiagnosticData build() {
return new EmergencyCallDiagnosticData(mCollectTelecomDumpsys,
mCollectTelephonyDumpsys, mLogcatStartTimeMillis);
}
}
private boolean mCollectTelecomDumpsys;
private boolean mCollectTelephonyDumpsys;
private boolean mCollectLogcat;
private long mLogcatStartTimeMillis;
private static long sUnsetLogcatStartTime = -1L;
private EmergencyCallDiagnosticData(boolean collectTelecomDumpsys,
boolean collectTelephonyDumpsys, long logcatStartTimeMillis) {
mCollectTelecomDumpsys = collectTelecomDumpsys;
mCollectTelephonyDumpsys = collectTelephonyDumpsys;
mLogcatStartTimeMillis = logcatStartTimeMillis;
mCollectLogcat = logcatStartTimeMillis != sUnsetLogcatStartTime;
}
public boolean isTelecomDumpsysCollectionEnabled() {
return mCollectTelecomDumpsys;
}
public boolean isTelephonyDumpsysCollectionEnabled() {
return mCollectTelephonyDumpsys;
}
public boolean isLogcatCollectionEnabled() {
return mCollectLogcat;
}
public long getLogcatCollectionStartTimeMillis()
{
return mLogcatStartTimeMillis;
}
@Override
public String toString() {
return "EmergencyCallDiagnosticData{"
+ "mCollectTelecomDumpsys=" + mCollectTelecomDumpsys
+ ", mCollectTelephonyDumpsys=" + mCollectTelephonyDumpsys
+ ", mCollectLogcat=" + mCollectLogcat
+ ", mLogcatStartTimeMillis=" + mLogcatStartTimeMillis
+ '}';
}
}
/**
* Request telephony to persist state for debugging emergency call failures.
*
* @param dropboxTag Tag to use when persisting data to dropbox service.
* @param data Parameters controlling what is collected in the diagnostics.
*
* @hide
*/
@SystemApi
@FlaggedApi(com.android.server.telecom.flags.Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
@RequiresPermission(android.Manifest.permission.READ_DROPBOX_DATA)
public void persistEmergencyCallDiagnosticData(@NonNull String dropboxTag,
@NonNull EmergencyCallDiagnosticData data) {
try {
ITelephony telephony = ITelephony.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getTelephonyServiceRegisterer()
.get());
if (telephony != null) {
telephony.persistEmergencyCallDiagnosticData(dropboxTag,
data.isLogcatCollectionEnabled(),
data.getLogcatCollectionStartTimeMillis(),
data.isTelecomDumpsysCollectionEnabled(),
data.isTelephonyDumpsysCollectionEnabled());
}
} catch (RemoteException e) {
Log.e(TAG, "Error while persistEmergencyCallDiagnosticData: " + e);
}
}
/**
* Set the UE's ability to accept/reject null ciphered and null integrity-protected connections.
*
* The modem is required to ignore this in case of an emergency call.
*
* Requires permission: android.Manifest.MODIFY_PHONE_STATE Requires permission: android.Manifest.READ_PHONE_STATE The ranges set previously will be overridden by the new one. Empty list
* can be used to clear the ranges.
*
* @param ranges the list of {@link CellBroadcastIdRange} to be set.
* @param executor The {@link Executor} that will be used to call the callback.
* @param callback A callback called on the supplied {@link Executor} to notify
* the result when the operation completes.
* @throws SecurityException if the caller does not have the required permission
* @throws IllegalArgumentException when the ranges are invalid.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_MESSAGING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_CELL_BROADCASTS)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_MESSAGING)
public void setCellBroadcastIdRanges(@NonNull List Requires one of the following permissions
*
*
*
*
*
*
*
*
*
*
* #*#*}. The intent will have the data
* URI: {@code android_secret_code://}. It is possible that a manifest
* receiver would be woken up even if it is not currently running.
*
*
*
*
*
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // No support for device / profile owner or carrier privileges (b/72967236).
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getSimSerialNumber() {
return getSimSerialNumber(getSubId());
}
/**
* Returns the serial number for the given subscription, if applicable. Return null if it is
* unavailable.
*
*
*
*
*
*
*
* @param subId for which Sim Serial number is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@UnsupportedAppUsage
public String getSimSerialNumber(int subId) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getIccSerialNumberForSubscriber(subId, mContext.getOpPackageName(),
mContext.getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Return if the current radio can support both 3GPP and 3GPP2 radio technologies at the same
* time. This is also known as global mode, which includes LTE, CDMA, EvDo and GSM/WCDMA.
*
*
*
*
*
*
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@SuppressAutoDoc // No support for device / profile owner or carrier privileges (b/72967236).
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getSubscriberId() {
return getSubscriberId(getSubId());
}
/**
* Returns the unique subscriber ID, for example, the IMSI for a GSM phone
* for a subscription.
* Return null if it is unavailable.
*
* See {@link #getSubscriberId()} for details on the required permissions and behavior
* when the caller does not hold sufficient permissions.
*
* @param subId whose subscriber id is returned
* @hide
*/
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
public String getSubscriberId(int subId) {
try {
IPhoneSubInfo info = getSubscriberInfoService();
if (info == null)
return null;
return info.getSubscriberIdForSubscriber(subId, mContext.getOpPackageName(),
mContext.getAttributionTag());
} catch (RemoteException ex) {
return null;
} catch (NullPointerException ex) {
// This could happen before phone restarts due to crashing
return null;
}
}
/**
* Returns carrier specific information that will be used to encrypt the IMSI and IMPI,
* including the public key and the key identifier; or {@code null} if not available.
*
*
*
* Per Open Mobile API Specification v3.2 section 6.2.7.h, only p2 values of 0x00, 0x04, 0x08,
* and 0x0C are guaranteed to be supported.
*
* If the SELECT command's status word is not '9000', '62xx', or '63xx', the status word will be
* considered an error and the channel shall not be opened.
*
* Input parameters equivalent to TS 27.007 AT+CCHO command.
*
*
*
*
* Per Open Mobile API Specification v3.2 section 6.2.7.h, only p2 values of 0x00, 0x04, 0x08,
* and 0x0C are guaranteed to be supported.
*
* If the SELECT command's status word is not '9000', '62xx', or '63xx', the status word will be
* considered an error and the channel shall not be opened.
*
* Input parameters equivalent to TS 27.007 AT+CCHO command.
*
* @param slotIndex the physical slot index of the ICC card
* @param portIndex The port index is an enumeration of the ports available on the UICC.
* Use {@link UiccPortInfo#getPortIndex()} to get portIndex.
* @param aid Application id. See ETSI 102.221 and 101.220.
* @param p2 P2 parameter (described in ISO 7816-4).
* @return an IccOpenLogicalChannelResponse object.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@SystemApi
@NonNull
public IccOpenLogicalChannelResponse iccOpenLogicalChannelByPort(int slotIndex,
int portIndex, @Nullable String aid, int p2) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
IccLogicalChannelRequest request = new IccLogicalChannelRequest();
request.slotIndex = slotIndex;
request.portIndex = portIndex;
request.aid = aid;
request.p2 = p2;
request.callingPackage = getOpPackageName();
request.binder = new Binder();
return telephony.iccOpenLogicalChannel(request);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
throw ex.rethrowAsRuntimeException();
}
}
/**
* Opens a logical channel to the ICC card.
*
* This operation wraps two APDU instructions:
*
*
*
* Per Open Mobile API Specification v3.2 section 6.2.7.h, only p2 values of 0x00, 0x04, 0x08,
* and 0x0C are guaranteed to be supported.
*
* If the SELECT command's status word is not '9000', '62xx', or '63xx', the status word will be
* considered an error and the channel shall not be opened.
*
* Input parameters equivalent to TS 27.007 AT+CCHO command.
*
* It is strongly recommended that callers of this should firstly create a new TelephonyManager
* instance by calling {@link TelephonyManager#createForSubscriptionId(int)}. Failure to do so
* can result in unpredictable and detrimental behavior like callers can end up talking to the
* wrong SIM card.
*
*
*
*
* Per Open Mobile API Specification v3.2 section 6.2.7.h, only p2 values of 0x00, 0x04, 0x08,
* and 0x0C are guaranteed to be supported.
*
* If the SELECT command's status word is not '9000', '62xx', or '63xx', the status word will be
* considered an error and the channel shall not be opened.
*
* Input parameters equivalent to TS 27.007 AT+CCHO command.
*
*
*
*
* @param appType the icc application type, like {@link #APPTYPE_USIM}
* @param authType the authentication type, any one of {@link #AUTHTYPE_EAP_AKA} or
* {@link #AUTHTYPE_EAP_SIM} or {@link #AUTHTYPE_GBA_BOOTSTRAP} or
* {@link #AUTHTYPE_GBA_NAF_KEY_EXTERNAL}
* @param data authentication challenge data, base64 encoded.
* See 3GPP TS 31.102 7.1.2 for more details.
* @return the response of authentication. This value will be null in the following cases:
* Authentication error, incorrect MAC
* Authentication error, security context not supported
* Key freshness failure
* Authentication error, no memory space available
* Authentication error, no memory space available in EFMUK
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
// TODO(b/73660190): This should probably require MODIFY_PHONE_STATE, not
// READ_PRIVILEGED_PHONE_STATE. It certainly shouldn't reference the permission in Javadoc since
// it's not public API.
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public String getIccAuthentication(int appType,@AuthType int authType, String data) {
return getIccAuthentication(getSubId(), appType, authType, data);
}
/**
* Returns the response of USIM Authentication for specified subId.
* Returns null if the authentication hasn't been successful
*
*
*
*
* @param request Contains all the RAT with bands/channels that need to be scanned.
* @param executor The executor through which the callback should be invoked. Since the scan
* request may trigger multiple callbacks and they must be invoked in the same order as
* they are received by the platform, the user should provide an executor which executes
* tasks one at a time in serial order.
* @param callback Returns network scan results or errors.
* @return A NetworkScan obj which contains a callback which can be used to stop the scan.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(allOf = {
android.Manifest.permission.MODIFY_PHONE_STATE,
Manifest.permission.ACCESS_FINE_LOCATION
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public NetworkScan requestNetworkScan(
NetworkScanRequest request, Executor executor,
TelephonyScanManager.NetworkScanCallback callback) {
return requestNetworkScan(INCLUDE_LOCATION_DATA_FINE, request, executor, callback);
}
/**
* Request a network scan.
*
* This method is asynchronous, so the network scan results will be returned by callback.
* The returned NetworkScan will contain a callback method which can be used to stop the scan.
*
*
*
*
* @param includeLocationData Specifies if the caller would like to receive
* location related information. If this parameter is set to
* {@link #INCLUDE_LOCATION_DATA_FINE} then the application will be checked for
* {@link android.Manifest.permission#ACCESS_FINE_LOCATION} permission and available
* location related information received during network scan will be sent to the caller.
* @param request Contains all the RAT with bands/channels that need to be scanned.
* @param executor The executor through which the callback should be invoked. Since the scan
* request may trigger multiple callbacks and they must be invoked in the same order as
* they are received by the platform, the user should provide an executor which executes
* tasks one at a time in serial order.
* @param callback Returns network scan results or errors.
* @return A NetworkScan obj which contains a callback which can be used to stop the scan.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges
@RequiresPermission(allOf = {
android.Manifest.permission.MODIFY_PHONE_STATE
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public @Nullable NetworkScan requestNetworkScan(
@IncludeLocationData int includeLocationData,
@NonNull NetworkScanRequest request,
@NonNull Executor executor,
@NonNull TelephonyScanManager.NetworkScanCallback callback) {
synchronized (sCacheLock) {
if (mTelephonyScanManager == null) {
mTelephonyScanManager = new TelephonyScanManager();
}
}
return mTelephonyScanManager.requestNetworkScan(getSubId(),
includeLocationData != INCLUDE_LOCATION_DATA_FINE,
request, executor, callback,
getOpPackageName(), getAttributionTag());
}
/**
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*
* @deprecated
* Use {@link
* #requestNetworkScan(NetworkScanRequest, Executor, TelephonyScanManager.NetworkScanCallback)}
* @removed
*/
@Deprecated
@RequiresPermission(allOf = {
android.Manifest.permission.MODIFY_PHONE_STATE,
Manifest.permission.ACCESS_FINE_LOCATION
})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_RADIO_ACCESS)
public NetworkScan requestNetworkScan(
NetworkScanRequest request, TelephonyScanManager.NetworkScanCallback callback) {
return requestNetworkScan(request, AsyncTask.SERIAL_EXECUTOR, callback);
}
/**
* Ask the radio to connect to the input network and change selection mode to manual.
*
*
*
* This API will result in allowing an intersection of allowed network types for all reasons,
* including the configuration done through other reasons.
*
* @param reason the reason the allowed network type change is taking place
* @param allowedNetworkTypes The bitmask of allowed network type
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws IllegalArgumentException if invalid AllowedNetworkTypesReason is passed.
* @throws SecurityException if the caller does not have the required privileges or if the
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* caller tries to use one of the following security-based reasons without
* {@link android.Manifest.permission#MODIFY_PHONE_STATE} permissions.
*
*
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(
enforcement = "android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported",
value = TelephonyManager.CAPABILITY_USES_ALLOWED_NETWORK_TYPES_BITMASK)
public void setAllowedNetworkTypesForReason(@AllowedNetworkTypesReason int reason,
@NetworkTypeBitMask long allowedNetworkTypes) {
if (!isValidAllowedNetworkTypesReason(reason)) {
throw new IllegalArgumentException("invalid AllowedNetworkTypesReason.");
}
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
allowedNetworkTypes = checkNetworkTypeBitmask(allowedNetworkTypes);
telephony.setAllowedNetworkTypesForReason(getSubId(), reason,
allowedNetworkTypes);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setAllowedNetworkTypesForReason RemoteException", ex);
ex.rethrowFromSystemServer();
}
}
/**
* Get the allowed network types for certain reason.
*
* {@link #getAllowedNetworkTypesForReason} returns allowed network type for a
* specific reason.
*
*
*
* @param executor The executor on which the result listener will be called.
* @param resultListener {@link Consumer} that will be called with the carrier restriction
* status result fetched from the radio
* @throws SecurityException if the caller does not have the required permission/privileges or
* if the caller is not pre-registered.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
*/
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
public void getCarrierRestrictionStatus(@NonNull Executor executor,
@NonNull @CarrierRestrictionStatus
Consumer
*
* If any of the reason is off, then it will result in
* bypassing user preference and result in data to be turned off.
*
*
*
* @return {@code true} if the overall data connection is allowed; {@code false} if not.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_DATA}.
*/
@RequiresPermission(anyOf = {android.Manifest.permission.ACCESS_NETWORK_STATE,
android.Manifest.permission.READ_PHONE_STATE,
android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
android.Manifest.permission.READ_BASIC_PHONE_STATE})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_DATA)
public boolean isDataConnectionAllowed() {
boolean retVal = false;
try {
int subId = getSubId(SubscriptionManager.getDefaultDataSubscriptionId());
ITelephony telephony = getITelephony();
if (telephony != null)
retVal = telephony.isDataEnabled(subId);
} catch (RemoteException e) {
Log.e(TAG, "Error isDataConnectionAllowed", e);
}
return retVal;
}
/**
* @return true if the current device is "data capable" over a radio on the device.
*
*
* @return Map including the keys as the active subscription IDs (Note: if there is no active
* subscription, the key is {@link SubscriptionManager#getDefaultSubscriptionId}) and the value
* as the list of {@link EmergencyNumber}; empty Map if this information is not available;
* or throw a SecurityException if the caller does not have the permission.
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
*/
@RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
@NonNull
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public Map
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@SystemApi
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void setCallForwarding(@NonNull CallForwardingInfo callForwardingInfo,
@Nullable @CallbackExecutor Executor executor,
@Nullable @CallForwardingInfoCallback.CallForwardingError
Consumer
*
*
*
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_CALLING}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
public void getCallWaitingStatus(@NonNull Executor executor,
@NonNull @CallWaitingStatus Consumer
*
* @return operation result.
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
@RequiresFeature(
enforcement = "android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported",
value = TelephonyManager.CAPABILITY_NR_DUAL_CONNECTIVITY_CONFIGURATION_AVAILABLE)
public @EnableNrDualConnectivityResult int setNrDualConnectivityState(
@NrDualConnectivityState int nrDualConnectivityState) {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.setNrDualConnectivityState(getSubId(), nrDualConnectivityState);
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Rlog.e(TAG, "setNrDualConnectivityState RemoteException", ex);
ex.rethrowFromSystemServer();
}
return ENABLE_NR_DUAL_CONNECTIVITY_INVALID_STATE;
}
/**
* Is E-UTRA-NR Dual Connectivity enabled.
* This api is supported only if
* {@link android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported}
* ({@link TelephonyManager#CAPABILITY_NR_DUAL_CONNECTIVITY_CONFIGURATION_AVAILABLE})
* returns true.
* @return true if dual connectivity is enabled else false. Enabled state does not mean dual
* connectivity is active. It means the device is allowed to connect to both primary and
* secondary cell.
* @throws IllegalStateException if the Telephony process is not currently available.
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
@RequiresFeature(
enforcement = "android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported",
value = TelephonyManager.CAPABILITY_NR_DUAL_CONNECTIVITY_CONFIGURATION_AVAILABLE)
public boolean isNrDualConnectivityEnabled() {
try {
ITelephony telephony = getITelephony();
if (telephony != null) {
return telephony.isNrDualConnectivityEnabled(getSubId());
} else {
throw new IllegalStateException("telephony service is null.");
}
} catch (RemoteException ex) {
Rlog.e(TAG, "isNRDualConnectivityEnabled RemoteException", ex);
ex.rethrowFromSystemServer();
}
return false;
}
private static class DeathRecipient implements IBinder.DeathRecipient {
@Override
public void binderDied() {
resetServiceCache();
}
}
/**
* Reset everything in the service cache; if one handle died then they are
* all probably broken.
* @hide
*/
private static void resetServiceCache() {
synchronized (sCacheLock) {
if (sITelephony != null) {
sITelephony.asBinder().unlinkToDeath(sServiceDeath, 0);
sITelephony = null;
}
if (sISub != null) {
sISub.asBinder().unlinkToDeath(sServiceDeath, 0);
sISub = null;
SubscriptionManager.clearCaches();
}
if (sISms != null) {
sISms.asBinder().unlinkToDeath(sServiceDeath, 0);
sISms = null;
}
if (sIPhoneSubInfo != null) {
sIPhoneSubInfo.asBinder().unlinkToDeath(sServiceDeath, 0);
sIPhoneSubInfo = null;
}
}
}
/**
* @hide
*/
static IPhoneSubInfo getSubscriberInfoService() {
// Keeps cache disabled until test fixes are checked into AOSP.
if (!sServiceHandleCacheEnabled) {
return IPhoneSubInfo.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getPhoneSubServiceRegisterer()
.get());
}
if (sIPhoneSubInfo == null) {
IPhoneSubInfo temp = IPhoneSubInfo.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getPhoneSubServiceRegisterer()
.get());
synchronized (sCacheLock) {
if (sIPhoneSubInfo == null && temp != null) {
try {
sIPhoneSubInfo = temp;
sIPhoneSubInfo.asBinder().linkToDeath(sServiceDeath, 0);
} catch (Exception e) {
// something has gone horribly wrong
sIPhoneSubInfo = null;
}
}
}
}
return sIPhoneSubInfo;
}
/**
* @hide
*/
static ISub getSubscriptionService() {
// Keeps cache disabled until test fixes are checked into AOSP.
if (!sServiceHandleCacheEnabled) {
return ISub.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getSubscriptionServiceRegisterer()
.get());
}
if (sISub == null) {
ISub temp = ISub.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getSubscriptionServiceRegisterer()
.get());
synchronized (sCacheLock) {
if (sISub == null && temp != null) {
try {
sISub = temp;
sISub.asBinder().linkToDeath(sServiceDeath, 0);
} catch (Exception e) {
// something has gone horribly wrong
sISub = null;
}
}
}
}
return sISub;
}
/**
* @hide
*/
static ISms getSmsService() {
// Keeps cache disabled until test fixes are checked into AOSP.
if (!sServiceHandleCacheEnabled) {
return ISms.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getSmsServiceRegisterer()
.get());
}
if (sISms == null) {
ISms temp = ISms.Stub.asInterface(
TelephonyFrameworkInitializer
.getTelephonyServiceManager()
.getSmsServiceRegisterer()
.get());
synchronized (sCacheLock) {
if (sISms == null && temp != null) {
try {
sISms = temp;
sISms.asBinder().linkToDeath(sServiceDeath, 0);
} catch (Exception e) {
// something has gone horribly wrong
sISms = null;
}
}
}
}
return sISms;
}
/**
* Disables service handle caching for tests that utilize mock services.
* @hide
*/
@VisibleForTesting
public static void disableServiceHandleCaching() {
sServiceHandleCacheEnabled = false;
}
/**
* Reenables service handle caching.
* @hide
*/
@VisibleForTesting
public static void enableServiceHandleCaching() {
sServiceHandleCacheEnabled = true;
}
/**
* Setup sITelephony for testing.
* @hide
*/
@VisibleForTesting
public static void setupITelephonyForTest(ITelephony telephony) {
sITelephony = telephony;
}
/**
* Setup sIPhoneSubInfo for testing.
*
* @hide
*/
@VisibleForTesting
public static void setupIPhoneSubInfoForTest(IPhoneSubInfo iPhoneSubInfo) {
synchronized (sCacheLock) {
sIPhoneSubInfo = iPhoneSubInfo;
}
}
/**
* Setup sISub for testing.
*
* @hide
*/
@VisibleForTesting
public static void setupISubForTest(ISub iSub) {
synchronized (sCacheLock) {
sISub = iSub;
}
}
/**
* Whether device can connect to 5G network when two SIMs are active.
*
* @hide TODO b/153669716: remove or make system API.
*/
public boolean canConnectTo5GInDsdsMode() {
ITelephony telephony = getITelephony();
if (telephony == null) return true;
try {
return telephony.canConnectTo5GInDsdsMode();
} catch (RemoteException ex) {
return true;
} catch (NullPointerException ex) {
return true;
}
}
/**
* Returns a list of the equivalent home PLMNs (EF_EHPLMN) from the USIM app.
*
*
*
*
* So, for example, requesting {@link
* DataThrottlingRequest#DATA_THROTTLING_ACTION_THROTTLE_PRIMARY_CARRIER} will ensure that the
* data on secondary carrier has been disabled before throttling on primary carrier. {@link
* ThermalMitigationRequest#THERMAL_MITIGATION_ACTION_VOICE_ONLY} will ensure that data on both
* primary and secondary have been disabled. {@link
* ThermalMitigationRequest#THERMAL_MITIGATION_ACTION_RADIO_OFF} will ensure that voice is
* disabled and that data on both primary and secondary carriers are disabled before turning
* radio off. {@link DataThrottlingRequest#DATA_THROTTLING_ACTION_HOLD} is not part of the order
* and can be used at any time during data throttling to hold onto the current level of data
* throttling.
*
*
*
*
*
*
*
*
* @param appType icc application type, like {@link #APPTYPE_USIM} or {@link
* #APPTYPE_ISIM} or {@link#APPTYPE_UNKNOWN}
* @param nafId A URI to specify Network Application Function(NAF) fully qualified domain
* name (FQDN) and the selected GBA mode. The authority of the URI must contain two parts
* delimited by "@" sign. The first part is the constant string "3GPP-bootstrapping" (GBA_ME),
* "3GPP-bootstrapping-uicc" (GBA_ U), or "3GPP-bootstrapping-digest" (GBA_Digest).
* The second part shall be the FQDN of the NAF. The scheme of the URI is not actually used
* for the authentication, which may be set the same as the resource that the application is
* going to access. For example, the nafId can be
* "https://3GPP-bootstrapping@naf1.operator.com",
* "https://3GPP-bootstrapping-uicc@naf1.operator.com",
* "https://3GPP-bootstrapping-digest@naf1.operator.com",
* "ftps://3GPP-bootstrapping-digest@naf1.operator.com".
* @param securityProtocol Security protocol identifier between UE and NAF. See
* 3GPP TS 33.220 Annex H. Application can use
* {@link UaSecurityProtocolIdentifier#createDefaultUaSpId},
* {@link UaSecurityProtocolIdentifier#create3GppUaSpId},
* to create the ua security protocol identifier as needed
* @param forceBootStrapping true=force bootstrapping, false=do not force
* bootstrapping. Bootstrapping shouldn't be forced unless the application sees
* authentication errors from the server.
* @param e The {@link Executor} that will be used to call the Gba callback.
* @param callback A callback called on the supplied {@link Executor} that will
* contain the GBA Ks_NAF/Ks_ext_NAF when available. If the NAF keys are
* available and valid at the time of call and bootstrapping is not requested,
* then the callback shall be invoked with the available keys.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_SUBSCRIPTION}.
* @hide
*/
@SystemApi
@WorkerThread
@RequiresPermission(anyOf = {android.Manifest.permission.MODIFY_PHONE_STATE,
Manifest.permission.PERFORM_IMS_SINGLE_REGISTRATION})
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_SUBSCRIPTION)
public void bootstrapAuthenticationRequest(
@UiccAppTypeExt int appType, @NonNull Uri nafId,
@NonNull UaSecurityProtocolIdentifier securityProtocol,
boolean forceBootStrapping, @NonNull Executor e,
@NonNull BootstrapAuthenticationCallback callback) {
try {
ITelephony service = getITelephony();
if (service == null) {
e.execute(() -> callback.onAuthenticationFailure(
GBA_FAILURE_REASON_FEATURE_NOT_READY));
return;
}
service.bootstrapAuthenticationRequest(
getSubId(), appType, nafId, securityProtocol, forceBootStrapping,
new IBootstrapAuthenticationCallback.Stub() {
@Override
public void onKeysAvailable(int token, byte[] gbaKey,
String transactionId) {
final long identity = Binder.clearCallingIdentity();
try {
e.execute(() -> callback.onKeysAvailable(gbaKey, transactionId));
} finally {
Binder.restoreCallingIdentity(identity);
}
}
@Override
public void onAuthenticationFailure(int token, int reason) {
final long identity = Binder.clearCallingIdentity();
try {
e.execute(() -> callback.onAuthenticationFailure(reason));
} finally {
Binder.restoreCallingIdentity(identity);
}
}
});
} catch (RemoteException exception) {
Log.e(TAG, "Error calling ITelephony#bootstrapAuthenticationRequest", exception);
e.execute(() -> callback.onAuthenticationFailure(GBA_FAILURE_REASON_FEATURE_NOT_READY));
}
}
/**
* The network type is valid or not.
*
* @param networkType The network type {@link NetworkType}.
* @return {@code true} if valid, {@code false} otherwise.
*
* @hide
*/
public static boolean isNetworkTypeValid(@NetworkType int networkType) {
return networkType >= TelephonyManager.NETWORK_TYPE_UNKNOWN &&
networkType <= TelephonyManager.NETWORK_TYPE_NR;
}
/**
* Set a {@link SignalStrengthUpdateRequest} to receive notification when signal quality
* measurements breach the specified thresholds.
*
* To be notified, set the signal strength update request and then register
* {@link TelephonyCallback} that implements {@link TelephonyCallback.SignalStrengthsListener}
* through {@link #registerTelephonyCallback}. The notification will arrive through
* {@link TelephonyCallback.SignalStrengthsListener#onSignalStrengthsChanged(SignalStrength)}.
*
* To stop receiving the notification over the specified thresholds, pass the same
* {@link SignalStrengthUpdateRequest} object to
* {@link #clearSignalStrengthUpdateRequest(SignalStrengthUpdateRequest)}.
*
* System will clean up the {@link SignalStrengthUpdateRequest} if the caller process died
* without calling {@link #clearSignalStrengthUpdateRequest(SignalStrengthUpdateRequest)}.
*
* If this TelephonyManager object has been created with {@link #createForSubscriptionId},
* applies to the given subId. Otherwise, applies to
* {@link SubscriptionManager#getDefaultSubscriptionId()}. To request for multiple subIds,
* pass a request object to each TelephonyManager object created with
* {@link #createForSubscriptionId}.
*
*
*
*
* This will be invalid if the device does not support
* android.telephony.TelephonyManager#CAPABILITY_SLICING_CONFIG_SUPPORTED.
*
* @param executor the executor on which callback will be invoked.
* @param callback a callback to receive the current slicing configuration.
*
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_RADIO_ACCESS}.
*/
@RequiresFeature(
enforcement = "android.telephony.TelephonyManager#isRadioInterfaceCapabilitySupported",
value = TelephonyManager.CAPABILITY_SLICING_CONFIG_SUPPORTED)
@SuppressAutoDoc // No support for carrier privileges (b/72967236).
@RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
public void getNetworkSlicingConfiguration(
@NonNull @CallbackExecutor Executor executor,
@NonNull OutcomeReceiver
*
*
* @return Primary IMEI of type string
* @throws UnsupportedOperationException If the device does not have
* {@link PackageManager#FEATURE_TELEPHONY_GSM}.
* @throws SecurityException if the caller does not have the required permission/privileges
*/
@NonNull
@RequiresFeature(PackageManager.FEATURE_TELEPHONY_GSM)
public String getPrimaryImei() {
try {
ITelephony telephony = getITelephony();
if (telephony == null) {
Rlog.e(TAG, "getPrimaryImei(): IPhoneSubInfo instance is NULL");
throw new IllegalStateException("Telephony service not available.");
}
return telephony.getPrimaryImei(getOpPackageName(), getAttributionTag());
} catch (RemoteException ex) {
Rlog.e(TAG, "getPrimaryImei() RemoteException : " + ex);
throw ex.rethrowAsRuntimeException();
}
}
/**
* Convert SIM state into string.
*
* @param state SIM state.
* @return SIM state in string format.
*
* @hide
*/
@NonNull
public static String simStateToString(@SimState int state) {
switch (state) {
case TelephonyManager.SIM_STATE_UNKNOWN:
return "UNKNOWN";
case TelephonyManager.SIM_STATE_ABSENT:
return "ABSENT";
case TelephonyManager.SIM_STATE_PIN_REQUIRED:
return "PIN_REQUIRED";
case TelephonyManager.SIM_STATE_PUK_REQUIRED:
return "PUK_REQUIRED";
case TelephonyManager.SIM_STATE_NETWORK_LOCKED:
return "NETWORK_LOCKED";
case TelephonyManager.SIM_STATE_READY:
return "READY";
case TelephonyManager.SIM_STATE_NOT_READY:
return "NOT_READY";
case TelephonyManager.SIM_STATE_PERM_DISABLED:
return "PERM_DISABLED";
case TelephonyManager.SIM_STATE_CARD_IO_ERROR:
return "CARD_IO_ERROR";
case TelephonyManager.SIM_STATE_CARD_RESTRICTED:
return "CARD_RESTRICTED";
case TelephonyManager.SIM_STATE_LOADED:
return "LOADED";
case TelephonyManager.SIM_STATE_PRESENT:
return "PRESENT";
default:
return "UNKNOWN(" + state + ")";
}
}
}