interface_sdk-js/api/@ohos.application.appManager.d.ts

/*
 * Copyright (c) 2021-2022 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.
 */

import { AsyncCallback } from './basic';
import ApplicationStateObserver from './application/ApplicationStateObserver';
import AppStateData from './application/AppStateData';
import { ProcessRunningInfo } from './application/ProcessRunningInfo';

/**
 * This module provides the function of app manager service.
 *
 * @since 8
 * @syscap SystemCapability.Ability.AbilityRuntime.Core
 * @import import appManager from '@ohos.application.appManager'
 * @permission N/A
 */
declare namespace appManager {
    /**
     * @name ApplicationState
     * @since 9
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @systemapi Hide this for inner system use.
     * @permission N/A
     */
    export enum ApplicationState {
        STATE_CREATE,
        STATE_FOREGROUND,
        STATE_VISIBLE,
        STATE_FOCUS,
        STATE_SUSPEND,
        STATE_KEEP_BACKGROUND,
        STATE_BACKGROUND,
        STATE_DESTROY
    }


    /**
     * @name ProcessState
     * @since 9
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @systemapi Hide this for inner system use.
     * @permission N/A
     */
    export enum ProcessState {
        STATE_CREATE,
        STATE_FOREGROUND,
        STATE_VISIBLE,
        STATE_FOCUS,
        STATE_SUSPEND,
        STATE_KEEP_BACKGROUND,
        STATE_BACKGROUND,
        STATE_DESTROY
    }

    /**
     * Register application state observer.
     *
     * @default -
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @param observer The application state observer.
     * @systemapi hide this for inner system use
     * @return Returns the number code of the observer.
     * @permission ohos.permission.RUNNING_STATE_OBSERVER
     */
    function registerApplicationStateObserver(observer: ApplicationStateObserver): number;

    /**
     * Unregister application state observer.
     *
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @param observerId Indicates the number code of the observer.
     * @systemapi hide this for inner system use
     * @return -
     * @permission ohos.permission.RUNNING_STATE_OBSERVER
     */
    function unregisterApplicationStateObserver(observerId: number,  callback: AsyncCallback<void>): void;
    function unregisterApplicationStateObserver(observerId: number): Promise<void>;

    /**
     * getForegroundApplications.
     *
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @systemapi hide this for inner system use
     * @return Returns the list of AppStateData.
     * @permission ohos.permission.GET_RUNNING_INFO
     */
     function getForegroundApplications(callback: AsyncCallback<Array<AppStateData>>): void;
     function getForegroundApplications(): Promise<Array<AppStateData>>;

    /**
     * Kill process with account.
     *
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @param bundleName The process bundle name.
     * @param accountId The account id.
     * @systemapi hide this for inner system use
     * @return -
     * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES
     */
    function killProcessWithAccount(bundleName: string, accountId: number): Promise<void>;
    function killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback<void>): void;

     /**
     * Is user running in stability test.
     *
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @return Returns true if user is running stability test.
     */
      function isRunningInStabilityTest(callback: AsyncCallback<boolean>): void;
      function isRunningInStabilityTest(): Promise<boolean>;

    /**
    * Get information about running processes
    *
    * @since 8
    * @syscap SystemCapability.Ability.AbilityRuntime.Core
    * @return Returns the array of {@link ProcessRunningInfo}.
    * @permission ohos.permission.GET_RUNNING_INFO
    */
    function getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>;
    function getProcessRunningInfos(callback: AsyncCallback<Array<ProcessRunningInfo>>): void;

    /**
     * Kill processes by bundle name
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @param bundleName bundle name.
     * @systemapi hide this for inner system use
     * @permission ohos.permission.CLEAN_BACKGROUND_PROCESSES
     */
     function killProcessesByBundleName(bundleName: string): Promise<void>;
     function killProcessesByBundleName(bundleName: string, callback: AsyncCallback<void>);

    /**
     * Clear up application data by bundle name
     * @since 8
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @param bundleName bundle name.
     * @systemapi hide this for inner system use
     * @permission ohos.permission.CLEAN_APPLICATION_DATA
     */
     function clearUpApplicationData(bundleName: string): Promise<void>;
     function clearUpApplicationData(bundleName: string, callback: AsyncCallback<void>);

    /**
     * Is it a ram-constrained device
     * @since 7
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @return whether a ram-constrained device.
     */
    function isRamConstrainedDevice(): Promise<boolean>;
    function isRamConstrainedDevice(callback: AsyncCallback<boolean>): void;

    /**
     * Get the memory size of the application
     * @since 7
     * @syscap SystemCapability.Ability.AbilityRuntime.Core
     * @return application memory size.
     */
    function getAppMemorySize(): Promise<number>;
    function getAppMemorySize(callback: AsyncCallback<number>): void;
}

export default appManager;