transient_task_api.h

概述

提供短时任务申请、查询、取消功能。

引用文件： <transient_task/transient_task_api.h>

库： libtransient_task.so

系统能力： SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

起始版本： 13

相关模块： TransientTask

名称	描述
int32_t OH_BackgroundTaskManager_RequestSuspendDelay(const char* reason,TransientTask_Callback callback, TransientTask_DelaySuspendInfo *info)	申请短时任务。
int32_t OH_BackgroundTaskManager_GetRemainingDelayTime(int32_t requestId, int32_t *delayTime)	获取本次短时任务的剩余时间。
int32_t OH_BackgroundTaskManager_CancelSuspendDelay(int32_t requestId)	取消短时任务。

int32_t OH_BackgroundTaskManager_RequestSuspendDelay(const char* reason,TransientTask_Callback callback, TransientTask_DelaySuspendInfo *info)

描述

申请短时任务。

系统能力： SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

起始版本： 13

参数：

参数项	描述
const char* reason	申请短时任务的原因。
TransientTask_Callback callback	短时任务即将超时的回调，一般在超时前6秒，通过此回调通知应用。
TransientTask_DelaySuspendInfo *info	返回短时任务信息。

返回：

类型	说明
int32_t	返回0，表示申请成功。返回401，表示入参错误。返回9800002，表示Parcel读写操作失败。返回9800003，表示IPC通信失败。返回9800004，表示系统服务失败。返回9900001，表示短时任务客户端信息校验失败。返回9900002，表示短时任务服务端校验失败。错误码的具体信息请参考TransientTask_ErrorCode。

int32_t OH_BackgroundTaskManager_GetRemainingDelayTime(int32_t requestId, int32_t *delayTime)

描述

获取本次短时任务的剩余时间。

系统能力： SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

起始版本： 13

参数：

参数项	描述
int32_t requestId	短时任务的请求ID。
int32_t *delayTime	短时任务的剩余时间。

返回：

类型	说明
int32_t	返回0，表示查询成功。返回401，表示入参错误。返回9800002，表示Parcel读写操作失败。返回9800003，表示IPC通信失败。返回9800004，表示系统服务失败。返回9900001，表示短时任务客户端信息校验失败。返回9900002，表示短时任务服务端校验失败。错误码的具体信息请参考TransientTask_ErrorCode。

int32_t OH_BackgroundTaskManager_CancelSuspendDelay(int32_t requestId)

描述

取消短时任务。

系统能力： SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

起始版本： 13

参数：

参数项	描述
int32_t requestId	短时任务的请求ID。

返回：

类型	说明
int32_t	返回0，表示取消成功。返回401，表示入参错误。返回9800002，表示Parcel读写操作失败。返回9800003，表示IPC通信失败。返回9800004，表示系统服务失败。返回9900001，表示短时任务客户端信息校验失败。返回9900002，表示短时任务服务端校验失败。错误码的具体信息请参考TransientTask_ErrorCode。