1# transient_task_api.h 2 3## 概述 4 5提供短时任务申请、查询、取消功能。 6 7**引用文件：** <transient_task/transient_task_api.h> 8 9**库：** libtransient_task.so 10 11**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask 12 13**起始版本：** 13 14 15**相关模块：** [TransientTask](capi-transienttask.md) 16 17## 汇总 18 19### 函数 20 21| 名称 | 描述 | 22| -- | -- | 23| [int32_t OH_BackgroundTaskManager_RequestSuspendDelay(const char* reason,TransientTask_Callback callback, TransientTask_DelaySuspendInfo *info)](#oh_backgroundtaskmanager_requestsuspenddelay) | 申请短时任务。 | 24| [int32_t OH_BackgroundTaskManager_GetRemainingDelayTime(int32_t requestId, int32_t *delayTime)](#oh_backgroundtaskmanager_getremainingdelaytime) | 获取本次短时任务的剩余时间。 | 25| [int32_t OH_BackgroundTaskManager_CancelSuspendDelay(int32_t requestId)](#oh_backgroundtaskmanager_cancelsuspenddelay) | 取消短时任务。 | 26| [int32_t OH_BackgroundTaskManager_GetTransientTaskInfo(TransientTask_TransientTaskInfo *transientTaskInfo)](#oh_backgroundtaskmanager_gettransienttaskinfo) | 获取所有短时任务信息，如当日剩余总配额等。 | 27 28## 函数说明 29 30### OH_BackgroundTaskManager_RequestSuspendDelay() 31 32``` 33int32_t OH_BackgroundTaskManager_RequestSuspendDelay(const char* reason,TransientTask_Callback callback, TransientTask_DelaySuspendInfo *info) 34``` 35 36**描述** 37 38申请短时任务。 39 40**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask 41 42**起始版本：** 13 43 44 45**参数：** 46 47| 参数项 | 描述 | 48|----------------------------------------------------------------------------------------------| -- | 49| const char* reason | 申请短时任务的原因。 | 50| [TransientTask_Callback](capi-transient-task-type-h.md#transienttask_callback) callback | 短时任务即将超时的回调，一般在超时前6秒，通过此回调通知应用。 | 51| [TransientTask_DelaySuspendInfo](capi-transienttask-transienttask-delaysuspendinfo.md) *info | 返回短时任务信息。 | 52 53**返回：** 54 55| 类型 | 说明 | 56| -- | -- | 57| int32_t | 返回0，表示申请成功。<br> 返回401，表示入参错误。<br> 返回9800002，表示Parcel读写操作失败。<br> 返回9800003，表示IPC通信失败。<br> 返回9800004，表示系统服务失败。<br> 返回9900001，表示短时任务客户端信息校验失败。<br> 返回9900002，表示短时任务服务端校验失败。<br> 错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | 58 59### OH_BackgroundTaskManager_GetRemainingDelayTime() 60 61``` 62int32_t OH_BackgroundTaskManager_GetRemainingDelayTime(int32_t requestId, int32_t *delayTime) 63``` 64 65**描述** 66 67获取本次短时任务的剩余时间。 68 69**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask 70 71**起始版本：** 13 72 73 74**参数：** 75 76| 参数项 | 描述 | 77| -- | -- | 78| int32_t requestId | 短时任务的请求ID。 | 79| int32_t *delayTime | 短时任务的剩余时间。 | 80 81**返回：** 82 83| 类型 | 说明 | 84| -- | -- | 85| int32_t | 返回0，表示查询成功。<br> 返回401，表示入参错误。<br> 返回9800002，表示Parcel读写操作失败。<br> 返回9800003，表示IPC通信失败。<br> 返回9800004，表示系统服务失败。<br> 返回9900001，表示短时任务客户端信息校验失败。<br> 返回9900002，表示短时任务服务端校验失败。<br> 错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | 86 87### OH_BackgroundTaskManager_CancelSuspendDelay() 88 89``` 90int32_t OH_BackgroundTaskManager_CancelSuspendDelay(int32_t requestId) 91``` 92 93**描述** 94 95取消短时任务。 96 97**系统能力：** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask 98 99**起始版本：** 13 100 101 102**参数：** 103 104| 参数项 | 描述 | 105| -- | -- | 106| int32_t requestId | 短时任务的请求ID。 | 107 108**返回：** 109 110| 类型 | 说明 | 111| -- | -- | 112| int32_t | 返回0，表示取消成功。<br> 返回401，表示入参错误。<br> 返回9800002，表示Parcel读写操作失败。<br> 返回9800003，表示IPC通信失败。<br> 返回9800004，表示系统服务失败。<br> 返回9900001，表示短时任务客户端信息校验失败。<br> 返回9900002，表示短时任务服务端校验失败。<br> 错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | 113 114### OH_BackgroundTaskManager_GetTransientTaskInfo() 115 116``` 117int32_t OH_BackgroundTaskManager_GetTransientTaskInfo(TransientTask_TransientTaskInfo *transientTaskInfo) 118``` 119 120**描述** 121 122获取所有短时任务信息，如当日剩余总配额等。 123 124**起始版本：** 20 125 126 127**参数：** 128 129| 参数项 | 描述 | 130|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| 131| [TransientTask_TransientTaskInfo ](capi-transienttask-transienttask-transienttaskinfo.md) *transientTaskInfo | 所有短时任务信息，具体请参考[TransientTask_TransientTaskInfo](capi-transienttask-transienttask-transienttaskinfo.md)。 | 132 133**返回：** 134 135| 类型 | 说明 | 136| -- | -- | 137| int32_t | 返回0，表示获取成功。<br> 返回9900001，表示短时任务客户端信息校验失败。<br> 返回9900003，表示Parcel读写操作失败。<br> 返回9900004，表示系统服务失败。<br> 错误码的具体信息请参考[TransientTask_ErrorCode](capi-transient-task-type-h.md#transienttask_errorcode)。 | 138 139 140