diff --git a/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md b/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md index f1925f41fd765aaef0b5c580f337c18bbac059aa..7cf87789f9e463123908f37143049c0e9458347b 100644 --- a/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md +++ b/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md @@ -21,6 +21,7 @@ import stats from '@ohos.bundleState'; | function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStateInfo>>): void | 通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。 | | function queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void | 查询（返回）当前调用者应用的使用优先级群组。 | | function isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void | 判断指定Bundle Name的应用当前是否是空闲状态。 | +| function getModuleUsageRecord(maxNum: number, callback: AsyncCallback<BundleActiveModuleInfo>): void | 根据maxNum，查询FA使用记录，返回不超过maxNum条FA使用记录。 | ## 开发步骤 @@ -204,4 +205,35 @@ import stats from '@ohos.bundleState'; console.log('BUNDLE_ACTIVE isIdleState callback succeeded, result: ' + JSON.stringify(res)); } }); - ``` \ No newline at end of file + ``` + +8. 根据maxNum，查询FA使用记录，返回不超过maxNum条FA使用记录，config.json中需要配置权限：ohos.permission.BUNDLE_ACTIVE_INFO。 + + ```js + import stats from '@ohos.bundleState' + + // 异步方法promise方式 + stats.getModuleUsageRecord(this.maxNum).then( res => { + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise succeeded'); + for (let i = 0; i < res.length; i++) { + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise number : ' + (i + 1)); + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise result ' + JSON.stringify(res[i])); + } + }).catch( err=> { + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise failed, because: ' + err.code); + }); + + // 异步方法callback方式 + stats.getModuleUsageRecord(this.maxNum,(err, res) => { + if(err) { + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback failed, because: ' + err.code); + } else { + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback succeeded.'); + for (let i = 0; i < res.length; i++) { + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback number : ' + (i + 1)); + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback result ' + JSON.stringify(res[i])); + } + } + }); + ``` + diff --git a/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-overview.md b/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-overview.md index 66c2ea874ae4a1a8edf2403db20f81d53045835f..82cd448eb5a1f4613f88b436f5591ea04d449d52 100644 --- a/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-overview.md +++ b/zh-cn/application-dev/device-usage-statistics/device-usage-statistics-overview.md @@ -18,6 +18,7 @@ >4. 根据interval（日、周、月、年）类型和起止时间查询应用的使用时长； >5. 查询调用者应用的优先级群组； >6. 判断指定应用当前是否是空闲状态； +>7. 根据maxNum，查询FA使用记录，返回不超过maxNum条FA使用记录； ### 设备使用信息统计使用权限 - 设备使用信息统计的queryBundleActiveStates、queryBundleStateInfos、queryBundleStateInfoByInterval接口为系统api，调用前需要申请ohos.permission.BUNDLE_ACTIVE_INFO权限。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md index 0a543bf63459d95724c5144b65052421e894a134..82c730580fc73b60a881338be241c0435bd1c360 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md @@ -403,6 +403,113 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array< }); ``` +## bundleState.getModuleUsageRecord本接口从API version 9开始支持 + +getModuleUsageRecord(begin: number, end: number): Promise<Array<BundleActiveModuleInfo>> + +据maxNum，查询FA使用记录，使用Promise返回不超过maxNum条FA使用记录。 + +**需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO + +**系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | maxNum | number | 是 | 返回条目的最大数量。| + +**返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | Promise<Array<[BundleActiveModuleInfo](#bundleactivestate)>> | 指定的Promise回调方法。返回不超过maxNum条FA使用记录。| + +**示例**： + + ``` + bundleState.getModuleUsageRecord(this.maxNum).then( res => { + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise succeeded'); + for (let i = 0; i < res.length; i++) { + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise number : ' + (i + 1)); + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise result ' + JSON.stringify(res[i])); + } + }).catch( err=> { + console.log('BUNDLE_ACTIVE getModuleUsageRecord promise failed, because: ' + err.code); + }); + ``` + +## bundleState.getModuleUsageRecord本接口从API version 9开始支持 + +getModuleUsageRecord(begin: number, end: number): Promise<Array<BundleActiveModuleInfo>> + +据maxNum，查询FA使用记录，使用CallBack返回不超过maxNum条FA使用记录。 + +**需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO + +**系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | maxNum | number | 是 | 返回条目的最大数量。| + | callback | AsyncCallback<Array<[BundleActiveModuleInfo](#bundleactivestate)>> | 是 | 指定的CallBack回调方法。返回不超过maxNum条FA使用记录。| + +**示例**： + + ``` + bundleState.getModuleUsageRecord(this.maxNum,(err, res) => { + if(err) { + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback failed, because: ' + err.code); + } else { + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback succeeded.'); + for (let i = 0; i < res.length; i++) { + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback number : ' + (i + 1)); + console.log('BUNDLE_ACTIVE getModuleUsageRecord callback result ' + JSON.stringify(res[i])); + } + } + }); + ``` + +## BundleActiveModuleInfo本接口从API version 9开始支持 +提供FA的使用信息。 + +### 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| deviceId | string | 是 | FA所属deviceId。| +| bundleName | string | 是 | FA所属应用包名。| +| moduleName | string | 是 | FA所属module名。| +| abilityName | string | 是 | FA的MainAbility名。| +| appLabelId | number | 是 | FA的应用labelId。| +| labelId | number | 是 | FA所属module的labelId。| +| descriptionId | number | 是 | FA的应用descriptionId。| +| abilityLableId | number | 是 | FA的MainAbility labelId。| +| abilityDescriptionId | number | 是 | FA的MainAbility descriptionId。| +| abilityIconId | number | 是 | FA的MainAbility iconId。| +| launchedCount | number | 是 | FA的启动次数。| +| lastModuleUsedTime | number | 是 | FA的上一次使用时间。| +| formRecords | Array | 是 | FA中卡片的使用记录。| + +## BundleActiveFormInfo本接口从API version 9开始支持 +提供FA中卡片的使用记录。 + +### 属性 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| formName | number | 是 | 卡片名称。| +| formDimension | number | 是 | 卡片尺寸。| +| formId | number | 是 | 卡片Id。| +| formLastUsedTime | number | 是 | 卡片的上一次点击时间。| +| count | number | 是 | 卡片的点击次数。| + ## BundleStateInfo 提供应用使用时长的具体信息。