xref: /interface/sdk-js/api/@ohos.resourceschedule.systemload.d.ts

/*
 * Copyright (c) 2024 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 BasicServicesKit
 */

import type { Callback } from './@ohos.base';

/**
 * This module provides the capability to get systemLoad.
 *
 * @namespace systemLoad
 * @syscap SystemCapability.ResourceSchedule.SystemLoad
 * @since 12
 */
declare namespace systemLoad {
    /**
     * Enumerates the {@link SystemLoadLevel} types.
     *
     * @enum {number}
     * @syscap SystemCapability.ResourceSchedule.SystemLoad
     * @since 12
     */
    export enum SystemLoadLevel {
        /**
         * level low
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        LOW = 0,
        /**
         * level NORMAL
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        NORMAL = 1,
        /**
         * level MEDIUM
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        MEDIUM = 2,
        /**
         * level HIGH
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        HIGH = 3,
        /**
         * level OVERHEATED
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        OVERHEATED = 4,
        /**
         * level WARNING
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        WARNING = 5,
        /**
         * level EMERGENCY
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        EMERGENCY = 6,
        /**
         * level ESCAPE
         * 
         * @syscap SystemCapability.ResourceSchedule.SystemLoad
         * @since 12
         */
        ESCAPE = 7
    }

    /**
     * Register system load callback for perception system load change
     * @param { 'systemLoadChange' } type system load change type.
     * @param { Callback<SystemLoadLevel> } callback Asynchronous callback interface.
     * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Callback parameter error;
     * <br> 2. Register a exist callback type; 3. Parameter verification failed.
     * @syscap SystemCapability.ResourceSchedule.SystemLoad
     * @since 12
     */
    function on(type: 'systemLoadChange', callback: Callback<SystemLoadLevel>): void;

    /**
     * Unregister system load callback for perception system load change
     * @param { 'systemLoadChange' } type system load change type.
     * @param { Callback<SystemLoadLevel> } callback Asynchronous callback interface.
     * @throws { BusinessError } 401 - Parameter error. Possible cause: 1. Callback parameter error;
     * <br> 2. Unregister type has not register; 3. Parameter verification failed.
     * @syscap SystemCapability.ResourceSchedule.SystemLoad
     * @since 12
     */
    function off(type: 'systemLoadChange', callback?: Callback<SystemLoadLevel>): void;

    /**
     * @returns { Promise<SystemLoadLevel> } The promise form returns the SystemLoadLevel result
     * Queries the current system level
     * @syscap SystemCapability.ResourceSchedule.SystemLoad
     * @since 12
     */
    function getLevel(): Promise<SystemLoadLevel>;
}
export default systemLoad;