Package org.robolectric.shadows

Class ShadowCarrierConfigManager

java.lang.Object

org.robolectric.shadows.ShadowCarrierConfigManager

@Implements(value=android.telephony.CarrierConfigManager.class,
            minSdk=23)
public class ShadowCarrierConfigManager
extends Object

Constructor Summary

Constructors

Constructor	Description
ShadowCarrierConfigManager()

Method Summary

Modifier and Type	Method	Description
PersistableBundle	getConfigForSubId(int subId)	Returns PersistableBundle previously set by overrideConfig(int, android.os.PersistableBundle) or setConfigForSubId(int, PersistableBundle), or default values for an invalid subId.
PersistableBundle	getConfigForSubId(int subId, String... keys)	Returns PersistableBundle containing the specified keys for a particular subscription.
protected void	overrideConfig(int subId, PersistableBundle config)	Overrides the carrier config of the provided subscription ID with the provided values.
protected void	registerCarrierConfigChangeListener(Executor executor, CarrierConfigManager.CarrierConfigChangeListener listener)
static void	reset()
void	setConfigForSubId(int subId, PersistableBundle config)	Sets that the config PersistableBundle for a particular subId; controls the return value of CarrierConfigManager.getConfigForSubId(int, String...).
void	setReadPhoneStatePermission(boolean readPhoneStatePermission)
protected void	unregisterCarrierConfigChangeListener(CarrierConfigManager.CarrierConfigChangeListener listener)

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowCarrierConfigManager

public ShadowCarrierConfigManager()

Method Details

reset

@Resetter
public static void reset()

getConfigForSubId

@Implementation
public PersistableBundle getConfigForSubId(int subId)

Returns PersistableBundle previously set by overrideConfig(int, android.os.PersistableBundle) or setConfigForSubId(int, PersistableBundle), or default values for an invalid subId.

getConfigForSubId

@Implementation(minSdk=34)
@Nonnull
public PersistableBundle getConfigForSubId(int subId,
 @Nonnull
 String... keys)

Returns PersistableBundle containing the specified keys for a particular subscription. setConfigForSubId(int, PersistableBundle), or default values for an invalid subId.

setReadPhoneStatePermission

public void setReadPhoneStatePermission(boolean readPhoneStatePermission)

setConfigForSubId

public void setConfigForSubId(int subId,
 PersistableBundle config)

Sets that the config PersistableBundle for a particular subId; controls the return value of CarrierConfigManager.getConfigForSubId(int, String...).

This will trigger a

invalid reference

ACTION_CARRIER_CONFIG_CHANGED

broadcast and a CarrierConfigManager.CarrierConfigChangeListener callback if a listener is registered. Callers may optionally configure the following included extras:

• Sim slot index: via the SubscriptionInfo for the provided subId. Configure an active subscription via
  invalid reference

  ShadowSubscriptionManager#setActiveSubscriptionInfo(SubscriptionInfo)

  . If no logical slot is configured, 0 will be used.
• Carrier ID (SDK P+ only): via TelephonyManager.getSimCarrierId(). ShadowTelephonyManager does not currently operate on a per-subscription basis. To configure a different carrier ID for different subscriptions, use
  invalid reference

  ShadowTelephonyManager#setTelephonyManagerForSubscriptionId(int)

  and provide a mock instance. Otherwise,
  invalid reference

  TelephonyManager.UNKNOWN_CARRIER_ID

  will be set.
• Specific carrier ID (SDK Q+ only): via TelephonyManager.getSimSpecificCarrierId(). The same limitation as carrier ID applies.

registerCarrierConfigChangeListener

@Implementation(minSdk=34)
protected void registerCarrierConfigChangeListener(Executor executor,
 CarrierConfigManager.CarrierConfigChangeListener listener)

unregisterCarrierConfigChangeListener

@Implementation(minSdk=34)
protected void unregisterCarrierConfigChangeListener(CarrierConfigManager.CarrierConfigChangeListener listener)

overrideConfig

@Implementation(minSdk=29)
@HiddenApi
protected void overrideConfig(int subId,
 @Nullable
 PersistableBundle config)

Overrides the carrier config of the provided subscription ID with the provided values.

This method will NOT check if overrideValues contains valid values for specified config keys. It also won't trigger a broadcast or callback for a carrier config change. Keep in mind this is a test API, not intended for usage in production code. Callers should just use setConfigForSubId(int, PersistableBundle) instead.