35 Star 109 Fork 2.6K

OpenHarmony / interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
@ohos.resourceschedule.usageStatistics.d.ts 59.91 KB
一键复制 编辑 原始数据 按行查看 历史
fengshiyi 提交于 2024-05-09 18:51 . 告警修改
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355
/*
* Copyright (c) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit BackgroundTasksKit
*/
import { AsyncCallback, Callback } from './@ohos.base';
/**
* Provides methods for managing bundle usage statistics,
* including the methods for querying bundle usage information and state data.
*
* <p>You can use the methods defined in this class to query
* the usage history and states of bundles in a specified period.
* The system stores the query result in a {@link BundleStatsInfo} instance and
* then returns it to you.
*
* @namespace usageStatistics
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @since 9
*/
declare namespace usageStatistics {
/**
* @interface BundleStatsInfo
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
interface BundleStatsInfo {
/**
* The identifier of BundleStatsInfo.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
id: number;
/**
* The total duration, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityInFgTotalTime?: number;
/**
* The last time when the application was accessed, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityPrevAccessTime?: number;
/**
* The last time when the application was visible in the foreground, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityPrevSeenTime?: number;
/**
* The total duration, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilitySeenTotalTime?: number;
/**
* The bundle name of the application.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName?: string;
/**
* The total duration, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
fgAbilityAccessTotalTime?: number;
/**
* The last time when the foreground application was accessed, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
fgAbilityPrevAccessTime?: number;
/**
* The time of the first bundle usage record in this {@code BundleActiveInfo} object,
* in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
infosBeginTime?: number;
/**
* The time of the last bundle usage record in this {@code BundleActiveInfo} object,
* in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
infosEndTime?: number;
}
/**
* @interface HapFormInfo
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
interface HapFormInfo {
/**
* The form name.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formName: string;
/**
* The form dimension.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formDimension: number;
/**
* The form id.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formId: number;
/**
* The last time when the form was accessed, in milliseconds..
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formLastUsedTime: number;
/**
* The click count of module.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
count: number;
}
/**
* @interface HapModuleInfo
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
interface HapModuleInfo {
/**
* The device id of module.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
deviceId?: string;
/**
* The bundle name.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName: string;
/**
* The module name.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
moduleName: string;
/**
* The main ability name of module.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityName?: string;
/**
* The label id of application.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
appLabelId?: number;
/**
* The label id of module.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
labelId?: number;
/**
* The description id of application.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
descriptionId?: number;
/**
* The ability id of main ability.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityLableId?: number;
/**
* The description id of main ability.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityDescriptionId?: number;
/**
* The icon id of main ability.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityIconId?: number;
/**
* The launch count of module.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
launchedCount: number;
/**
* The last time when the module was accessed, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
lastModuleUsedTime: number;
/**
* The form usage record list of current module.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formRecords: Array<HapFormInfo>;
}
/**
* @interface DeviceEventStats
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
interface DeviceEventStats {
/**
* The bundle name or system event name.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
name: string;
/**
* The event id.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
eventId: number;
/**
* The the event occurrence number.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
count: number;
}
/**
* @interface BundleEvents
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
interface BundleEvents {
/**
* The usage group of the application.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
appGroup?: number;
/**
* The bundle name.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName?: string;
/**
* The shortcut ID.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
indexOfLink?: string;
/**
* The class name.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
nameOfClass?: string;
/**
* The time when this state occurred, in milliseconds.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
eventOccurredTime?: number;
/**
* The event id.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
eventId?: number;
}
/**
* @interface AppGroupCallbackInfo
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
interface AppGroupCallbackInfo {
/**
* The usage old group of the application
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
appOldGroup: number;
/**
* The usage new group of the application
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
appNewGroup: number;
/**
* The use id
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
userId: number;
/**
* The change reason
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
changeReason: number;
/**
* The bundle name
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName: string;
}
/**
* Checks whether the application with a specified bundle name is in the idle state.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - Indicates the bundle name of the application to query.
* @param { AsyncCallback<boolean> } callback - the callback of isIdleState.
* <p> boolean value is true mean the application is idle in a particular period; false mean otherwise.
* The time range of the particular period is defined by the system, which may be hours or days.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void;
/**
* Checks whether the application with a specified bundle name is in the idle state.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - Indicates the bundle name of the application to query.
* @returns { Promise<boolean> } the promise returned by isIdleState.
* <p> boolean value is true mean the application is idle in a particular period; false mean otherwise.
* The time range of the particular period is defined by the system, which may be hours or days.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function isIdleState(bundleName: string): Promise<boolean>;
/**
* Checks whether the application with a specified bundle name is in the idle state.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - Indicates the bundle name of the application to query.
* @returns { boolean }
* <p> boolean value is true mean the application is idle in a particular period; false mean otherwise.
* The time range of the particular period is defined by the system, which may be hours or days.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 10
*/
function isIdleStateSync(bundleName: string): boolean;
/**
* Queries the app group of the calling application.
* <p>The priority defined in a priority group restricts the resource usage of an application,
* for example, restricting the running of background tasks. </p>
*
* @param { AsyncCallback<number> } callback - the callback of queryAppGroup.
* <p> Returns the app group of the calling application.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000005 - Application is not installed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100002 - Failed to get the application group information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryAppGroup(callback: AsyncCallback<number>): void;
/**
* Queries the app group of the calling application.
* <p>The priority defined in a priority group restricts the resource usage of an application,
* for example, restricting the running of background tasks. </p>
*
* @returns { Promise<number> } the promise returned by queryAppGroup.
* <p> Returns the app group of the calling application.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000005 - Application is not installed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100002 - Failed to get the application group information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryAppGroup(): Promise<number>;
/**
* Queries the app group of the calling application.
* <p>The priority defined in a priority group restricts the resource usage of an application,
* for example, restricting the running of background tasks. </p>
*
* @returns { number } Returns the app group of the calling application.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000005 - Application is not installed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100002 - Failed to get the application group information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 10
*/
function queryAppGroupSync(): number;
/**
* Queries the usage priority group by bundleName.
* <p>The priority defined in a priority group restricts the resource usage of an application,
* for example, restricting the running of background tasks. </p>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - name of the application.
* @param { AsyncCallback<number> } callback - the callback of queryAppGroup.
* <p> the usage priority group of the calling application.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000005 - Application is not installed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100002 - Failed to get the application group information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryAppGroup(bundleName: string, callback: AsyncCallback<number>): void;
/**
* Queries the usage priority group by bundleName.
* <p>The priority defined in a priority group restricts the resource usage of an application,
* for example, restricting the running of background tasks. </p>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - name of the application.
* @returns { Promise<number> } the promise returned by queryAppGroup.
* <p> the usage priority group of the calling application.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000005 - Application is not installed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100002 - Failed to get the application group information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryAppGroup(bundleName: string): Promise<number>;
/**
* Queries the usage priority group by bundleName.
* <p>The priority defined in a priority group restricts the resource usage of an application,
* for example, restricting the running of background tasks. </p>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - name of the application.
* @returns { number } the usage priority group of the calling application.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000005 - Application is not installed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100002 - Failed to get the application group information.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 10
*/
function queryAppGroupSync(bundleName: string): number;
/**
* @typedef { Record<string, BundleStatsInfo> } BundleStatsMap
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
type BundleStatsMap = Record<string, BundleStatsInfo>;
/**
* Queries usage information about each bundle within a specified period.
* <p>This method queries usage information at the {@link #BY_OPTIMIZED} interval by default.</p>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @param { AsyncCallback<BundleStatsMap> } callback - the callback of queryBundleStatsInfos,
* <p> the {@link BundleStatsMap} objects containing the usage information about each bundle.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryBundleStatsInfos(begin: number, end: number, callback: AsyncCallback<BundleStatsMap>): void;
/**
* Queries usage information about each bundle within a specified period.
* <p>This method queries usage information at the {@link #BY_OPTIMIZED} interval by default.</p>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @returns { Promise<BundleStatsMap> } the promise returned by queryBundleStatsInfos.
* <p> the {@link BundleStatsMap} objects containing the usage information about each bundle.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryBundleStatsInfos(begin: number, end: number): Promise<BundleStatsMap>;
/**
* Declares interval type.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
export enum IntervalType {
/**
* Indicates the interval type that will determine the optimal interval based on the start and end time.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
BY_OPTIMIZED = 0,
/**
* Indicates the daily interval.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
BY_DAILY = 1,
/**
* Indicates the weekly interval.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
BY_WEEKLY = 2,
/**
* Indicates the monthly interval.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
BY_MONTHLY = 3,
/**
* Indicates the annually interval.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
BY_ANNUALLY = 4
}
/**
* Queries usage information about each bundle within a specified period at a specified interval.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { IntervalType } byInterval - Indicates the interval at which the usage statistics are queried.
* <p> The value can be {@link #BY_OPTIMIZED}, {@link #BY_DAILY},
* {@link #BY_WEEKLY}, {@link #BY_MONTHLY}, or {@link #BY_ANNUALLY}.</p>
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @param { AsyncCallback<Array<BundleStatsInfo>> } callback - the callback of queryBundleStatsInfoByInterval.
* <p> the list of {@link BundleStatsInfo} objects containing the usage information about each bundle.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryBundleStatsInfoByInterval(
byInterval: IntervalType,
begin: number,
end: number,
callback: AsyncCallback<Array<BundleStatsInfo>>
): void;
/**
* Queries usage information about each bundle within a specified period at a specified interval.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { IntervalType } byInterval - Indicates the interval at which the usage statistics are queried.
* <p> The value can be {@link #BY_OPTIMIZED}, {@link #BY_DAILY},
* {@link #BY_WEEKLY}, {@link #BY_MONTHLY}, or {@link #BY_ANNUALLY}.</p>
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @returns { Promise<Array<BundleStatsInfo>> } the promise returned by queryBundleStatsInfoByInterval.
* <p> the list of {@link BundleStatsInfo} objects containing the usage information about each bundle.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryBundleStatsInfoByInterval(
byInterval: IntervalType,
begin: number,
end: number
): Promise<Array<BundleStatsInfo>>;
/**
* Queries state data of all bundles within a specified period identified by the start and end time.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @param { AsyncCallback<Array<BundleEvents>> } callback - the promise returned by queryBundleEvents.
* <p> the list of {@link BundleEvents} objects containing the state data of all bundles.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryBundleEvents(begin: number, end: number, callback: AsyncCallback<Array<BundleEvents>>): void;
/**
* Queries state data of all bundles within a specified period identified by the start and end time.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @returns { Promise<Array<BundleEvents>> } the promise returned by queryBundleEvents.
* <p> the list of {@link BundleEvents} objects containing the state data of all bundles.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryBundleEvents(begin: number, end: number): Promise<Array<BundleEvents>>;
/**
* Queries state data of the current bundle within a specified period.
*
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @param { AsyncCallback<Array<BundleEvents>> } callback - the callback of queryCurrentBundleEvents.
* <p> the {@link BundleEvents} object Array containing the state data of the current bundle.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryCurrentBundleEvents(begin: number, end: number, callback: AsyncCallback<Array<BundleEvents>>): void;
/**
* Queries state data of the current bundle within a specified period.
*
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @returns { Promise<Array<BundleEvents>> } the promise returned by queryCurrentBundleEvents.
* <p> the {@link BundleEvents} object Array containing the state data of the current bundle.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryCurrentBundleEvents(begin: number, end: number): Promise<Array<BundleEvents>>;
/**
* Queries recently module usage records with maxNum.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } maxNum - Indicates max record number in result, max value is 1000, default value is 1000.
* @param { AsyncCallback<Array<HapModuleInfo>> } callback - the callback of queryModuleUsageRecords.
* <p> the {@link HapModuleInfo} object Array containing the usage data of the modules.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryModuleUsageRecords(maxNum: number, callback: AsyncCallback<Array<HapModuleInfo>>): void;
/**
* Queries recently module usage records with maxNum.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } maxNum - Indicates max record number in result, max value is 1000, default value is 1000.
* @returns { Promise<Array<HapModuleInfo>> } the promise returned by queryModuleUsageRecords.
* <p> the {@link HapModuleInfo} object Array containing the usage data of the modules.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryModuleUsageRecords(maxNum: number): Promise<Array<HapModuleInfo>>;
/**
* Queries recently module usage records.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { AsyncCallback<Array<HapModuleInfo>> } callback - the callback of queryModuleUsageRecords.
* <p> the {@link HapModuleInfo} object Array containing the usage data of the modules.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryModuleUsageRecords(callback: AsyncCallback<Array<HapModuleInfo>>): void;
/**
* Queries recently module usage records.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @returns { Promise<Array<HapModuleInfo>> } the promise returned by queryModuleUsageRecords.
* <p> the {@link HapModuleInfo} object Array containing the usage data of the modules.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryModuleUsageRecords(): Promise<Array<HapModuleInfo>>;
/**
* Declares group type.
*
* @enum { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
export enum GroupType {
/**
* Indicates the alive group.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
ALIVE_GROUP = 10,
/**
* Indicates the daily group.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
DAILY_GROUP = 20,
/**
* Indicates the fixed group.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
FIXED_GROUP = 30,
/**
* Indicates the rare group.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
RARE_GROUP = 40,
/**
* Indicates the limit group.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
LIMITED_GROUP = 50,
/**
* Indicates the never group.
*
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
NEVER_GROUP = 60
}
/**
* Set app group by bundleName.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - name of the application.
* @param { GroupType } newGroup - the group of the application whose name is bundleName.
* @param { AsyncCallback<void> } callback - the callback of setAppGroup.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100001 - Repeated operation on the application group.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function setAppGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback<void>): void;
/**
* Set app group by bundleName.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { string } bundleName - name of the application.
* @param { GroupType } newGroup - the group of the application whose name is bundleName.
* @returns { Promise<void> } the promise returned by setAppGroup.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10100001 - Repeated operation on the application group.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function setAppGroup(bundleName: string, newGroup: GroupType): Promise<void>;
/**
* Register appGroup change callback to service.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { Callback<AppGroupCallbackInfo> } groupCallback -
* <p> callback of AppGroupCallbackInfo when the group of app changed.</p>
* @param { AsyncCallback<void> } callback - the callback of registerAppGroupCallBack.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10100001 - Repeated operation on the application group.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function registerAppGroupCallBack(groupCallback: Callback<AppGroupCallbackInfo>, callback: AsyncCallback<void>): void;
/**
* Register appGroup change callback to service.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { Callback<AppGroupCallbackInfo> } groupCallback -
* <p> callback of AppGroupCallbackInfo when the group of app changed.</p>
* @returns { Promise<void> } the promise returned by registerAppGroupCallBack.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10100001 - Repeated operation on the application group.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function registerAppGroupCallBack(groupCallback: Callback<AppGroupCallbackInfo>): Promise<void>;
/**
* Unregister appGroup change callback from service.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { AsyncCallback<void> } callback - the callback of unregisterAppGroupCallBack.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10100001 - Repeated operation on the application group.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function unregisterAppGroupCallBack(callback: AsyncCallback<void>): void;
/**
* Unregister appGroup change callback from service.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @returns { Promise<void> } the promise returned by unregisterAppGroupCallBack.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10100001 - Repeated operation on the application group.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
function unregisterAppGroupCallBack(): Promise<void>;
/**
* Queries device event states data within a specified period identified by the start and end time.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @param { AsyncCallback<Array<DeviceEventStats>> } callback - the callback of queryDeviceEventStats.
* <p> the {@link DeviceEventStats} object Array containing the event states data.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryDeviceEventStats(begin: number, end: number, callback: AsyncCallback<Array<DeviceEventStats>>): void;
/**
* Queries device event states data within a specified period identified by the start and end time.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @returns { Promise<Array<DeviceEventStats>> } the promise returned by queryDeviceEventStats.
* <p> the {@link DeviceEventStats} object Array containing the event states data.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryDeviceEventStats(begin: number, end: number): Promise<Array<DeviceEventStats>>;
/**
* Queries app notification number within a specified period identified by the start and end time.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @param { AsyncCallback<Array<DeviceEventStats>> } callback - the callback of queryNotificationEventStats.
* <p> the {@link DeviceEventStats} object Array containing the event states data.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryNotificationEventStats(
begin: number,
end: number,
callback: AsyncCallback<Array<DeviceEventStats>>
): void;
/**
* Queries app notification number within a specified period identified by the start and end time.
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @param { number } begin - Indicates the start time of the query period, in milliseconds.
* @param { number } end - Indicates the end time of the query period, in milliseconds.
* @returns { Promise<Array<DeviceEventStats>> } the promise returned by queryNotificationEventStats.
* <p> the {@link DeviceEventStats} object Array containing the event states data.</p>
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 202 - Not System App.
* @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Mandatory parameters are left unspecified;
* <br> 2. Incorrect parameters types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported.
* @throws { BusinessError } 10000001 - Memory operation failed.
* @throws { BusinessError } 10000002 - Parcel operation failed.
* @throws { BusinessError } 10000003 - System service operation failed.
* @throws { BusinessError } 10000004 - IPC failed.
* @throws { BusinessError } 10000006 - Failed to get the application information.
* @throws { BusinessError } 10000007 - Failed to get the system time.
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
function queryNotificationEventStats(begin: number, end: number): Promise<Array<DeviceEventStats>>;
}
export default usageStatistics;
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助