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

/*
 * Copyright (c) 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 Want from './@ohos.app.ability.Want';

/**
 * interface of formInfo.
 *
 * @name formInfo
 * @since 8
 * @syscap SystemCapability.Ability.Form
 * @deprecated since 9
 * @useinstead ohos.app.form.formInfo
 */
declare namespace formInfo {
    /**
     * Provides information about a form.
     *
     * @name FormInfo
     * @since 8
     * @syscap SystemCapability.Ability.Form
     */
    interface FormInfo {
        /**
         * Obtains the bundle name of the application to which this form belongs.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        bundleName: string;

        /**
         * Obtains the name of the application module to which this form belongs.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        moduleName: string;

        /**
         * Obtains the class name of the ability to which this form belongs.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        abilityName: string;

        /**
         * Obtains the name of this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        name: string;

        /**
         * Obtains the name of this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        description: string;

        /**
         * Obtains the type of this form. Currently, JS forms are supported.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        type: FormType;

        /**
         * Obtains the JS component name of this JS form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        jsComponentName: string;

        /**
         * Obtains the color mode of this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        colorMode: ColorMode;

        /**
         * Checks whether this form is a default form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        isDefault: boolean;

        /**
         * Obtains the updateEnabled.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        updateEnabled: boolean;

        /**
         * Obtains whether notify visible of this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        formVisibleNotify: boolean;

        /**
         * Obtains the bundle relatedBundleName of the application to which this form belongs.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        relatedBundleName: string;

        /**
         * Obtains the scheduledUpdateTime.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        scheduledUpdateTime: string;

        /**
         * Obtains the form config ability about this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        formConfigAbility: string;

        /**
         * Obtains the updateDuration.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        updateDuration: number;

        /**
         * Obtains the default grid style of this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        defaultDimension: number;

        /**
         * Obtains the grid styles supported by this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        supportDimensions: Array<number>;

        /**
         * Obtains the custom data defined in this form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        customizeData: {[key: string]: [value: string]};
    }

    /**
     * Type of form.
     *
     * @name FormType
     * @since 8
     * @syscap SystemCapability.Ability.Form
    */
    enum FormType {
        /**
         * JS form.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        JS = 1
    }

    /**
     * Color mode.
     *
     * @name ColorMode
     * @since 8
     * @syscap SystemCapability.Ability.Form
    */
    enum ColorMode {
        /**
         * Automatic mode.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        MODE_AUTO = -1,

        /**
         * Dark mode.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        MODE_DARK = 0,

        /**
         * Light mode.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        MODE_LIGHT = 1
    }

    /**
     * Provides state information about a form.
     *
     * @name FormStateInfo
     * @since 8
     * @syscap SystemCapability.Ability.Form
     */
    interface FormStateInfo {
        /**
         * Obtains the form state.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        formState: FormState;

        /**
         * Obtains the want form .
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        want: Want;
    }

    /**
     * Provides state about a form.
     *
     * @name FormState
     * @since 8
     * @syscap SystemCapability.Ability.Form
     */
    enum FormState {
        /**
         * Indicates that the form status is unknown due to an internal error.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        UNKNOWN = -1,

        /**
         * Indicates that the form is in the default state.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        DEFAULT = 0,

        /**
         * Indicates that the form is ready.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        READY = 1,
    }

    /**
     * Parameter of form.
     *
     * @name FormParam
     * @since 8
     * @syscap SystemCapability.Ability.Form
     */
    enum FormParam {
        /**
         * Indicates the key specifying the ID of the form to be obtained, which is represented as
         * want: {
         *   "parameters": {
         *       IDENTITY_KEY: 1L
         *    }
         * }.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         * @systemapi hide for inner use.
         */
        IDENTITY_KEY = "ohos.extra.param.key.form_identity",

        /**
         * Indicates the key specifying the grid style of the form to be obtained, which is represented as
         * want: {
         *   "parameters": {
         *       DIMENSION_KEY: FormDimension.Dimension_1_2
         *    }
         * }.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        DIMENSION_KEY = "ohos.extra.param.key.form_dimension",

        /**
         * Indicates the key specifying the name of the form to be obtained, which is represented as
         * want: {
         *   "parameters": {
         *       NAME_KEY: "formName"
         *    }
         * }.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        NAME_KEY = "ohos.extra.param.key.form_name",

        /**
         * Indicates the key specifying the name of the module to which the form to be obtained belongs, which is
         * represented as
         * want: {
         *   "parameters": {
         *       MODULE_NAME_KEY: "formEntry"
         *    }
         * }
         * This constant is mandatory.
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        MODULE_NAME_KEY = "ohos.extra.param.key.module_name",

        /**
         * Indicates the key specifying the width of the form to be obtained, which is represented as
         * want: {
         *   "parameters": {
         *       WIDTH_KEY: 800
         *    }
         * }
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        WIDTH_KEY = "ohos.extra.param.key.form_width",

        /**
         * Indicates the key specifying the height of the form to be obtained, which is represented as
         * want: {
         *   "parameters": {
         *       HEIGHT_KEY: 400
         *    }
         * }
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        HEIGHT_KEY = "ohos.extra.param.key.form_height",

        /**
         * Indicates the key specifying whether a form is temporary, which is represented as
         * want: {
         *   "parameters": {
         *       TEMPORARY_KEY: true
         *    }
         * }
         *
         * @since 8
         * @syscap SystemCapability.Ability.Form
         */
        TEMPORARY_KEY = "ohos.extra.param.key.form_temporary"
    }
}
export default formInfo;