From 58e86c0686173dd36932fddf5b8bcb1279564ea7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=B1=E5=A4=A9=E6=80=A1?= Date: Fri, 25 Aug 2023 03:29:35 +0000 Subject: [PATCH] =?UTF-8?q?=E5=91=8A=E8=AD=A6=E4=BF=AE=E5=A4=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 朱天怡 --- .../js-apis-WorkSchedulerExtensionAbility.md | 7 +- .../apis/js-apis-backgroundTaskManager.md | 252 +++++++++--------- ...plication-WorkSchedulerExtensionContext.md | 3 +- 3 files changed, 136 insertions(+), 126 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md index b7fff65f53..337f7f8bfb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md @@ -11,7 +11,8 @@ ## 导入模块 ```ts -import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility' +import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; +import workScheduler from '@ohos.resourceschedule.workScheduler'; ``` ## 属性 @@ -40,7 +41,7 @@ onWorkStart(work: workScheduler.WorkInfo): void ```ts export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { - onWorkStart(workInfo) { + onWorkStart(workInfo: workScheduler.WorkInfo) { console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo)); } } @@ -65,7 +66,7 @@ onWorkStop(work: workScheduler.WorkInfo): void ```ts export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { - onWorkStop(workInfo) { + onWorkStop(workInfo: workScheduler.WorkInfo) { console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo)); } } diff --git a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md index ca460869b6..25fb62f880 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md @@ -115,14 +115,14 @@ getRemainingDelayTime(requestId: number): Promise<number> **示例**： - ```js - let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {}); - backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId).then( res => { - console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res)); - }).catch( err => { - console.log('promise => Operation getRemainingDelayTime failed. Cause: ' + err.code); - }) - ``` +```js +let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {}); +backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId).then((res:number) => { +console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res)); +}).catch((err : BusinessError) => { +console.log('promise => Operation getRemainingDelayTime failed. Cause: ' + err.code); +}) +``` ## backgroundTaskManager.cancelSuspendDelay @@ -173,31 +173,32 @@ FA模型示例： ```js import backgroundTaskManager from '@ohos.backgroundTaskManager'; import featureAbility from '@ohos.ability.featureAbility'; -import wantAgent from '@ohos.app.ability.wantAgent'; - -function callback(err, data) { - if (err) { - console.error("Operation startBackgroundRunning failed Cause: " + err); - } else { - console.info("Operation startBackgroundRunning succeeded"); - } +import wantAgent, { WantAgent } from '@ohos.app.ability.wantAgent'; +import { BusinessError } from '@ohos.base'; + +function callback(err: BusinessError, data: void) { + if (err) { + console.error("Operation startBackgroundRunning failed Cause: " + err); + } else { + console.info("Operation startBackgroundRunning succeeded"); + } } -let wantAgentInfo = { - wants: [ - { - bundleName: "com.example.myapplication", - abilityName: "EntryAbility" - } - ], - operationType: wantAgent.OperationType.START_ABILITY, - requestCode: 0, - wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] +let wantAgentInfo : wantAgent.WantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "EntryAbility" + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] }; -wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(), - backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback) +wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => { + backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(), + backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback) }); ``` @@ -207,35 +208,36 @@ Stage模型示例： ```ts import UIAbility from '@ohos.app.ability.UIAbility'; import backgroundTaskManager from '@ohos.backgroundTaskManager'; -import wantAgent from '@ohos.app.ability.wantAgent'; - -function callback(err, data) { - if (err) { - console.error("Operation startBackgroundRunning failed Cause: " + err); - } else { - console.info("Operation startBackgroundRunning succeeded"); - } +import wantAgent, { WantAgent } from '@ohos.app.ability.wantAgent'; +import { BusinessError } from '@ohos.base'; + +function callback(err: BusinessError, data: void) { + if (err) { + console.error("Operation startBackgroundRunning failed Cause: " + err); + } 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] - }; - - wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - backgroundTaskManager.startBackgroundRunning(this.context, - backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback) - }); - } + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { + let wantAgentInfo : wantAgent.WantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "EntryAbility" + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] + }; + + wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => { + backgroundTaskManager.startBackgroundRunning(this.context, + backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback) + }); + } }; ``` @@ -270,27 +272,28 @@ FA模型示例： ```js import backgroundTaskManager from '@ohos.backgroundTaskManager'; import featureAbility from '@ohos.ability.featureAbility'; -import wantAgent from '@ohos.app.ability.wantAgent'; - -let wantAgentInfo = { - wants: [ - { - bundleName: "com.example.myapplication", - abilityName: "EntryAbility" - } - ], - operationType: wantAgent.OperationType.START_ABILITY, - requestCode: 0, - wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] +import wantAgent, { WantAgent } from '@ohos.app.ability.wantAgent'; +import { BusinessError } from '@ohos.base'; + +let wantAgentInfo : wantAgent.WantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "EntryAbility" + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] }; -wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(), - backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => { - console.info("Operation startBackgroundRunning succeeded"); - }).catch((err) => { - console.error("Operation startBackgroundRunning failed Cause: " + err); - }); +wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => { + backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(), + backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => { + console.info("Operation startBackgroundRunning succeeded"); + }).catch((err: BusinessError) => { + console.error("Operation startBackgroundRunning failed Cause: " + err); + }); }); ``` @@ -299,31 +302,32 @@ Stage模型示例： ```ts import UIAbility from '@ohos.app.ability.UIAbility'; import backgroundTaskManager from '@ohos.backgroundTaskManager'; -import wantAgent from '@ohos.app.ability.wantAgent'; +import wantAgent, { WantAgent } from '@ohos.app.ability.wantAgent'; +import { BusinessError } from '@ohos.base'; 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] - }; - - wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - backgroundTaskManager.startBackgroundRunning(this.context, - backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => { - console.info("Operation startBackgroundRunning succeeded"); - }).catch((err) => { - console.error("Operation startBackgroundRunning failed Cause: " + err); - }); - }); - } + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { + let wantAgentInfo : wantAgent.WantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "EntryAbility" + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] + }; + + wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj : WantAgent) => { + backgroundTaskManager.startBackgroundRunning(this.context, + backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => { + console.info("Operation startBackgroundRunning succeeded"); + }).catch((err: BusinessError) => { + console.error("Operation startBackgroundRunning failed Cause: " + err); + }); + }); + } }; ``` @@ -349,13 +353,14 @@ FA模型示例： ```js import backgroundTaskManager from '@ohos.backgroundTaskManager'; import featureAbility from '@ohos.ability.featureAbility'; +import { BusinessError } from '@ohos.base'; -function callback(err, data) { - if (err) { - console.error("Operation stopBackgroundRunning failed Cause: " + err); - } else { - console.info("Operation stopBackgroundRunning succeeded"); - } +function callback(err: BusinessError, data: void) { + if (err) { + console.error("Operation stopBackgroundRunning failed Cause: " + err); + } else { + console.info("Operation stopBackgroundRunning succeeded"); + } } backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext(), callback); @@ -367,19 +372,20 @@ Stage模型示例： ```ts import UIAbility from '@ohos.app.ability.UIAbility'; import backgroundTaskManager from '@ohos.backgroundTaskManager'; +import { BusinessError } from '@ohos.base'; -function callback(err, data) { - if (err) { - console.error("Operation stopBackgroundRunning failed Cause: " + err); - } else { - console.info("Operation stopBackgroundRunning succeeded"); - } +function callback(err: BusinessError, data: void) { + if (err) { + console.error("Operation stopBackgroundRunning failed Cause: " + err); + } else { + console.info("Operation stopBackgroundRunning succeeded"); + } } export default class EntryAbility extends UIAbility { - onCreate(want, launchParam) { - backgroundTaskManager.stopBackgroundRunning(this.context, callback); - } + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { + backgroundTaskManager.stopBackgroundRunning(this.context, callback); + } }; ``` @@ -410,11 +416,12 @@ FA模型示例： ```js import backgroundTaskManager from '@ohos.backgroundTaskManager'; import featureAbility from '@ohos.ability.featureAbility'; +import { BusinessError } from '@ohos.base'; backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() => { - console.info("Operation stopBackgroundRunning succeeded"); -}).catch((err) => { - console.error("Operation stopBackgroundRunning failed Cause: " + err); + console.info("Operation stopBackgroundRunning succeeded"); +}).catch((err: BusinessError) => { + console.error("Operation stopBackgroundRunning failed Cause: " + err); }); ``` @@ -424,15 +431,16 @@ Stage模型示例： ```ts import UIAbility from '@ohos.app.ability.UIAbility'; import backgroundTaskManager from '@ohos.backgroundTaskManager'; +import { BusinessError } from '@ohos.base'; export default class EntryAbility extends UIAbility { - onCreate(want, launchParam) { - backgroundTaskManager.stopBackgroundRunning(this.context).then(() => { - console.info("Operation stopBackgroundRunning succeeded"); - }).catch((err) => { - console.error("Operation stopBackgroundRunning failed Cause: " + err); - }); - } + onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { + backgroundTaskManager.stopBackgroundRunning(this.context).then(() => { + console.info("Operation stopBackgroundRunning succeeded"); + }).catch((err: BusinessError) => { + console.error("Operation stopBackgroundRunning failed Cause: " + err); + }); + } }; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-WorkSchedulerExtensionContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-WorkSchedulerExtensionContext.md index 0054d61a95..43ee71cf26 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-WorkSchedulerExtensionContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-WorkSchedulerExtensionContext.md @@ -15,9 +15,10 @@ WorkSchedulerExtensionContext可直接作为WorkSchedulerExtension的上下文 ```ts import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; +import workScheduler from '@ohos.resourceschedule.workScheduler'; class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { - onWorkStart(workInfo) { + onWorkStart(workInfo: workScheduler.WorkInfo) { let WorkSchedulerExtensionContext = this.context; // 获取WorkSchedulerExtensionContext } } -- GitLab