1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.resourceschedule.usageStatistics.d.ts 60.83 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359
/*
* 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.
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
id: number;
/**
* The total duration, in milliseconds.
* @type { ?number }
* @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.
* @type { ?number }
* @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.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityPrevSeenTime?: number;
/**
* The total duration, in milliseconds.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilitySeenTotalTime?: number;
/**
* The bundle name of the application.
* @type { ?string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName?: string;
/**
* The total duration, in milliseconds.
* @type { ?number }
* @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.
* @type { ?number }
* @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.
* @type { ?number }
* @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.
* @type { ?number }
* @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.
* @type { string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formName: string;
/**
* The form dimension.
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formDimension: number;
/**
* The form id.
* @type { number }
* @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..
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
formLastUsedTime: number;
/**
* The click count of module.
* @type { number }
* @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.
* @type { ?string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
deviceId?: string;
/**
* The bundle name.
* @type { string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName: string;
/**
* The module name.
* @type { string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
moduleName: string;
/**
* The main ability name of module.
* @type { ?string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityName?: string;
/**
* The label id of application.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
appLabelId?: number;
/**
* The label id of module.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
labelId?: number;
/**
* The description id of application.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
descriptionId?: number;
/**
* The ability id of main ability.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityLableId?: number;
/**
* The description id of main ability.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityDescriptionId?: number;
/**
* The icon id of main ability.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
abilityIconId?: number;
/**
* The launch count of module.
* @type { number }
* @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.
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
lastModuleUsedTime: number;
/**
* The form usage record list of current module.
* @type { Array<HapFormInfo> }
* @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.
* @type { string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
name: string;
/**
* The event id.
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
eventId: number;
/**
* The the event occurrence number.
* @type { 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.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
appGroup?: number;
/**
* The bundle name.
* @type { ?string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
bundleName?: string;
/**
* The shortcut ID.
* @type { ?string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
indexOfLink?: string;
/**
* The class name.
* @type { ?string }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
nameOfClass?: string;
/**
* The time when this state occurred, in milliseconds.
* @type { ?number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.App
* @systemapi Hide this for inner system use.
* @since 9
*/
eventOccurredTime?: number;
/**
* The event id.
* @type { ?number }
* @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
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
appOldGroup: number;
/**
* The usage new group of the application
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
appNewGroup: number;
/**
* The use id
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
userId: number;
/**
* The change reason
* @type { number }
* @syscap SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
* @systemapi Hide this for inner system use.
* @since 9
*/
changeReason: number;
/**
* The bundle name
* @type { string }
* @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 } 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.
* @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 } 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.
* @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 } 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.
* @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>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @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>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @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>
*
* @permission ohos.permission.BUNDLE_ACTIVE_INFO
* @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> }
* @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 } 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 } 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;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助