Package org.robolectric.shadows

Class ShadowTelecomManager

java.lang.Object

org.robolectric.shadows.ShadowTelecomManager

@Implements(android.telecom.TelecomManager.class)
public class ShadowTelecomManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowTelecomManager.CallRecord	Deprecated. Use ShadowTelecomManager.IncomingCallRecord or ShadowTelecomManager.UnknownCallRecord instead.
static enum	ShadowTelecomManager.CallRequestMode	Mode describing how the shadow handles incoming (TelecomManager.addNewIncomingCall(android.telecom.PhoneAccountHandle, android.os.Bundle)) and outgoing (TelecomManager.placeCall(android.net.Uri, android.os.Bundle)) call requests.
static class	ShadowTelecomManager.IncomingCallRecord	Details about an incoming call request made via TelecomManager.addNewIncomingCall(android.telecom.PhoneAccountHandle, android.os.Bundle).
static class	ShadowTelecomManager.OutgoingCallRecord	Details about an outgoing call request made via TelecomManager.placeCall(android.net.Uri, android.os.Bundle).
static class	ShadowTelecomManager.UnknownCallRecord	Details about an unknown call request made via TelecomManager.addNewUnknownCall(android.telecom.PhoneAccountHandle, android.os.Bundle).

Constructor Summary

Constructors

Constructor	Description
ShadowTelecomManager()

Method Summary

Modifier and Type	Method	Description
protected void	acceptRingingCall()
protected void	addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras)
void	addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras)
Connection	allowIncomingCall(ShadowTelecomManager.IncomingCallRecord call)	Allows an ShadowTelecomManager.IncomingCallRecord created via TelecomManager.addNewIncomingCall(android.telecom.PhoneAccountHandle, android.os.Bundle).
Connection	allowOutgoingCall(ShadowTelecomManager.OutgoingCallRecord call)	Allows an ShadowTelecomManager.OutgoingCallRecord created via TelecomManager.placeCall(android.net.Uri, android.os.Bundle).
protected void	cancelMissedCallsNotification()
void	clearAccounts()	Deprecated.
void	clearAccountsForPackage(String packageName)
protected Intent	createLaunchEmergencyDialerIntent(String number)
protected Intent	createManageBlockedNumbersIntent()	Returns the intent set by setManageBlockNumbersIntent(Intent) ()}
void	denyIncomingCall(ShadowTelecomManager.IncomingCallRecord call)	Denies an ShadowTelecomManager.IncomingCallRecord created via TelecomManager.addNewIncomingCall(android.telecom.PhoneAccountHandle, android.os.Bundle).
void	denyOutgoingCall(ShadowTelecomManager.OutgoingCallRecord call)	Denies an ShadowTelecomManager.OutgoingCallRecord created via TelecomManager.placeCall(android.net.Uri, android.os.Bundle).
void	enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled)
boolean	endCall()
protected Uri	getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle)
List<ShadowTelecomManager.IncomingCallRecord>	getAllIncomingCalls()
List<ShadowTelecomManager.OutgoingCallRecord>	getAllOutgoingCalls()
List<PhoneAccountHandle>	getAllPhoneAccountHandles()
List<PhoneAccount>	getAllPhoneAccounts()
int	getAllPhoneAccountsCount()
List<ShadowTelecomManager.UnknownCallRecord>	getAllUnknownCalls()
protected List<PhoneAccountHandle>	getCallCapablePhoneAccounts()
List<PhoneAccountHandle>	getCallCapablePhoneAccounts(boolean includeDisabledAccounts)
ShadowTelecomManager.CallRequestMode	getCallRequestMode()
int	getCallState()
PhoneAccountHandle	getConnectionManager()
int	getCurrentTtyMode()
protected String	getDefaultDialerPackage()
protected PhoneAccountHandle	getDefaultOutgoingPhoneAccount(String uriScheme)	Returns default outgoing phone account set through setDefaultOutgoingPhoneAccount(String, PhoneAccountHandle) for corresponding uriScheme.
ComponentName	getDefaultPhoneApp()	Deprecated.
ShadowTelecomManager.IncomingCallRecord	getLastIncomingCall()
ShadowTelecomManager.OutgoingCallRecord	getLastOutgoingCall()
ShadowTelecomManager.UnknownCallRecord	getLastUnknownCall()
protected String	getLine1Number(PhoneAccountHandle accountHandle)
ShadowTelecomManager.IncomingCallRecord	getOnlyIncomingCall()
ShadowTelecomManager.OutgoingCallRecord	getOnlyOutgoingCall()
ShadowTelecomManager.UnknownCallRecord	getOnlyUnknownCall()
protected PhoneAccount	getPhoneAccount(PhoneAccountHandle account)
List<PhoneAccountHandle>	getPhoneAccountsForPackage()
List<PhoneAccountHandle>	getPhoneAccountsSupportingScheme(String uriScheme)
List<PhoneAccountHandle>	getSelfManagedPhoneAccounts()
protected PhoneAccountHandle	getSimCallManager()
PhoneAccountHandle	getSimCallManager(int userId)
protected String	getSystemDialerPackage()
PhoneAccountHandle	getUserSelectedOutgoingPhoneAccount()
protected String	getVoiceMailNumber(PhoneAccountHandle accountHandle)
protected boolean	handleMmi(String dialString)
protected boolean	handleMmi(String dialString, PhoneAccountHandle accountHandle)
protected boolean	isInCall()	Overrides behavior of TelecomManager.isInCall() to return pre-set result.
protected boolean	isInEmergencyCall()	Overrides behavior of TelecomManager.isInEmergencyCall() to return pre-set result.
protected boolean	isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle)
boolean	isRinging()
protected boolean	isTtySupported()
protected boolean	isVoiceMailNumber(PhoneAccountHandle accountHandle, String number)
CallAudioState	newCallAudioState(boolean muted, int route, int supportedRouteMask, BluetoothDevice activeBluetoothDevice, Collection<BluetoothDevice> supportedBluetoothDevices)	Creates a new CallAudioState.
protected void	placeCall(Uri address, Bundle extras)
protected void	registerPhoneAccount(PhoneAccount account)
void	removeDefaultOutgoingPhoneAccount(String uriScheme)	Remove default outgoing phone account for corresponding uriScheme.
static void	reset()
void	setCallPhonePermission(boolean callPhonePermission)	When set to false methods requiring android.Manifest.permission.CALL_PHONE permission will throw a SecurityException.
void	setCallRequestMode(ShadowTelecomManager.CallRequestMode callRequestMode)
void	setConnectionService(ConnectionService service)	Set connection service.
boolean	setDefaultDialer(String packageName)	Deprecated. API deprecated since Q, for testing, use setDefaultDialerPackage instead
void	setDefaultDialerPackage(String packageName)	Set returned value of getDefaultDialerPackage().
void	setDefaultOutgoingPhoneAccount(String uriScheme, PhoneAccountHandle handle)	Set default outgoing phone account to be returned from getDefaultOutgoingPhoneAccount(String) for corresponding uriScheme.
void	setHandleMmiValue(boolean handleMmiValue)
void	setIsInCall(boolean isInCall)	Sets the return value for TelecomManager.isInCall().
void	setIsInEmergencyCall(boolean isInEmergencyCall)	Sets the return value for TelecomManager.isInEmergencyCall() and TelecomManager.isInCall().
void	setIsOutgoingCallPermitted(boolean isOutgoingCallPermitted)	Sets the result of TelecomManager.isOutgoingCallPermitted(PhoneAccountHandle).
void	setLine1Number(PhoneAccountHandle accountHandle, String number)
void	setManageBlockNumbersIntent(Intent intent)	Sets the BlockNumbersIntent to be returned by createManageBlockedNumbersIntent()
void	setReadPhoneStatePermission(boolean readPhoneStatePermission)	When set to false methods requiring android.Manifest.permission.READ_PHONE_STATE permission will throw a SecurityException.
void	setSimCallManager(PhoneAccountHandle simCallManager)
void	setSystemDialerPackage(String packageName)	Set returned value of getSystemDialerPackage().
void	setTtySupported(boolean isSupported)	Sets the value to be returned by isTtySupported().
void	setUserSelectedOutgoingPhoneAccount(PhoneAccountHandle accountHandle)
void	setVoicemailNumber(PhoneAccountHandle accountHandle, String number)
protected void	showInCallScreen(boolean showDialpad)
protected void	silenceRinger()
protected void	unregisterPhoneAccount(PhoneAccountHandle accountHandle)

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowTelecomManager

public ShadowTelecomManager()

Method Details

reset

@Resetter
public static void reset()

getCallRequestMode

public ShadowTelecomManager.CallRequestMode getCallRequestMode()

setCallRequestMode

public void setCallRequestMode(ShadowTelecomManager.CallRequestMode callRequestMode)

setDefaultOutgoingPhoneAccount

public void setDefaultOutgoingPhoneAccount(String uriScheme,
 PhoneAccountHandle handle)

Set default outgoing phone account to be returned from getDefaultOutgoingPhoneAccount(String) for corresponding uriScheme.

removeDefaultOutgoingPhoneAccount

public void removeDefaultOutgoingPhoneAccount(String uriScheme)

Remove default outgoing phone account for corresponding uriScheme.

setIsOutgoingCallPermitted

public void setIsOutgoingCallPermitted(boolean isOutgoingCallPermitted)

Sets the result of TelecomManager.isOutgoingCallPermitted(PhoneAccountHandle).

getDefaultOutgoingPhoneAccount

@Implementation
protected PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme)

Returns default outgoing phone account set through setDefaultOutgoingPhoneAccount(String, PhoneAccountHandle) for corresponding uriScheme.

getUserSelectedOutgoingPhoneAccount

@Implementation
@HiddenApi
public PhoneAccountHandle getUserSelectedOutgoingPhoneAccount()

setUserSelectedOutgoingPhoneAccount

@Implementation
@HiddenApi
public void setUserSelectedOutgoingPhoneAccount(PhoneAccountHandle accountHandle)

getSimCallManager

@Implementation
protected PhoneAccountHandle getSimCallManager()

getSimCallManager

@Implementation(minSdk=23)
@HiddenApi
public PhoneAccountHandle getSimCallManager(int userId)

getConnectionManager

@Implementation
@HiddenApi
public PhoneAccountHandle getConnectionManager()

getPhoneAccountsSupportingScheme

@Implementation
@HiddenApi
public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme)

getCallCapablePhoneAccounts

@Implementation(minSdk=23)
protected List<PhoneAccountHandle> getCallCapablePhoneAccounts()

getCallCapablePhoneAccounts

@Implementation(minSdk=23)
@HiddenApi
public List<PhoneAccountHandle> getCallCapablePhoneAccounts(boolean includeDisabledAccounts)

getSelfManagedPhoneAccounts

@Implementation(minSdk=26)
public List<PhoneAccountHandle> getSelfManagedPhoneAccounts()

getPhoneAccountsForPackage

@Implementation
@HiddenApi
public List<PhoneAccountHandle> getPhoneAccountsForPackage()

getPhoneAccount

@Implementation
protected PhoneAccount getPhoneAccount(PhoneAccountHandle account)

getAllPhoneAccountsCount

@Implementation
@HiddenApi
public int getAllPhoneAccountsCount()

getAllPhoneAccounts

@Implementation
@HiddenApi
public List<PhoneAccount> getAllPhoneAccounts()

getAllPhoneAccountHandles

@Implementation
@HiddenApi
public List<PhoneAccountHandle> getAllPhoneAccountHandles()

registerPhoneAccount

@Implementation
protected void registerPhoneAccount(PhoneAccount account)

unregisterPhoneAccount

@Implementation
protected void unregisterPhoneAccount(PhoneAccountHandle accountHandle)

clearAccounts

@Deprecated
@Implementation
@HiddenApi
public void clearAccounts()

Deprecated.

clearAccountsForPackage

@Implementation(minSdk=22)
@HiddenApi
public void clearAccountsForPackage(String packageName)

getDefaultPhoneApp

@Deprecated
@Implementation
@HiddenApi
public ComponentName getDefaultPhoneApp()

Deprecated.

getDefaultDialerPackage

@Implementation(minSdk=23)
protected String getDefaultDialerPackage()

setDefaultDialer

@Deprecated
@Implementation(minSdk=23)
@HiddenApi
public boolean setDefaultDialer(String packageName)

Deprecated.

API deprecated since Q, for testing, use setDefaultDialerPackage instead

setDefaultDialerPackage

public void setDefaultDialerPackage(String packageName)

Set returned value of getDefaultDialerPackage().

getSystemDialerPackage

@Implementation(minSdk=23)
@HiddenApi
protected String getSystemDialerPackage()

setSystemDialerPackage

public void setSystemDialerPackage(String packageName)

Set returned value of getSystemDialerPackage().

setVoicemailNumber

public void setVoicemailNumber(PhoneAccountHandle accountHandle,
 String number)

isVoiceMailNumber

@Implementation(minSdk=23)
protected boolean isVoiceMailNumber(PhoneAccountHandle accountHandle,
 String number)

getVoiceMailNumber

@Implementation(minSdk=23)
protected String getVoiceMailNumber(PhoneAccountHandle accountHandle)

getLine1Number

@Implementation(minSdk=22)
protected String getLine1Number(PhoneAccountHandle accountHandle)

setLine1Number

public void setLine1Number(PhoneAccountHandle accountHandle,
 String number)

setIsInCall

public void setIsInCall(boolean isInCall)

Sets the return value for TelecomManager.isInCall().

isInCall

@Implementation
protected boolean isInCall()

Overrides behavior of TelecomManager.isInCall() to return pre-set result.

Returns:

Value set by calling setIsInCall(boolean) or setIsInEmergencyCall(boolean). If neither has previously been called, will return false.

setIsInEmergencyCall

public void setIsInEmergencyCall(boolean isInEmergencyCall)

Sets the return value for TelecomManager.isInEmergencyCall() and TelecomManager.isInCall().

isInEmergencyCall

@Implementation(minSdk=29)
protected boolean isInEmergencyCall()

Overrides behavior of TelecomManager.isInEmergencyCall() to return pre-set result.

Returns:

Value set by calling setIsInEmergencyCall(boolean). If setIsInEmergencyCall has not previously been called, will return false.

getCallState

@Implementation
@HiddenApi
public int getCallState()

isRinging

@Implementation
@HiddenApi
public boolean isRinging()

endCall

@Implementation
@HiddenApi
public boolean endCall()

acceptRingingCall

@Implementation
protected void acceptRingingCall()

silenceRinger

@Implementation
protected void silenceRinger()

isTtySupported

@Implementation
protected boolean isTtySupported()

setTtySupported

public void setTtySupported(boolean isSupported)

Sets the value to be returned by isTtySupported().

getCurrentTtyMode

@Implementation
@HiddenApi
public int getCurrentTtyMode()

addNewIncomingCall

@Implementation
protected void addNewIncomingCall(PhoneAccountHandle phoneAccount,
 Bundle extras)

getAllIncomingCalls

public List<ShadowTelecomManager.IncomingCallRecord> getAllIncomingCalls()

getLastIncomingCall

public ShadowTelecomManager.IncomingCallRecord getLastIncomingCall()

getOnlyIncomingCall

public ShadowTelecomManager.IncomingCallRecord getOnlyIncomingCall()

allowIncomingCall

public Connection allowIncomingCall(ShadowTelecomManager.IncomingCallRecord call)

Allows an ShadowTelecomManager.IncomingCallRecord created via TelecomManager.addNewIncomingCall(android.telecom.PhoneAccountHandle, android.os.Bundle).

Specifically, this method sets up the relevant ConnectionService and returns the result of ConnectionService.onCreateIncomingConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest).

denyIncomingCall

public void denyIncomingCall(ShadowTelecomManager.IncomingCallRecord call)

Denies an ShadowTelecomManager.IncomingCallRecord created via TelecomManager.addNewIncomingCall(android.telecom.PhoneAccountHandle, android.os.Bundle).

Specifically, this method sets up the relevant ConnectionService and calls ConnectionService.onCreateIncomingConnectionFailed(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest).

placeCall

@Implementation(minSdk=23)
protected void placeCall(Uri address,
 Bundle extras)

getAllOutgoingCalls

public List<ShadowTelecomManager.OutgoingCallRecord> getAllOutgoingCalls()

getLastOutgoingCall

public ShadowTelecomManager.OutgoingCallRecord getLastOutgoingCall()

getOnlyOutgoingCall

public ShadowTelecomManager.OutgoingCallRecord getOnlyOutgoingCall()

allowOutgoingCall

public Connection allowOutgoingCall(ShadowTelecomManager.OutgoingCallRecord call)

Allows an ShadowTelecomManager.OutgoingCallRecord created via TelecomManager.placeCall(android.net.Uri, android.os.Bundle).

Specifically, this method sets up the relevant ConnectionService and returns the result of ConnectionService.onCreateOutgoingConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest).

denyOutgoingCall

public void denyOutgoingCall(ShadowTelecomManager.OutgoingCallRecord call)

Denies an ShadowTelecomManager.OutgoingCallRecord created via TelecomManager.placeCall(android.net.Uri, android.os.Bundle).

Specifically, this method sets up the relevant ConnectionService and calls ConnectionService.onCreateOutgoingConnectionFailed(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest).

addNewUnknownCall

@Implementation
@HiddenApi
public void addNewUnknownCall(PhoneAccountHandle phoneAccount,
 Bundle extras)

getAllUnknownCalls

public List<ShadowTelecomManager.UnknownCallRecord> getAllUnknownCalls()

getLastUnknownCall

public ShadowTelecomManager.UnknownCallRecord getLastUnknownCall()

getOnlyUnknownCall

public ShadowTelecomManager.UnknownCallRecord getOnlyUnknownCall()

setConnectionService

public void setConnectionService(ConnectionService service)

Set connection service.

This method can be used in case, when you already created connection service and would like to use it in telecom manager instead of creating new one.

Parameters:

service - existing connection service

setHandleMmiValue

public void setHandleMmiValue(boolean handleMmiValue)

handleMmi

@Implementation
protected boolean handleMmi(String dialString)

handleMmi

@Implementation(minSdk=23)
protected boolean handleMmi(String dialString,
 PhoneAccountHandle accountHandle)

getAdnUriForPhoneAccount

@Implementation(minSdk=22)
protected Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle)

cancelMissedCallsNotification

@Implementation
protected void cancelMissedCallsNotification()

showInCallScreen

@Implementation
protected void showInCallScreen(boolean showDialpad)

enablePhoneAccount

@Implementation(minSdk=23)
@HiddenApi
public void enablePhoneAccount(PhoneAccountHandle handle,
 boolean isEnabled)

createManageBlockedNumbersIntent

@Implementation(minSdk=24)
protected Intent createManageBlockedNumbersIntent()

Returns the intent set by setManageBlockNumbersIntent(Intent) ()}

setManageBlockNumbersIntent

public void setManageBlockNumbersIntent(Intent intent)

Sets the BlockNumbersIntent to be returned by createManageBlockedNumbersIntent()

setSimCallManager

@Implementation(maxSdk=22)
public void setSimCallManager(PhoneAccountHandle simCallManager)

newCallAudioState

public CallAudioState newCallAudioState(boolean muted,
 int route,
 int supportedRouteMask,
 BluetoothDevice activeBluetoothDevice,
 Collection<BluetoothDevice> supportedBluetoothDevices)

Creates a new CallAudioState. The real constructor of CallAudioState is hidden.

createLaunchEmergencyDialerIntent

@Implementation(minSdk=30)
protected Intent createLaunchEmergencyDialerIntent(String number)

isOutgoingCallPermitted

@Implementation(minSdk=26)
protected boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle)

setReadPhoneStatePermission

public void setReadPhoneStatePermission(boolean readPhoneStatePermission)

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

setCallPhonePermission

public void setCallPhonePermission(boolean callPhonePermission)

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