程序包 ohos.backgroundtaskmgr

类 BackgroundTaskManager

java.lang.Object

ohos.backgroundtaskmgr.BackgroundTaskManager

public class BackgroundTaskManager
extends Object

Manages background tasks.

After an application runs in the background for a period of time, it will enter the suspended state and cannot execute tasks. If the application needs to continue unfinished tasks in the background, it can send a request to BackgroundTaskManager to delay transition to the suspended state. This class provides the methods to request and cancel delayed transition to the suspended state and to query the remaining time before an application enters the suspended state.

从以下版本开始:

1

SystemCapability

SystemCapability.ResourceSchedule#BACKGROUND_TASK_MANAGER

构造器概要

构造器

构造器	说明
BackgroundTaskManager(Context context)	A constructor used to create a BackgroundTaskManager instance for initializing background task management objects based on the specified application context.

方法概要

限定符和类型	方法	说明
void	cancelSuspendDelay(int requestId)	Cancels delayed transition to the suspended state.
int	getRemainingDelayTime(int requestId)	Obtains the remaining time before an application enters the suspended state.
DelaySuspendInfo	requestSuspendDelay(String reason, ExpiredCallback cb)	Requests delayed transition to the suspended state.

从类继承的方法 java.lang.Object

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

构造器详细资料

BackgroundTaskManager

public BackgroundTaskManager(Context context)

A constructor used to create a BackgroundTaskManager instance for initializing background task management objects based on the specified application context.

参数:

context - Indicates the application context. This parameter cannot be null.

从以下版本开始:

3

方法详细资料

requestSuspendDelay

public DelaySuspendInfo requestSuspendDelay(String reason,
                                            ExpiredCallback cb)
                                     throws RemoteException

Requests delayed transition to the suspended state.

If an application needs to execute tasks in the background, it must send a request for delayed transition to the suspended state and describe the reason. When the requested delay duration times out, ExpiredCallback will be called to notify the application.

参数:

reason - Indicates the reason for delayed transition to the suspended state. The parameter cannot be null.

cb - Indicates the callback for timeout of the delay duration. The parameter cannot be null.

返回:

Returns DelaySuspendInfo carrying the result of requesting delayed transition to the suspended state.

抛出:

RemoteException - Throws this exception when a remote communication error occurs. In this case, you are advised to call this method again.

从以下版本开始:

1

cancelSuspendDelay

public void cancelSuspendDelay(int requestId)
                        throws RemoteException

Cancels delayed transition to the suspended state.

If an application finishes a task before the delay duration times out, the application can request to terminate the delayed transition to the suspended state.

参数:

requestId - Uniquely identifies the request for delayed transition to the suspended state. You can call DelaySuspendInfo#getRequestId() to obtain requestId. Note that an application can query only requestId of the requests it initiated.

抛出:

RemoteException - Throws this exception when a remote communication error occurs. In this case, you are advised to call this method again.

从以下版本开始:

1

getRemainingDelayTime

public int getRemainingDelayTime(int requestId)
                          throws RemoteException

Obtains the remaining time before an application enters the suspended state.

参数:

requestId - Uniquely identifies the request for delayed transition to the suspended state. You can call DelaySuspendInfo#getRequestId() to obtain requestId. Note that an application can query only requestId of the requests it initiated.

返回:

Returns the remaining time before an application enters the suspended state, in ms.

抛出:

RemoteException - Throws this exception when a remote communication error occurs. In this case, you are advised to call this method again.

从以下版本开始:

1