后臺任務(wù)管理

導(dǎo)入模塊

import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

backgroundTaskManager.requestSuspendDelay

requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspendInfo

后臺應(yīng)用申請延遲掛起。

延遲掛起時間一般情況下默認(rèn)值為3分鐘，低電量（依據(jù)系統(tǒng)低電量廣播）時默認(rèn)值為1分鐘。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

let myReason = 'test requestSuspendDelay';
try {
  let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => {
      console.info("Request suspension delay will time out.");
  })
  var id = delayInfo.requestId;
  var time = delayInfo.actualDelayTime;
  console.info("The requestId is: " + id);
  console.info("The actualDelayTime is: " + time);
} catch (error) {
  console.error(`requestSuspendDelay failed. code is ${error.code} message is ${error.message}`);
}

backgroundTaskManager.getRemainingDelayTime

getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): void

獲取應(yīng)用程序進(jìn)入掛起狀態(tài)前的剩余時間，使用callback形式返回。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

let id = 1;
try {
  backgroundTaskManager.getRemainingDelayTime(id, (error, res) => {
      if(error) {
          console.error(`callback => Operation getRemainingDelayTime failed. code is ${error.code} message is ${error.message}`);
      } else {
          console.log('callback => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));
      }
  })
} catch (error) {
  console.error(`callback => Operation getRemainingDelayTime failed. code is ${error.code} message is ${error.message}`);
}

backgroundTaskManager.getRemainingDelayTime

getRemainingDelayTime(requestId: number): Promise<number>

獲取應(yīng)用程序進(jìn)入掛起狀態(tài)前的剩余時間，使用Promise形式返回。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

let id = 1;
try {
  backgroundTaskManager.getRemainingDelayTime(id).then( res => {
      console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));
  }).catch( error => {
      console.error(`promise => Operation getRemainingDelayTime failed. code is ${error.code} message is ${error.message}`);
  })
} catch (error) {
  console.error(`promise => Operation getRemainingDelayTime failed. code is ${error.code} message is ${error.message}`);
}

backgroundTaskManager.cancelSuspendDelay

cancelSuspendDelay(requestId: number): void

取消延遲掛起。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

let id = 1;
try {
  backgroundTaskManager.cancelSuspendDelay(id);
} catch (error) {
  console.error(`cancelSuspendDelay failed. code is ${error.code} message is ${error.message}`);
}

backgroundTaskManager.startBackgroundRunning

startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback<void>): void

向系統(tǒng)申請長時任務(wù)，使用callback形式返回結(jié)果。

需要權(quán)限: ohos.permission.KEEP_BACKGROUND_RUNNING

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  
import wantAgent from '@ohos.app.ability.wantAgent';

function callback(error, data) {
    if (error) {
        console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
    } else {
        console.info("Operation startBackgroundRunning succeeded");
    }
}

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        let wantAgentInfo = {
            wants: [
                {
                    bundleName: "com.example.myapplication",
                    abilityName: "EntryAbility"
                }
            ],
            operationType: wantAgent.OperationType.START_ABILITY,
            requestCode: 0,
            wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
        };

        try {
            wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
                try {
                    backgroundTaskManager.startBackgroundRunning(this.context,
                        backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback)
                } catch (error) {
                    console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
                }
            });
        } catch (error) {
            console.error(`Operation getWantAgent failed. code is ${error.code} message is ${error.message}`);
        }
    }
};

backgroundTaskManager.startBackgroundRunning

startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise<void>

向系統(tǒng)申請長時任務(wù)，使用promise形式返回結(jié)果。

需要權(quán)限: ohos.permission.KEEP_BACKGROUND_RUNNING

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; 
import wantAgent from '@ohos.app.ability.wantAgent';

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        let wantAgentInfo = {
            wants: [
                {
                    bundleName: "com.example.myapplication",
                    abilityName: "EntryAbility"
                }
            ],
            operationType: wantAgent.OperationType.START_ABILITY,
            requestCode: 0,
            wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
        };

        try {
            wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
                try {
                    backgroundTaskManager.startBackgroundRunning(this.context,
                        backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => {
                        console.info("Operation startBackgroundRunning succeeded");
                    }).catch((error) => {
                        console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
                    });
                } catch (error) {
                    console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
                }
            });
        } catch (error) {
            console.error(`Operation getWantAgent failed. code is ${error.code} message is ${error.message}`);
        }
    }
};

backgroundTaskManager.stopBackgroundRunning

stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): void

向系統(tǒng)申請取消長時任務(wù)，使用callback形式返回結(jié)果。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

function callback(error, data) {
    if (error) {
        console.error(`Operation stopBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
    } else {
        console.info("Operation stopBackgroundRunning succeeded");
    }
}

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        try {
            backgroundTaskManager.stopBackgroundRunning(this.context, callback);
        } catch (error) {
            console.error(`Operation stopBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
        }
    }
};

backgroundTaskManager.stopBackgroundRunning

stopBackgroundRunning(context: Context): Promise<void>

向系統(tǒng)申請取消長時任務(wù)，使用promise形式返回結(jié)果。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見@ohos.resourceschedule.backgroundTaskManager (后臺任務(wù)管理)錯誤碼。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';  

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        try {
            backgroundTaskManager.stopBackgroundRunning(this.context).then(() => {
                console.info("Operation stopBackgroundRunning succeeded");
            }).catch((error) => {
                console.error(`Operation stopBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
            });
        } catch (error) {
            console.error(`Operation stopBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
        }
    }
};

DelaySuspendInfo

延遲掛起信息。

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask

BackgroundMode

系統(tǒng)能力: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask