未验证 提交 a42e2844 编写于 作者: O openharmony_ci 提交者: Gitee

!10631 全局资源调度子系统api参考整改

Merge pull request !10631 from 张鑫/master
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
应用中存在用户能够直观感受到的且需要一直在后台运行的业务时(如,后台播放音乐),可以使用长时任务机制。 应用中存在用户能够直观感受到的且需要一直在后台运行的业务时(如,后台播放音乐),可以使用长时任务机制。
对于系统特权应用,提供独立的能效资源申请接口。系统特权应用如果需要使用特定的系统资源,例如在被挂起期间仍然能够收到系统公共事件,可以使用能效资源申请接口。 对于系统特权应用,提供独立的能效资源申请接口。系统特权应用如果需要使用特定的系统资源,例如需要在被挂起期间仍然能够收到系统公共事件,可以使用能效资源申请接口。
> **说明:** > **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...@@ -27,7 +27,7 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen ...@@ -27,7 +27,7 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen
后台应用申请延迟挂起。 后台应用申请延迟挂起。
延迟挂起时间一般情况下默认值为180000,低电量(依据系统低电量广播)时默认值为60000 延迟挂起时间一般情况下默认值为180000毫秒,低电量(依据系统低电量广播)时默认值为60000毫秒
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
...@@ -49,9 +49,9 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen ...@@ -49,9 +49,9 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen
let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => { let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => {
console.info("Request suspension delay will time out."); console.info("Request suspension delay will time out.");
}) })
var id = delayInfo.requestId; let id = delayInfo.requestId;
var time = delayInfo.actualDelayTime; let time = delayInfo.actualDelayTime;
console.info("The requestId is: " + id); console.info("The requestId is: " + id);
console.info("The actualDelayTime is: " + time); console.info("The actualDelayTime is: " + time);
``` ```
...@@ -68,14 +68,14 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): ...@@ -68,14 +68,14 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>):
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------- | ---- | ---------------------------------------- | | --------- | --------------------------- | ---- | ---------------------------------------- |
| requestId | number | 是 | 延迟挂起的请求ID。 | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
| callback | AsyncCallback<number> | 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 | | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间,以毫秒为单位。 |
**示例** **示例**
```js ```js
let id = 1; let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
backgroundTaskManager.getRemainingDelayTime(id, (err, res) => { backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId, (err, res) => {
if(err) { if(err) {
console.log('callback => Operation getRemainingDelayTime failed. Cause: ' + err.code); console.log('callback => Operation getRemainingDelayTime failed. Cause: ' + err.code);
} else { } else {
...@@ -96,7 +96,7 @@ getRemainingDelayTime(requestId: number): Promise<number> ...@@ -96,7 +96,7 @@ getRemainingDelayTime(requestId: number): Promise<number>
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。 | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -105,8 +105,8 @@ getRemainingDelayTime(requestId: number): Promise<number> ...@@ -105,8 +105,8 @@ getRemainingDelayTime(requestId: number): Promise<number>
**示例** **示例**
```js ```js
let id = 1; let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
backgroundTaskManager.getRemainingDelayTime(id).then( res => { backgroundTaskManager.getRemainingDelayTime(delayInfo.requestId).then( res => {
console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res)); console.log('promise => Operation getRemainingDelayTime succeeded. Data: ' + JSON.stringify(res));
}).catch( err => { }).catch( err => {
console.log('promise => Operation getRemainingDelayTime failed. Cause: ' + err.code); console.log('promise => Operation getRemainingDelayTime failed. Cause: ' + err.code);
...@@ -125,12 +125,12 @@ cancelSuspendDelay(requestId: number): void ...@@ -125,12 +125,12 @@ cancelSuspendDelay(requestId: number): void
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- | | --------- | ------ | ---- | ---------- |
| requestId | number | 是 | 延迟挂起的请求ID。 | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 |
**示例** **示例**
```js ```js
let id = 1; let delayInfo = backgroundTaskManager.requestSuspendDelay("test", () => {});
backgroundTaskManager.cancelSuspendDelay(id); backgroundTaskManager.cancelSuspendDelay(delayInfo.requestId);
``` ```
...@@ -153,6 +153,9 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -153,6 +153,9 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
| callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 |
**示例** **示例**
FA模型示例:
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -180,11 +183,48 @@ let wantAgentInfo = { ...@@ -180,11 +183,48 @@ let wantAgentInfo = {
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(), backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(),
backgroundTaskManager.BackgroundMode.DATA_TRANSFER, wantAgentObj, callback) backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback)
}); });
``` ```
Stage模型示例:
```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent';
function callback(err, data) {
if (err) {
console.error("Operation startBackgroundRunning failed Cause: " + err);
} else {
console.info("Operation startBackgroundRunning succeeded");
}
}
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
let wantAgentInfo = {
wants: [
{
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility"
}
],
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)
});
}
};
```
## backgroundTaskManager.startBackgroundRunning<sup>8+</sup> ## backgroundTaskManager.startBackgroundRunning<sup>8+</sup>
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt; startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise&lt;void&gt;
...@@ -209,6 +249,9 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -209,6 +249,9 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例** **示例**
FA模型示例:
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -228,13 +271,45 @@ let wantAgentInfo = { ...@@ -228,13 +271,45 @@ let wantAgentInfo = {
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(), backgroundTaskManager.startBackgroundRunning(featureAbility.getContext(),
backgroundTaskManager.BackgroundMode.DATA_TRANSFER, wantAgentObj).then(() => { backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => {
console.info("Operation startBackgroundRunning succeeded"); console.info("Operation startBackgroundRunning succeeded");
}).catch((err) => { }).catch((err) => {
console.error("Operation startBackgroundRunning failed Cause: " + err); console.error("Operation startBackgroundRunning failed Cause: " + err);
}); });
}); });
```
Stage模型示例:
```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent';
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
let wantAgentInfo = {
wants: [
{
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility"
}
],
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);
});
});
}
};
``` ```
## backgroundTaskManager.stopBackgroundRunning<sup>8+</sup> ## backgroundTaskManager.stopBackgroundRunning<sup>8+</sup>
...@@ -252,6 +327,9 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo ...@@ -252,6 +327,9 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 |
**示例** **示例**
FA模型示例:
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -268,6 +346,27 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext(), callbac ...@@ -268,6 +346,27 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext(), callbac
``` ```
Stage模型示例:
```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';
function callback(err, data) {
if (err) {
console.error("Operation stopBackgroundRunning failed Cause: " + err);
} else {
console.info("Operation stopBackgroundRunning succeeded");
}
}
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
backgroundTaskManager.stopBackgroundRunning(this.context, callback);
}
};
```
## backgroundTaskManager.stopBackgroundRunning<sup>8+</sup> ## backgroundTaskManager.stopBackgroundRunning<sup>8+</sup>
stopBackgroundRunning(context: Context): Promise&lt;void&gt; stopBackgroundRunning(context: Context): Promise&lt;void&gt;
...@@ -287,6 +386,9 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt; ...@@ -287,6 +386,9 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt;
| Promise\<void> | 使用Promise形式返回结果。 | | Promise\<void> | 使用Promise形式返回结果。 |
**示例** **示例**
FA模型示例:
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -299,11 +401,30 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() ...@@ -299,11 +401,30 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
``` ```
Stage模型示例:
```ts
import Ability from '@ohos.application.Ability'
import backgroundTaskManager from '@ohos.backgroundTaskManager';
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
backgroundTaskManager.stopBackgroundRunning(this.context).then(() => {
console.info("Operation stopBackgroundRunning succeeded");
}).catch((err) => {
console.error("Operation stopBackgroundRunning failed Cause: " + err);
});
}
};
```
## backgroundTaskManager.applyEfficiencyResources<sup>9+</sup> ## backgroundTaskManager.applyEfficiencyResources<sup>9+</sup>
applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest9)): boolean applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest9)): boolean
向系统申请能效资源,使用boolean形式返回结果。 向系统申请或释放能效资源,使用boolean形式返回结果。
通过EfficiencyResourcesRequest参数中的isApply变量,设置是申请还是释放。
应用使用此接口,需要向应用中心申请获得相应特权。
进程和它所属的应用可以同时申请某一类资源,例如CPU资源,但是应用释放资源的时候会将进程的资源一起释放。 进程和它所属的应用可以同时申请某一类资源,例如CPU资源,但是应用释放资源的时候会将进程的资源一起释放。
**系统能力**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply **系统能力**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
...@@ -328,6 +449,7 @@ import backgroundTaskManager from '@ohos.backgroundTaskManager'; ...@@ -328,6 +449,7 @@ import backgroundTaskManager from '@ohos.backgroundTaskManager';
let request = { let request = {
resourceTypes: backgroundTaskManager.ResourceType.CPU, resourceTypes: backgroundTaskManager.ResourceType.CPU,
// 如果将isApply置为false,则表示释放资源
isApply: true, isApply: true,
timeOut: 0, timeOut: 0,
reason: "apply", reason: "apply",
...@@ -343,6 +465,7 @@ console.info("result of applyEfficiencyResources is: " + res) ...@@ -343,6 +465,7 @@ console.info("result of applyEfficiencyResources is: " + res)
resetAllEfficiencyResources(): void resetAllEfficiencyResources(): void
释放所有已经申请的资源。 释放所有已经申请的资源。
应用使用此接口,需要向应用中心申请获得相应特权。
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
...@@ -353,7 +476,7 @@ resetAllEfficiencyResources(): void ...@@ -353,7 +476,7 @@ resetAllEfficiencyResources(): void
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
backgroundTaskManager.backgroundTaskManager.resetAllEfficiencyResources(); backgroundTaskManager.resetAllEfficiencyResources();
``` ```
......
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
## 导入模块 ## 导入模块
``` ```js
import bundleState from '@ohos.bundleState' import bundleState from '@ohos.bundleState'
``` ```
...@@ -31,7 +31,7 @@ import bundleState from '@ohos.bundleState' ...@@ -31,7 +31,7 @@ import bundleState from '@ohos.bundleState'
isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
判断指定bundleName的应用当前是否是空闲状态,三方应用只能查询自身的空闲状态,使用Callback形式返回。 判断指定bundleName的应用当前是否是空闲状态,三方应用只能查询自身的空闲状态,查询其他应用空闲状态,需要申请权限ohos.permission.BUNDLE_ACTIVE_INFO,使用Callback形式返回。
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup **系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
...@@ -44,7 +44,7 @@ isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -44,7 +44,7 @@ isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
**示例** **示例**
``` ```js
bundleState.isIdleState("com.ohos.camera", (err, res) => { bundleState.isIdleState("com.ohos.camera", (err, res) => {
if (err) { if (err) {
console.log('BUNDLE_ACTIVE isIdleState callback failed, because: ' + err.code); console.log('BUNDLE_ACTIVE isIdleState callback failed, because: ' + err.code);
...@@ -58,7 +58,7 @@ isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -58,7 +58,7 @@ isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
isIdleState(bundleName: string): Promise&lt;boolean&gt; isIdleState(bundleName: string): Promise&lt;boolean&gt;
判断指定bundleName的应用当前是否是空闲状态,三方应用只能查询自身的空闲状态,使用Promise形式返回。 判断指定bundleName的应用当前是否是空闲状态,三方应用只能查询自身的空闲状态,查询其他应用空闲状态,需要申请权限ohos.permission.BUNDLE_ACTIVE_INFO,使用Promise形式返回。
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup **系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
...@@ -88,7 +88,7 @@ isIdleState(bundleName: string): Promise&lt;boolean&gt; ...@@ -88,7 +88,7 @@ isIdleState(bundleName: string): Promise&lt;boolean&gt;
queryAppUsagePriorityGroup(): Promise&lt;number&gt; queryAppUsagePriorityGroup(): Promise&lt;number&gt;
查询当前应用的优先级分组。使用Promise形式返回其应用分组。 查询当前应用的优先级分组。使用Promise形式返回其应用分组,分组信息参考[GroupType](#grouptype)
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup **系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
...@@ -112,7 +112,7 @@ bundleState.queryAppUsagePriorityGroup().then( res => { ...@@ -112,7 +112,7 @@ bundleState.queryAppUsagePriorityGroup().then( res => {
queryAppUsagePriorityGroup(callback: AsyncCallback&lt;number&gt;): void queryAppUsagePriorityGroup(callback: AsyncCallback&lt;number&gt;): void
查询当前应用的优先级分组。使用callback形式返回其应用分组。 查询当前应用的优先级分组。使用callback形式返回其应用分组,分组信息参考[GroupType](#grouptype)
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup **系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
...@@ -150,8 +150,8 @@ queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback&lt;Bun ...@@ -150,8 +150,8 @@ queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback&lt;Bun
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
| callback | AsyncCallback&lt;[BundleActiveInfoResponse](#bundleactiveinforesponse)&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。 | | callback | AsyncCallback&lt;[BundleActiveInfoResponse](#bundleactiveinforesponse)&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。 |
**示例** **示例**
...@@ -188,8 +188,8 @@ queryBundleStateInfos(begin: number, end: number): Promise&lt;BundleActiveInfoRe ...@@ -188,8 +188,8 @@ queryBundleStateInfos(begin: number, end: number): Promise&lt;BundleActiveInfoRe
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ----- | ------ | ---- | ----- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
**返回值** **返回值**
...@@ -230,14 +230,14 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num ...@@ -230,14 +230,14 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------- | ---- | ---------------------------------------- | | ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。 | | byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。 |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
| callback | AsyncCallback&lt;Array&lt;[BundleStateInfo](#bundlestateinfo)&gt;&gt; | 是 | 指定的callback回调方法。返回指定时间段间隔(天、周、月、年)查询应用使用时长统计信息。 | | callback | AsyncCallback&lt;Array&lt;[BundleStateInfo](#bundlestateinfo)&gt;&gt; | 是 | 指定的callback回调方法。返回指定时间段间隔(天、周、月、年)查询应用使用时长统计信息。 |
**示例** **示例**
```js ```js
bundleState.queryBundleStateInfoByInterval(0, 0, 20000000000000, (err, res) => { bundleState.queryBundleStateInfoByInterval(bundleState.IntervalType.BY_OPTIMIZED, 0, 20000000000000, (err, res) => {
if (err) { if (err) {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval callback failed, because: ' + err.code); console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval callback failed, because: ' + err.code);
} else { } else {
...@@ -267,8 +267,8 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num ...@@ -267,8 +267,8 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------- | ---- | ----- | | ---------- | ----------------------------- | ---- | ----- |
| byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。 | | byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。 |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
**返回值** **返回值**
...@@ -279,7 +279,7 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num ...@@ -279,7 +279,7 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num
**示例** **示例**
```js ```js
bundleState.queryBundleStateInfoByInterval(0, 0, 20000000000000).then( res => { bundleState.queryBundleStateInfoByInterval(bundleState.IntervalType.BY_OPTIMIZED, 0, 20000000000000).then( res => {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise success.'); console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise success.');
for (let i = 0; i < res.length; i++) { for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise number : ' + (i + 1)); console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise number : ' + (i + 1));
...@@ -306,8 +306,8 @@ queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;A ...@@ -306,8 +306,8 @@ queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;A
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
| callback | AsyncCallback&lt;Array&lt;[BundleActiveState](#bundleactivestate)&gt;&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。 | | callback | AsyncCallback&lt;Array&lt;[BundleActiveState](#bundleactivestate)&gt;&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。 |
**示例** **示例**
...@@ -342,8 +342,8 @@ queryBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleA ...@@ -342,8 +342,8 @@ queryBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleA
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ----- | ------ | ---- | ----- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
**返回值** **返回值**
...@@ -377,8 +377,8 @@ queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallba ...@@ -377,8 +377,8 @@ queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallba
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------------------------------------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
| callback | AsyncCallback&lt;Array&lt;[BundleActiveState](#bundleactivestate)&gt;&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。 | | callback | AsyncCallback&lt;Array&lt;[BundleActiveState](#bundleactivestate)&gt;&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。 |
**示例** **示例**
...@@ -409,8 +409,8 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt; ...@@ -409,8 +409,8 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ----- | ------ | ---- | ----- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
**返回值** **返回值**
...@@ -884,8 +884,8 @@ queryBundleActiveEventStates(begin: number, end: number): Promise&lt;Array&lt;Bu ...@@ -884,8 +884,8 @@ queryBundleActiveEventStates(begin: number, end: number): Promise&lt;Array&lt;Bu
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ----- | ------ | ---- | ----- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
**返回值** **返回值**
...@@ -920,8 +920,8 @@ queryBundleActiveEventStates(begin: number, end: number, callback: AsyncCallback ...@@ -920,8 +920,8 @@ queryBundleActiveEventStates(begin: number, end: number, callback: AsyncCallback
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
| callback | AsyncCallback&lt;Array&lt;[BundleActiveEventState](#bundleactiveeventstate9)&gt;&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间查询系统事件(休眠、唤醒、解锁、锁屏)统计信息。 | | callback | AsyncCallback&lt;Array&lt;[BundleActiveEventState](#bundleactiveeventstate9)&gt;&gt; | 是 | 指定的callback回调方法。返回指定起始和结束时间查询系统事件(休眠、唤醒、解锁、锁屏)统计信息。 |
**示例** **示例**
...@@ -953,8 +953,8 @@ queryAppNotificationNumber(begin: number, end: number): Promise&lt;Array&lt;Bund ...@@ -953,8 +953,8 @@ queryAppNotificationNumber(begin: number, end: number): Promise&lt;Array&lt;Bund
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ----- | ------ | ---- | ----- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
**返回值** **返回值**
...@@ -989,8 +989,8 @@ queryAppNotificationNumber(begin: number, end: number, callback: AsyncCallback&l ...@@ -989,8 +989,8 @@ queryAppNotificationNumber(begin: number, end: number, callback: AsyncCallback&l
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| begin | number | 是 | 起始时间。 | | begin | number | 是 | 起始时间,单位毫秒。 |
| end | number | 是 | 结束时间。 | | end | number | 是 | 结束时间,单位毫秒。 |
| callback | AsyncCallback&lt;Array&lt;[BundleActiveEventState](#bundleactiveeventstate9)&gt;&gt; | 是 | 指定的callback回调方法。返回通过指定起始和结束时间查询所有应用的通知次数信息。 | | callback | AsyncCallback&lt;Array&lt;[BundleActiveEventState](#bundleactiveeventstate9)&gt;&gt; | 是 | 指定的callback回调方法。返回通过指定起始和结束时间查询所有应用的通知次数信息。 |
**示例** **示例**
......
...@@ -203,7 +203,7 @@ startBackgroundRunning(id: number, request: NotificationRequest, callback: Async ...@@ -203,7 +203,7 @@ startBackgroundRunning(id: number, request: NotificationRequest, callback: Async
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| id | number | 是 | 长时任务通知id号 | | id | number | 是 | 长时任务通知id号 |
| request | NotificationRequest | 是 | 通知参数,用于显示通知栏的信息 | | request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数,用于显示通知栏的信息 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
**示例** **示例**
...@@ -215,7 +215,7 @@ import wantAgent from '@ohos.wantAgent'; ...@@ -215,7 +215,7 @@ import wantAgent from '@ohos.wantAgent';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
console.error("Operation failed Cause: " + err); console.error("Operation failed cause: " + JSON.stringify(err));
} else { } else {
console.info("Operation succeeded"); console.info("Operation succeeded");
} }
...@@ -267,7 +267,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;voi ...@@ -267,7 +267,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;voi
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| id | number | 是 | 长时任务通知id号 | | id | number | 是 | 长时任务通知id号 |
| request | NotificationRequest | 是 | 通知参数,用于显示通知栏的信息 | | request | [NotificationRequest](js-apis-notification.md#notificationrequest) | 是 | 通知参数,用于显示通知栏的信息 |
**返回值:** **返回值:**
...@@ -311,7 +311,7 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { ...@@ -311,7 +311,7 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
particleAbility.startBackgroundRunning(id, request).then(() => { particleAbility.startBackgroundRunning(id, request).then(() => {
console.info("Operation succeeded"); console.info("Operation succeeded");
}).catch((err) => { }).catch((err) => {
console.error("Operation failed Cause: " + err); console.error("Operation failed cause: " + JSON.stringify(err));
}); });
}); });
...@@ -338,7 +338,7 @@ import particleAbility from '@ohos.ability.particleAbility'; ...@@ -338,7 +338,7 @@ import particleAbility from '@ohos.ability.particleAbility';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
console.error("Operation failed Cause: " + err); console.error("Operation failed cause: " + JSON.stringify(err));
} else { } else {
console.info("Operation succeeded"); console.info("Operation succeeded");
} }
...@@ -370,7 +370,7 @@ import particleAbility from '@ohos.ability.particleAbility'; ...@@ -370,7 +370,7 @@ import particleAbility from '@ohos.ability.particleAbility';
particleAbility.cancelBackgroundRunning().then(() => { particleAbility.cancelBackgroundRunning().then(() => {
console.info("Operation succeeded"); console.info("Operation succeeded");
}).catch((err) => { }).catch((err) => {
console.error("Operation failed Cause: " + err); console.error("Operation failed cause: " + JSON.stringify(err));
}); });
``` ```
......
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
## 导入模块 ## 导入模块
``` ```js
import reminderAgent from'@ohos.reminderAgent'; import reminderAgent from'@ohos.reminderAgent';
``` ```
...@@ -88,7 +88,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -88,7 +88,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reminderId | number | 是 | 目标reminder的id号。 | | reminderId | number | 是 | 目标reminder的id号[publishReminder](#reminderagentpublishreminder)方法调用成功后获得。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
**示例** **示例**
...@@ -112,7 +112,7 @@ cancelReminder(reminderId: number): Promise&lt;void&gt; ...@@ -112,7 +112,7 @@ cancelReminder(reminderId: number): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reminderId | number | 是 | 目标reminder的id号。 | | reminderId | number | 是 | 目标reminder的id号[publishReminder](#reminderagentpublishreminder)方法调用成功后获得。 |
**返回值** **返回值**
...@@ -452,10 +452,10 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). ...@@ -452,10 +452,10 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reminderType | ReminderType | 是 | 指明提醒类型。 | | reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 |
| actionButton | [ActionButton?,&nbsp;ActionButton?] | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 | | actionButton | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 |
| wantAgent | WantAgent | 否 | 点击通知后需要跳转的目标ability信息。 | | wantAgent | [WantAgent](#wantagent) | 否 | 点击通知后需要跳转的目标ability信息。 |
| maxScreenWantAgent | MaxScreenWantAgent | 否 | 提醒到达时跳转的目标包。如果设备正在使用中,则弹出一个通知框。 | | maxScreenWantAgent | [MaxScreenWantAgent](#maxscreenwantagent) | 否 | 提醒到达时跳转的目标包。如果设备正在使用中,则弹出一个通知框。 |
| ringDuration | number | 否 | 指明响铃时长。 | | ringDuration | number | 否 | 指明响铃时长。 |
| snoozeTimes | number | 否 | 指明延迟提醒次数。 | | snoozeTimes | number | 否 | 指明延迟提醒次数。 |
| timeInterval | number | 否 | 执行延迟提醒间隔。 | | timeInterval | number | 否 | 执行延迟提醒间隔。 |
......
...@@ -53,7 +53,7 @@ startWork(work: WorkInfo): boolean ...@@ -53,7 +53,7 @@ startWork(work: WorkInfo): boolean
mykey3: 1.5 mykey3: 1.5
} }
} }
var res = workScheduler.startWork(workInfo); let res = workScheduler.startWork(workInfo);
console.info(`workschedulerLog res: ${res}`); console.info(`workschedulerLog res: ${res}`);
``` ```
...@@ -94,7 +94,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean ...@@ -94,7 +94,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
mykey3: 1.5 mykey3: 1.5
} }
} }
var res = workScheduler.stopWork(workInfo, false); let res = workScheduler.stopWork(workInfo, false);
console.info(`workschedulerLog res: ${res}`); console.info(`workschedulerLog res: ${res}`);
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册