Package org.robolectric.shadows

Class ShadowSubscriptionManager

java.lang.Object

org.robolectric.shadows.ShadowSubscriptionManager

@Implements(android.telephony.SubscriptionManager.class)
public class ShadowSubscriptionManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowSubscriptionManager.SubscriptionInfoBuilder	Builder class to create instance of SubscriptionInfo.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INVALID_PHONE_INDEX

Constructor Summary

Constructors

Constructor	Description
ShadowSubscriptionManager()

Method Summary

Modifier and Type	Method	Description
protected void	addOnSubscriptionsChangedListener(SubscriptionManager.OnSubscriptionsChangedListener listener)	Adds a listener to a local list of listeners.
protected void	addOnSubscriptionsChangedListener(Executor executor, SubscriptionManager.OnSubscriptionsChangedListener listener)	Adds a listener to a local list of listeners.
void	clearNetworkRoamingStatus()	Clears the local cache of roaming subscription Ids used by isNetworkRoaming(int).
static void	clearPhoneIds()	Removes all mappings between subscription IDs and phone IDs from the map used by getPhoneId(int).
protected List<SubscriptionInfo>	getAccessibleSubscriptionInfoList()	Returns the accessible list of SubscriptionInfo that were set via setAccessibleSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).
protected static int	getActiveDataSubscriptionId()	Returns value set with setActiveDataSubscriptionId(int).
protected int[]	getActiveSubscriptionIdList()	Returns subscription Ids that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).
protected SubscriptionInfo	getActiveSubscriptionInfo(int subId)	Returns subscription that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) if it can find one with the specified id or null if none found.
protected int	getActiveSubscriptionInfoCount()	Returns the size of the list of SubscriptionInfo that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).
protected int	getActiveSubscriptionInfoCountMax()
protected SubscriptionInfo	getActiveSubscriptionInfoForSimSlotIndex(int slotIndex)	Returns subscription that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) if it can find one with the specified slot index or null if none found.
protected List<SubscriptionInfo>	getActiveSubscriptionInfoList()	Returns the active list of SubscriptionInfo that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).
protected List<SubscriptionInfo>	getAllSubscriptionInfoList()	Returns the all list of SubscriptionInfo that were set via setAllSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).
protected List<SubscriptionInfo>	getAvailableSubscriptionInfoList()	Returns the available list of SubscriptionInfo that were set via setAvailableSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).
protected static int	getDefaultDataSubId()
protected static int	getDefaultDataSubscriptionId()	Returns value set with setDefaultDataSubscriptionId(int).
protected static int	getDefaultSmsSubId()
protected static int	getDefaultSmsSubscriptionId()	Returns value set with setDefaultSmsSubscriptionId(int).
protected static int	getDefaultSubId()
protected static int	getDefaultSubscriptionId()	Returns value set with setDefaultSubscriptionId(int).
protected static int	getDefaultVoiceSubId()
protected static int	getDefaultVoiceSubscriptionId()	Returns value set with setDefaultVoiceSubscriptionId(int).
protected static int	getPhoneId(int subId)	Uses the map of subscription IDs to phone IDs managed by putPhoneId(int, int) and removePhoneId(int) to return the phone ID for a given subscription ID.
protected String	getPhoneNumber(int subscriptionId)	Returns the phone number for the given subscriptionId, or an empty string if not available.
protected String	getPhoneNumber(int subscriptionId, int source)	Returns the phone number for the given subscriptionId, or an empty string if not available.
protected static int	getSlotIndex(int subscriptionId)
protected static int[]	getSubId(int slotIndex)	Older form of getSubscriptionId(int) that was designed prior to mainstream multi-SIM support, so its int[] return type ended up being an unused vestige from that older design.
protected static int	getSubscriptionId(int slotIndex)	Derives the subscription ID corresponding to an "active" SubscriptionInfo for the given SIM slot index.
protected int[]	getSubscriptionIds(int slotIndex)	Older form of getSubscriptionId(int) that was designed prior to mainstream multi-SIM support, so its int[] return type ended up being an unused vestige from that older design.
boolean	hasOnSubscriptionsChangedListener(SubscriptionManager.OnSubscriptionsChangedListener listener)	Check if a listener exists in the listeners.
protected boolean	isNetworkRoaming(int simSubscriptionId)	Uses the local cache of roaming sim subscription Ids managed by setNetworkRoamingStatus(int, boolean) to return subscription Ids marked as roaming.
static void	putPhoneId(int subId, int phoneId)	Adds a subscription ID-phone ID mapping to the map used by getPhoneId(int).
protected void	removeOnSubscriptionsChangedListener(SubscriptionManager.OnSubscriptionsChangedListener listener)	Removes a listener from a local list of listeners.
static Integer	removePhoneId(int subId)	Removes a subscription ID-phone ID mapping from the map used by getPhoneId(int).
static void	reset()
void	setAccessibleSubscriptionInfoList(List<SubscriptionInfo> list)	Sets the accessible list of SubscriptionInfo.
void	setAccessibleSubscriptionInfos(SubscriptionInfo... infos)	Sets the accessible list of SubscriptionInfo.
static void	setActiveDataSubscriptionId(int activeDataSubscriptionId)	Sets the value that will be returned by getActiveDataSubscriptionId().
void	setActiveSubscriptionInfoList(List<SubscriptionInfo> list)	Sets the active list of SubscriptionInfo.
void	setActiveSubscriptionInfos(SubscriptionInfo... infos)	Sets the active list of SubscriptionInfo.
void	setAllSubscriptionInfoList(List<SubscriptionInfo> list)	Sets the all list of SubscriptionInfo.
void	setAllSubscriptionInfos(SubscriptionInfo... infos)	Sets the all list of SubscriptionInfo.
void	setAvailableSubscriptionInfoList(List<SubscriptionInfo> list)	Sets the available list of SubscriptionInfo.
void	setAvailableSubscriptionInfos(SubscriptionInfo... infos)	Sets the available list of SubscriptionInfo.
static void	setDefaultDataSubscriptionId(int defaultDataSubscriptionId)	Sets the default data subscription and broadcasts TelephonyManager.ACTION_DEFAULT_DATA_SUBSCRIPTION_CHANGED
static void	setDefaultSmsSubscriptionId(int defaultSmsSubscriptionId)	Sets the default SMS subscription and broadcasts SubscriptionManager.ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED
static void	setDefaultSubscriptionId(int defaultSubscriptionId)	Sets the default subscription and broadcasts SubscriptionManager.ACTION_DEFAULT_SUBSCRIPTION_CHANGED
static void	setDefaultVoiceSubscriptionId(int defaultVoiceSubscriptionId)	Sets the default voice subscription and broadcasts TelephonyManager.ACTION_DEFAULT_VOICE_SUBSCRIPTION_CHANGED
void	setNetworkRoamingStatus(int simSubscriptionId, boolean isNetworkRoaming)	If isNetworkRoaming is set, it will mark the provided sim subscriptionId as roaming in a local cache.
void	setPhoneNumber(int subscriptionId, String phoneNumber)	Sets the phone number returned by getPhoneNumber(int).
void	setReadPhoneNumbersPermission(boolean readPhoneNumbersPermission)	When set to false methods requiring Manifest.permission.READ_PHONE_NUMBERS permission will throw a SecurityException.
void	setReadPhoneStatePermission(boolean readPhoneStatePermission)	When set to false methods requiring Manifest.permission.READ_PHONE_STATE permission will throw a SecurityException.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INVALID_PHONE_INDEX

public static final int INVALID_PHONE_INDEX

Constructor Details

ShadowSubscriptionManager

public ShadowSubscriptionManager()

Method Details

getActiveDataSubscriptionId

@Implementation(minSdk=30)
protected static int getActiveDataSubscriptionId()

Returns value set with setActiveDataSubscriptionId(int).

getDefaultSubscriptionId

@Implementation(minSdk=24)
protected static int getDefaultSubscriptionId()

Returns value set with setDefaultSubscriptionId(int).

getDefaultDataSubscriptionId

@Implementation(minSdk=24)
protected static int getDefaultDataSubscriptionId()

Returns value set with setDefaultDataSubscriptionId(int).

getDefaultSmsSubscriptionId

@Implementation(minSdk=24)
protected static int getDefaultSmsSubscriptionId()

Returns value set with setDefaultSmsSubscriptionId(int).

getDefaultVoiceSubscriptionId

@Implementation(minSdk=24)
protected static int getDefaultVoiceSubscriptionId()

Returns value set with setDefaultVoiceSubscriptionId(int).

getDefaultSubId

@Implementation(maxSdk=23)
@HiddenApi
protected static int getDefaultSubId()

getDefaultVoiceSubId

@Implementation(maxSdk=23)
@HiddenApi
protected static int getDefaultVoiceSubId()

getDefaultSmsSubId

@Implementation(maxSdk=23)
@HiddenApi
protected static int getDefaultSmsSubId()

getDefaultDataSubId

@Implementation(maxSdk=23)
@HiddenApi
protected static int getDefaultDataSubId()

setActiveDataSubscriptionId

public static void setActiveDataSubscriptionId(int activeDataSubscriptionId)

Sets the value that will be returned by getActiveDataSubscriptionId().

setDefaultSubscriptionId

public static void setDefaultSubscriptionId(int defaultSubscriptionId)

Sets the default subscription and broadcasts SubscriptionManager.ACTION_DEFAULT_SUBSCRIPTION_CHANGED

setDefaultDataSubscriptionId

public static void setDefaultDataSubscriptionId(int defaultDataSubscriptionId)

Sets the default data subscription and broadcasts TelephonyManager.ACTION_DEFAULT_DATA_SUBSCRIPTION_CHANGED

setDefaultSmsSubscriptionId

public static void setDefaultSmsSubscriptionId(int defaultSmsSubscriptionId)

Sets the default SMS subscription and broadcasts SubscriptionManager.ACTION_DEFAULT_SMS_SUBSCRIPTION_CHANGED

setDefaultVoiceSubscriptionId

public static void setDefaultVoiceSubscriptionId(int defaultVoiceSubscriptionId)

Sets the default voice subscription and broadcasts TelephonyManager.ACTION_DEFAULT_VOICE_SUBSCRIPTION_CHANGED

getActiveSubscriptionInfoList

@Implementation
protected List<SubscriptionInfo> getActiveSubscriptionInfoList()

Returns the active list of SubscriptionInfo that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).

getAllSubscriptionInfoList

@Implementation(minSdk=34)
protected List<SubscriptionInfo> getAllSubscriptionInfoList()

Returns the all list of SubscriptionInfo that were set via setAllSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).

getAccessibleSubscriptionInfoList

@Implementation(minSdk=27)
protected List<SubscriptionInfo> getAccessibleSubscriptionInfoList()

Returns the accessible list of SubscriptionInfo that were set via setAccessibleSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).

getAvailableSubscriptionInfoList

@Implementation(minSdk=27)
protected List<SubscriptionInfo> getAvailableSubscriptionInfoList()

Returns the available list of SubscriptionInfo that were set via setAvailableSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).

getActiveSubscriptionInfoCount

@Implementation
protected int getActiveSubscriptionInfoCount()

Returns the size of the list of SubscriptionInfo that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>). If no list was set, returns 0.

getActiveSubscriptionInfo

@Implementation
protected SubscriptionInfo getActiveSubscriptionInfo(int subId)

Returns subscription that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) if it can find one with the specified id or null if none found.

An exception will be thrown if the READ_PHONE_STATE permission has not been granted.

getActiveSubscriptionInfoCountMax

@Implementation
protected int getActiveSubscriptionInfoCountMax()

Returns:

the maximum number of active subscriptions that will be returned by getActiveSubscriptionInfoList() and the value returned by getActiveSubscriptionInfoCount().

getActiveSubscriptionInfoForSimSlotIndex

@Implementation(minSdk=24)
protected SubscriptionInfo getActiveSubscriptionInfoForSimSlotIndex(int slotIndex)

Returns subscription that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) if it can find one with the specified slot index or null if none found.

setActiveSubscriptionInfoList

public void setActiveSubscriptionInfoList(List<SubscriptionInfo> list)

Sets the active list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

"Active" here means subscriptions which are currently mapped to a live modem stack in the device (i.e. the modem will attempt to use them to connect to nearby towers), and they are expected to have SubscriptionInfo.getSimSlotIndex() >= 0. A subscription being "active" in the device does NOT have any relation to a carrier's "activation" process for subscribers' SIMs.

Parameters:

list - - The subscription info list, can be null.

setAllSubscriptionInfoList

public void setAllSubscriptionInfoList(List<SubscriptionInfo> list)

Sets the all list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

setAccessibleSubscriptionInfoList

public void setAccessibleSubscriptionInfoList(List<SubscriptionInfo> list)

Sets the accessible list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

"Accessible" here means subscriptions which are eSIM (SubscriptionInfo.isEmbedded()) and "owned" by the calling app, i.e. by SubscriptionManager.canManageSubscription(SubscriptionInfo). They may be active, or installed-but-inactive. This is generally intended to be called by carrier apps that directly manage their own eSIM profiles on the device in concert with EuiccManager.

Parameters:

list - - The subscription info list, can be null.

setAvailableSubscriptionInfoList

public void setAvailableSubscriptionInfoList(List<SubscriptionInfo> list)

Sets the available list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

"Available" here means all active subscriptions (see setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>)) combined with all installed-but-inactive eSIM subscriptions (similar to setAccessibleSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>), but not filtered to one particular app's "ownership" rights for subscriptions). This is generally intended to be called by system components such as the eSIM LPA or Settings that allow the user to manage all subscriptions on the device through some system-provided user interface.

Parameters:

list - - The subscription info list, can be null.

setActiveSubscriptionInfos

public void setActiveSubscriptionInfos(SubscriptionInfo... infos)

Sets the active list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

setAccessibleSubscriptionInfos

public void setAccessibleSubscriptionInfos(SubscriptionInfo... infos)

Sets the accessible list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

setAvailableSubscriptionInfos

public void setAvailableSubscriptionInfos(SubscriptionInfo... infos)

Sets the available list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

setAllSubscriptionInfos

public void setAllSubscriptionInfos(SubscriptionInfo... infos)

Sets the all list of SubscriptionInfo. This call internally triggers SubscriptionManager.OnSubscriptionsChangedListener.onSubscriptionsChanged() to all the listeners.

addOnSubscriptionsChangedListener

@Implementation
protected void addOnSubscriptionsChangedListener(SubscriptionManager.OnSubscriptionsChangedListener listener)

Adds a listener to a local list of listeners. Will be triggered by setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) when the local list of SubscriptionInfo is updated.

addOnSubscriptionsChangedListener

@Implementation(minSdk=30)
protected void addOnSubscriptionsChangedListener(Executor executor,
 SubscriptionManager.OnSubscriptionsChangedListener listener)

Adds a listener to a local list of listeners. Will be triggered by setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) when the local list of SubscriptionInfo is updated.

removeOnSubscriptionsChangedListener

@Implementation
protected void removeOnSubscriptionsChangedListener(SubscriptionManager.OnSubscriptionsChangedListener listener)

Removes a listener from a local list of listeners. Will be triggered by setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>) when the local list of SubscriptionInfo is updated.

hasOnSubscriptionsChangedListener

public boolean hasOnSubscriptionsChangedListener(SubscriptionManager.OnSubscriptionsChangedListener listener)

Check if a listener exists in the listeners.

Parameters:

listener - The listener to check.

Returns:

boolean True if the listener already added, otherwise false.

getActiveSubscriptionIdList

@Implementation
@HiddenApi
protected int[] getActiveSubscriptionIdList()

Returns subscription Ids that were set via setActiveSubscriptionInfoList(java.util.List<android.telephony.SubscriptionInfo>).

clearNetworkRoamingStatus

public void clearNetworkRoamingStatus()

Clears the local cache of roaming subscription Ids used by isNetworkRoaming(int).

setNetworkRoamingStatus

public void setNetworkRoamingStatus(int simSubscriptionId,
 boolean isNetworkRoaming)

If isNetworkRoaming is set, it will mark the provided sim subscriptionId as roaming in a local cache. If isNetworkRoaming is unset it will remove the subscriptionId from the local cache. The local cache is used to provide roaming status returned by isNetworkRoaming(int).

isNetworkRoaming

@Implementation
protected boolean isNetworkRoaming(int simSubscriptionId)

Uses the local cache of roaming sim subscription Ids managed by setNetworkRoamingStatus(int, boolean) to return subscription Ids marked as roaming. Otherwise subscription Ids will be considered as non-roaming if they are not in the cache.

putPhoneId

public static void putPhoneId(int subId,
 int phoneId)

Adds a subscription ID-phone ID mapping to the map used by getPhoneId(int).

removePhoneId

public static Integer removePhoneId(int subId)

Removes a subscription ID-phone ID mapping from the map used by getPhoneId(int).

Returns:

the previous phone ID associated with the subscription ID, or null if there was no mapping for the subscription ID

clearPhoneIds

public static void clearPhoneIds()

Removes all mappings between subscription IDs and phone IDs from the map used by getPhoneId(int).

getPhoneId

@Implementation(maxSdk=28)
@HiddenApi
protected static int getPhoneId(int subId)

Uses the map of subscription IDs to phone IDs managed by putPhoneId(int, int) and removePhoneId(int) to return the phone ID for a given subscription ID.

getSubId

@Implementation
@HiddenApi
protected static int[] getSubId(int slotIndex)

Older form of getSubscriptionId(int) that was designed prior to mainstream multi-SIM support, so its int[] return type ended up being an unused vestige from that older design.

getSubscriptionIds

@Implementation(minSdk=29)
protected int[] getSubscriptionIds(int slotIndex)

Older form of getSubscriptionId(int) that was designed prior to mainstream multi-SIM support, so its int[] return type ended up being an unused vestige from that older design.

getSubscriptionId

@Implementation(minSdk=34)
protected static int getSubscriptionId(int slotIndex)

Derives the subscription ID corresponding to an "active" SubscriptionInfo for the given SIM slot index.

getSlotIndex

@Implementation(minSdk=26)
protected static int getSlotIndex(int subscriptionId)

setReadPhoneStatePermission

public void setReadPhoneStatePermission(boolean readPhoneStatePermission)

When set to false methods requiring Manifest.permission.READ_PHONE_STATE permission will throw a SecurityException. By default it's set to true for backwards compatibility.

setReadPhoneNumbersPermission

public void setReadPhoneNumbersPermission(boolean readPhoneNumbersPermission)

When set to false methods requiring Manifest.permission.READ_PHONE_NUMBERS permission will throw a SecurityException. By default it's set to true for backwards compatibility.

getPhoneNumber

@Implementation(minSdk=33)
protected String getPhoneNumber(int subscriptionId)

Returns the phone number for the given subscriptionId, or an empty string if not available.

The phone number can be set by setPhoneNumber(int, String)

An exception will be thrown if the READ_PHONE_NUMBERS permission has not been granted.

getPhoneNumber

@Implementation(minSdk=33)
protected String getPhoneNumber(int subscriptionId,
 int source)

Returns the phone number for the given subscriptionId, or an empty string if not available. source is ignored and will return the same as getPhoneNumber(int).

The phone number can be set by setPhoneNumber(int, String)

setPhoneNumber

public void setPhoneNumber(int subscriptionId,
 String phoneNumber)

Sets the phone number returned by getPhoneNumber(int).

reset

@Resetter
public static void reset()