com.pega.mobile.utils.keepalive

Class KeepAlive

java.lang.Object

com.pega.mobile.utils.keepalive.KeepAlive

@Singleton
public class KeepAlive
extends Object

This is a class used to manage the KeepAliveForegroundService which is a foreground service meant to increase the priority of the process, thus decreasing the likelihood of the app being killed by the system.

Constructor Summary

Constructors

Constructor and Description
KeepAlive(Context context)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decreaseCounter()
protected int	getCounter()
void	notifyAlarmStopped()
void	startKeepAlive() Starts the keep-alive foreground service with default parameters, message equal to "Waiting for an external action to finish" and no timeout
void	startKeepAlive(String message, long timeout) Starts the keep-alive foreground service
void	stopKeepAlive(boolean shouldForce) Stops the keep-alive foreground service.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeepAlive

@Inject
public KeepAlive(Context context)

Method Detail

startKeepAlive

public void startKeepAlive()

Starts the keep-alive foreground service with default parameters, message equal to "Waiting for an external action to finish" and no timeout

startKeepAlive

public void startKeepAlive(String message,
                  long timeout)

Starts the keep-alive foreground service

Parameters:

message - The message to be displayed in the notification

timeout - Time in seconds after which the service will automatically stop. If <=0, the service will never stop by itself

notifyAlarmStopped

public void notifyAlarmStopped()

getCounter

protected int getCounter()

decreaseCounter

protected void decreaseCounter()

stopKeepAlive

public void stopKeepAlive(boolean shouldForce)

Stops the keep-alive foreground service. Note: If startKeepAlive was called multiple times, stopKeepAlive must be called the same amount of times in order for the service to actually stop. If you want to force-stop the service, use a shouldForce argument equal to true

Parameters:

shouldForce - Whether the service should be force stopped immediately