mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-30 10:53:31 +00:00
dbcbcb2994
Signed-off-by: yuwenze <yuwenze1@huawei.com> Change-Id: I15bd2794cd69263e9ff4f898a948ac3cc679c66a
986 lines
40 KiB
TypeScript
986 lines
40 KiB
TypeScript
/*
|
|
* Copyright (c) 2022-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 AbilityKit
|
|
*/
|
|
|
|
import { AsyncCallback } from './@ohos.base';
|
|
import * as _ApplicationStateObserver from './application/ApplicationStateObserver';
|
|
import type * as _AppForegroundStateObserver from './application/AppForegroundStateObserver';
|
|
import * as _AbilityStateData from './application/AbilityStateData';
|
|
import * as _AppStateData from './application/AppStateData';
|
|
import type * as _ProcessData from './application/ProcessData';
|
|
import { ProcessInformation as _ProcessInformation } from './application/ProcessInformation';
|
|
import * as _AbilityFirstFrameStateObserver from './application/AbilityFirstFrameStateObserver';
|
|
import * as _AbilityFirstFrameStateData from './application/AbilityFirstFrameStateData';
|
|
import bundleManager from './@ohos.bundle.bundleManager';
|
|
import { RunningMultiAppInfo as _RunningMultiAppInfo } from './application/RunningMultiAppInfo';
|
|
|
|
/**
|
|
* This module provides the function of app manager service.
|
|
*
|
|
* @namespace appManager
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* This module provides the function of app manager service.
|
|
*
|
|
* @namespace appManager
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
declare namespace appManager {
|
|
/**
|
|
* Enum for the application state
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export enum ApplicationState {
|
|
/**
|
|
* The state in which the application is being created.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
STATE_CREATE,
|
|
|
|
/**
|
|
* The state that the application is in when it switches to the foreground.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
STATE_FOREGROUND,
|
|
|
|
/**
|
|
* The state in which the application is in focus.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
STATE_ACTIVE,
|
|
|
|
/**
|
|
* The state in which the application is invisible in the background.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
STATE_BACKGROUND,
|
|
|
|
/**
|
|
* The state that the application is in when it is destroyed.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
STATE_DESTROY
|
|
}
|
|
|
|
/**
|
|
* Enum for the process state
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Enum for the process state
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
export enum ProcessState {
|
|
/**
|
|
* The state that the process is in when it is being created.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* The state that the process is in when it is being created.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
STATE_CREATE,
|
|
|
|
/**
|
|
* The state in which the process is in when it switches to the foreground.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* The state in which the process is in when it switches to the foreground.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
STATE_FOREGROUND,
|
|
|
|
/**
|
|
* The state in which the process is in focus.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* The state in which the process is in focus.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
STATE_ACTIVE,
|
|
|
|
/**
|
|
* The state in which a process is invisible in the background.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* The state in which a process is invisible in the background.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
STATE_BACKGROUND,
|
|
|
|
/**
|
|
* The state that the process is in when it is destroyed.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* The state that the process is in when it is destroyed.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
STATE_DESTROY
|
|
}
|
|
|
|
/**
|
|
* Enum for the preload mode
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
export enum PreloadMode {
|
|
/**
|
|
* Preload application when press the app icon down.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PRESS_DOWN
|
|
}
|
|
|
|
/**
|
|
* Register application state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'applicationState' } type - applicationState.
|
|
* @param { ApplicationStateObserver } observer - The application state observer.
|
|
* @returns { number } Returns the number code of the observer.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function on(type: 'applicationState', observer: ApplicationStateObserver): number;
|
|
|
|
/**
|
|
* Register application state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'applicationState' } type - applicationState.
|
|
* @param { ApplicationStateObserver } observer - The application state observer.
|
|
* @param { Array<string> } bundleNameList - The list of bundleName. The max length is 128.
|
|
* @returns { number } Returns the number code of the observer.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function on(type: 'applicationState', observer: ApplicationStateObserver, bundleNameList: Array<string>): number;
|
|
|
|
/**
|
|
* Register app foreground or background state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'appForegroundState' } type - app foreground or background state.
|
|
* @param { AppForegroundStateObserver } observer - The app foreground state observer.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
function on(type: 'appForegroundState', observer: AppForegroundStateObserver): void;
|
|
|
|
/**
|
|
* Register ability first frame state observe.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'abilityFirstFrameState' } type - The ability first frame drawing state.
|
|
* @param { AbilityFirstFrameStateObserver } observer - The ability first frame state observer.
|
|
* @param { string } [bundleName] - The target bundle name.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
function on(type: 'abilityFirstFrameState', observer: AbilityFirstFrameStateObserver, bundleName?: string): void;
|
|
|
|
/**
|
|
* Unregister application state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'applicationState' } type - applicationState.
|
|
* @param { number } observerId - Indicates the number code of the observer.
|
|
* @param { AsyncCallback<void> } callback - The callback of off.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function off(type: 'applicationState', observerId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Unregister application state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'applicationState' } type - applicationState.
|
|
* @param { number } observerId - Indicates the number code of the observer.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function off(type: 'applicationState', observerId: number): Promise<void>;
|
|
|
|
/**
|
|
* Unregister app foreground or background state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'appForegroundState' } type - app foreground or background state.
|
|
* @param { AppForegroundStateObserver } [observer] - The app foreground state observer.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
function off(type: 'appForegroundState', observer?: AppForegroundStateObserver): void;
|
|
|
|
/**
|
|
* Unregister ability first frame state observer.
|
|
*
|
|
* @permission ohos.permission.RUNNING_STATE_OBSERVER
|
|
* @param { 'abilityFirstFrameState' } type - The ability first frame drawing state.
|
|
* @param { AbilityFirstFrameStateObserver } [observer] - The ability first frame state observer.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
function off(type: 'abilityFirstFrameState', observer?: AbilityFirstFrameStateObserver): void;
|
|
|
|
/**
|
|
* getForegroundApplications.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { AsyncCallback<Array<AppStateData>> } callback - The callback is used to return the list of AppStateData.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getForegroundApplications(callback: AsyncCallback<Array<AppStateData>>): void;
|
|
|
|
/**
|
|
* getForegroundApplications.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @returns { Promise<Array<AppStateData>> } Returns the list of AppStateData.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function getForegroundApplications(): Promise<Array<AppStateData>>;
|
|
|
|
/**
|
|
* Kill process with account.
|
|
*
|
|
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES
|
|
* @param { string } bundleName - The process bundle name.
|
|
* @param { number } accountId - The account id.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function killProcessWithAccount(bundleName: string, accountId: number): Promise<void>;
|
|
|
|
/**
|
|
* Kill process with account.
|
|
*
|
|
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES
|
|
* @param { string } bundleName - The process bundle name.
|
|
* @param { number } accountId - The account id.
|
|
* @param { AsyncCallback<void> } callback - The callback of killProcessWithAccount.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Is user running in stability test.
|
|
*
|
|
* @param { AsyncCallback<boolean> } callback - The callback is used to return true if user is running stability test.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Is user running in stability test.
|
|
*
|
|
* @param { AsyncCallback<boolean> } callback - The callback is used to return true if user is running stability test.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function isRunningInStabilityTest(callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Is user running in stability test.
|
|
*
|
|
* @returns { Promise<boolean> } Returns true if user is running stability test.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Is user running in stability test.
|
|
*
|
|
* @returns { Promise<boolean> } Returns true if user is running stability test.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function isRunningInStabilityTest(): Promise<boolean>;
|
|
|
|
/**
|
|
* Kill processes by bundle name
|
|
*
|
|
* @permission ohos.permission.CLEAN_BACKGROUND_PROCESSES
|
|
* @param { string } bundleName - bundle name.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function killProcessesByBundleName(bundleName: string): Promise<void>;
|
|
|
|
/**
|
|
* Kill processes by bundle name
|
|
*
|
|
* @permission ohos.permission.CLEAN_BACKGROUND_PROCESSES
|
|
* @param { string } bundleName - bundle name.
|
|
* @param { AsyncCallback<void> } callback - The callback of killProcessesByBundleName.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function killProcessesByBundleName(bundleName: string, callback: AsyncCallback<void>);
|
|
|
|
/**
|
|
* Clear up application data by bundle name
|
|
*
|
|
* @permission ohos.permission.CLEAN_APPLICATION_DATA
|
|
* @param { string } bundleName - bundle name.
|
|
* @returns { Promise<void> } The promise returned by the function.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function clearUpApplicationData(bundleName: string): Promise<void>;
|
|
|
|
/**
|
|
* Clear up application data by bundle name
|
|
*
|
|
* @permission ohos.permission.CLEAN_APPLICATION_DATA
|
|
* @param { string } bundleName - bundle name.
|
|
* @param { AsyncCallback<void> } callback - The callback of clearUpApplicationData.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function clearUpApplicationData(bundleName: string, callback: AsyncCallback<void>);
|
|
|
|
/**
|
|
* Is it a ram-constrained device
|
|
*
|
|
* @returns { Promise<boolean> } Returns true if the device is ram-constrained.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Is it a ram-constrained device
|
|
*
|
|
* @returns { Promise<boolean> } Returns true if the device is ram-constrained.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function isRamConstrainedDevice(): Promise<boolean>;
|
|
|
|
/**
|
|
* Is it a ram-constrained device
|
|
*
|
|
* @param { AsyncCallback<boolean> } callback - The callback is used to return true if the device is ram-constrained.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Is it a ram-constrained device
|
|
*
|
|
* @param { AsyncCallback<boolean> } callback - The callback is used to return true if the device is ram-constrained.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function isRamConstrainedDevice(callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Get the memory size of the application
|
|
*
|
|
* @returns { Promise<number> } Returns the application memory size.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Get the memory size of the application
|
|
*
|
|
* @returns { Promise<number> } Returns the application memory size.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function getAppMemorySize(): Promise<number>;
|
|
|
|
/**
|
|
* Get the memory size of the application
|
|
*
|
|
* @param { AsyncCallback<number> } callback - The callback is used to return the application memory size.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Get the memory size of the application
|
|
*
|
|
* @param { AsyncCallback<number> } callback - The callback is used to return the application memory size.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function getAppMemorySize(callback: AsyncCallback<number>): void;
|
|
|
|
/**
|
|
* If you apply for permission, you can obtain information about all running processes.
|
|
* If you do not apply, you can only obtain information about the current process.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @returns { Promise<Array<ProcessInformation>> } Returns the array of {@link ProcessInformation}.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Get information about the current process.
|
|
*
|
|
* @returns { Promise<Array<ProcessInformation>> } Returns the array of {@link ProcessInformation}.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function getRunningProcessInformation(): Promise<Array<ProcessInformation>>;
|
|
|
|
/**
|
|
* Get running process information by bundle type.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { bundleManager.BundleType } bundleType - the bundle type of the process
|
|
* @returns { Promise<Array<ProcessInformation>> } Returns the array of {@link ProcessInformation}.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
function getRunningProcessInformationByBundleType(
|
|
bundleType: bundleManager.BundleType): Promise<Array<ProcessInformation>>;
|
|
|
|
/**
|
|
* If you apply for permission, you can obtain information about all running processes.
|
|
* If you do not apply, you can only obtain information about the current process.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { AsyncCallback<Array<ProcessInformation>> } callback - The callback is used to return the array of {@link ProcessInformation}.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Get information about the current process.
|
|
*
|
|
* @param { AsyncCallback<Array<ProcessInformation>> } callback - The callback is used to return the array of {@link ProcessInformation}.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
function getRunningProcessInformation(callback: AsyncCallback<Array<ProcessInformation>>): void;
|
|
|
|
/**
|
|
* Check whether the shared bundle is running.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the shared bundle.
|
|
* @param { number } versionCode - Indicates the version code of the shared bundle.
|
|
* @returns { Promise<boolean> } Returns the shared bundle running result. The result is true if running, false otherwise.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function isSharedBundleRunning(bundleName: string, versionCode: number): Promise<boolean>;
|
|
|
|
/**
|
|
* Check whether the shared bundle is running.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the shared bundle.
|
|
* @param { number } versionCode - Indicates the version code of the shared bundle.
|
|
* @param { AsyncCallback<boolean> } callback - The callback of checking the shared bundle running result.
|
|
* The result is true if running, false otherwise.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function isSharedBundleRunning(bundleName: string, versionCode: number, callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Obtains memory usage of one process by its pid.
|
|
*
|
|
* @param { number } pid - Indicates the pid of the process.
|
|
* @returns { Promise<number> } Returns the memory usage of the process in KB.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getProcessMemoryByPid(pid: number): Promise<number>;
|
|
|
|
/**
|
|
* Obtains memory usage of one process by its pid.
|
|
*
|
|
* @param { number } pid - Indicates the pid of the process.
|
|
* @param { AsyncCallback<number> } callback - Indicates the callback of getting process memory by pid result.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getProcessMemoryByPid(pid: number, callback: AsyncCallback<number>): void;
|
|
|
|
/**
|
|
* Obtains the process information list of running processes that belong to a specific bundle of current user.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the processes belong to.
|
|
* @param { AsyncCallback<Array<ProcessInformation>> } callback - Indicates the callback of getting process information by bundleName result.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getRunningProcessInfoByBundleName(bundleName: string, callback: AsyncCallback<Array<ProcessInformation>>): void;
|
|
|
|
/**
|
|
* Obtains the process information list of running processes that belong to a specific bundle and specific user ID.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the processes belong to.
|
|
* @param { number } userId - Indicates the user ID of the application to which the processes belong to.
|
|
* @param { AsyncCallback<Array<ProcessInformation>> } callback - Indicates the callback of getting process information by bundleName result.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getRunningProcessInfoByBundleName(bundleName: string, userId: number, callback: AsyncCallback<Array<ProcessInformation>>): void;
|
|
|
|
/**
|
|
* Obtains the process information list of running processes that belong to a specific bundle of current user.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the processes belong to.
|
|
* @returns { Promise<Array<ProcessInformation>> } Returns a list of process information.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getRunningProcessInfoByBundleName(bundleName: string): Promise<Array<ProcessInformation>>;
|
|
|
|
/**
|
|
* Obtains the process information list of running processes that belong to a specific bundle and specific user ID.
|
|
*
|
|
* @param { string } bundleName - Indicates the bundle name of the application to which the processes belong to.
|
|
* @param { number } userId - Indicates the user ID of the application to which the processes belong to.
|
|
* @returns { Promise<Array<ProcessInformation>> } Returns a list of process information.
|
|
* @throws { BusinessError } 202 - Permission denied, non-system app called system api.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
function getRunningProcessInfoByBundleName(bundleName: string, userId: number): Promise<Array<ProcessInformation>>;
|
|
|
|
/**
|
|
* Check whether the bundle is running.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the bundle.
|
|
* @returns { Promise<boolean> } Returns the bundle running result. The result is true if running, false otherwise.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
function isApplicationRunning(bundleName: string): Promise<boolean>;
|
|
|
|
/**
|
|
* Check whether the bundle is running.
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { string } bundleName - Indicates the bundle name of the bundle.
|
|
* @param { AsyncCallback<boolean> } callback - The callback of checking the bundle running result.
|
|
* The result is true if running, false otherwise.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
function isApplicationRunning(bundleName: string, callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Preload the target application, create process and initialize resources.
|
|
*
|
|
* @permission ohos.permission.PRELOAD_APPLICATION
|
|
* @param { string } bundleName - The bundle name of the application to preload.
|
|
* @param { number } userId - Indicates the user identification.
|
|
* @param { PreloadMode } mode - Preload application mode.
|
|
* @param { number } [appIndex] - The index of application clone.
|
|
* @returns { Promise<void> } Returns the result of preloadApplication.
|
|
* @throws { BusinessError } 201 - The application does not have permission to call the interface.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000050 - Internal error.
|
|
* @throws { BusinessError } 16300005 - The target bundle does not exist.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
function preloadApplication(bundleName: string, userId: number, mode: PreloadMode, appIndex?: number): Promise<void>;
|
|
|
|
/**
|
|
* Get all running multi app info by bundleName
|
|
*
|
|
* @permission ohos.permission.GET_RUNNING_INFO
|
|
* @param { string } bundleName - The bundle name of the application to query.
|
|
* @returns { Promise<RunningMultiAppInfo> } Returns the {@link RunningMultiAppInfo} for given bundle.
|
|
* @throws { BusinessError } 201 - Permission denied.
|
|
* @throws { BusinessError } 202 - Not system application.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @throws { BusinessError } 16000072 - App clone or multi-instance is not supported.
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
function getRunningMultiAppInfo(bundleName: string): Promise<RunningMultiAppInfo>;
|
|
|
|
/**
|
|
* The ability or extension state data.
|
|
*
|
|
* @typedef { _AbilityStateData.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type AbilityStateData = _AbilityStateData.default;
|
|
|
|
/**
|
|
* The application state data.
|
|
*
|
|
* @typedef { _AppStateData.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type AppStateData = _AppStateData.default;
|
|
|
|
/**
|
|
* The application state observer.
|
|
*
|
|
* @typedef { _ApplicationStateObserver.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
export type ApplicationStateObserver = _ApplicationStateObserver.default;
|
|
|
|
/**
|
|
* The application foreground state observer.
|
|
*
|
|
* @typedef { _AppForegroundStateObserver.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
export type AppForegroundStateObserver = _AppForegroundStateObserver.default;
|
|
|
|
/**
|
|
* The class of a process information.
|
|
*
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The class of a process information.
|
|
*
|
|
* @typedef { _ProcessInformation }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
export type ProcessInformation = _ProcessInformation;
|
|
|
|
/**
|
|
* The class of a process information.
|
|
*
|
|
* @typedef { _ProcessData.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
export type ProcessData = _ProcessData.default;
|
|
|
|
/**
|
|
* The ability first frame state observer.
|
|
*
|
|
* @typedef { _AbilityFirstFrameStateObserver.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
export type AbilityFirstFrameStateObserver = _AbilityFirstFrameStateObserver.default;
|
|
|
|
/**
|
|
* The class of an ability first frame state data.
|
|
*
|
|
* @typedef { _AbilityFirstFrameStateData.default }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
export type AbilityFirstFrameStateData = _AbilityFirstFrameStateData.default;
|
|
|
|
/**
|
|
* The class of running multi app information.
|
|
*
|
|
* @typedef { _RunningMultiAppInfo }
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @systemapi
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
export type RunningMultiAppInfo = _RunningMultiAppInfo;
|
|
}
|
|
|
|
export default appManager;
|