Package org.robolectric.shadows

Class ShadowService

java.lang.Object

org.robolectric.shadows.ShadowContextWrapper

org.robolectric.shadows.ShadowService

Direct Known Subclasses:

ShadowAccessibilityService, ShadowInCallService, ShadowIntentService, ShadowJobService, ShadowNotificationListenerService, ShadowQuickAccessWalletService, ShadowVoiceInteractionService, ShadowVpnService

@Implements(android.app.Service.class)
public class ShadowService
extends ShadowContextWrapper

Constructor Summary

Constructors

Constructor	Description
ShadowService()

Method Summary

Modifier and Type	Method	Description
protected int	getForegroundServiceType()
Notification	getLastForegroundNotification()
int	getLastForegroundNotificationId()
boolean	getNotificationShouldRemoved()
int	getStopSelfId()	Returns id passed to stopSelf(int) method.
int	getStopSelfResultId()	Returns id passed to stopSelfResult(int) method.
boolean	isForegroundStopped()
boolean	isLastForegroundNotificationAttached()	Returns whether the last foreground notification is still "attached" to the service, meaning it will be removed when the service is destroyed.
boolean	isStoppedBySelf()
protected void	onDestroy()
void	setThrowInStartForeground(Exception e)	Configures the ShadowService so that calls to startForeground() will throw the given Exception.
protected void	startForeground(int id, Notification notification)
protected void	startForeground(int id, Notification notification, int foregroundServiceType)
protected void	stopForeground(boolean removeNotification)
protected void	stopForeground(int flags)
protected void	stopSelf()
protected void	stopSelf(int id)
protected boolean	stopSelfResult(int id)

Methods inherited from class org.robolectric.shadows.ShadowContextWrapper

clearBroadcastIntents, clearNextStartedActivities, clearStartedServices, denyPermissions, denyPermissions, getAllStartedServices, getBroadcastIntents, getBroadcastIntentsForUser, getBroadcastOptions, getNextStartedActivity, getNextStartedActivityForResult, getNextStartedService, getNextStoppedService, grantPermissions, grantPermissions, peekNextStartedActivity, peekNextStartedActivityForResult, peekNextStartedService, removeSystemService

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowService

public ShadowService()

Method Details

onDestroy

@Implementation
protected void onDestroy()

stopSelf

@Implementation
protected void stopSelf()

stopSelf

@Implementation
protected void stopSelf(int id)

stopSelfResult

@Implementation
protected boolean stopSelfResult(int id)

startForeground

@Implementation
protected void startForeground(int id,
 Notification notification)
                        throws Exception

Throws:

Exception

startForeground

@Implementation(minSdk=29)
protected void startForeground(int id,
 Notification notification,
 int foregroundServiceType)
                        throws Exception

Throws:

Exception

stopForeground

@Implementation
protected void stopForeground(boolean removeNotification)

getForegroundServiceType

@Implementation(minSdk=29)
protected int getForegroundServiceType()

stopForeground

@Implementation(minSdk=24)
protected void stopForeground(int flags)

getLastForegroundNotificationId

public int getLastForegroundNotificationId()

getLastForegroundNotification

public Notification getLastForegroundNotification()

isLastForegroundNotificationAttached

public boolean isLastForegroundNotificationAttached()

Returns whether the last foreground notification is still "attached" to the service, meaning it will be removed when the service is destroyed.

isStoppedBySelf

public boolean isStoppedBySelf()

Returns:

Is this service stopped by self.

isForegroundStopped

public boolean isForegroundStopped()

getNotificationShouldRemoved

public boolean getNotificationShouldRemoved()

getStopSelfId

public int getStopSelfId()

Returns id passed to stopSelf(int) method. Make sure to check result of isStoppedBySelf() first.

getStopSelfResultId

public int getStopSelfResultId()

Returns id passed to stopSelfResult(int) method. Make sure to check result of isStoppedBySelf() first.

setThrowInStartForeground

public void setThrowInStartForeground(Exception e)

Configures the ShadowService so that calls to startForeground() will throw the given Exception. It can throw: ForegroundServiceStartNotAllowedException: https://developer.android.com/reference/android/app/ForegroundServiceStartNotAllowedException Or InvalidForegroundServiceTypeException: https://developer.android.com/reference/android/app/InvalidForegroundServiceTypeException Or MissingForegroundServiceTypeException: https://developer.android.com/reference/android/app/MissingForegroundServiceTypeException Or SecurityException: https://developer.android.com/reference/java/lang/SecurityException

Details in: https://developer.android.com/reference/android/app/Service#startForeground(int,%20android.app.Notification)