• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * Defines the FormLink options.
18 *
19 * @interface FormLinkOptions
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 10
22 * @form
23*/
24declare interface FormLinkOptions {
25  /**
26   * Action types: "router" and "message".
27   *
28   * @type { string }
29   * @syscap SystemCapability.ArkUI.ArkUI.Full
30   * @since 10
31   * @form
32   */
33  action: string;
34
35  /**
36   * Module name of destination UIAbility.
37   *
38   * @type { ?string }
39   * @syscap SystemCapability.ArkUI.ArkUI.Full
40   * @since 10
41   * @form
42   */
43  moduleName?: string;
44
45  /**
46   * Bundle name of destination UIAbility.
47   *
48   * @type { ?string }
49   * @syscap SystemCapability.ArkUI.ArkUI.Full
50   * @since 10
51   * @form
52   */
53  bundleName?: string;
54
55  /**
56   * Name of destination UIAbility.
57   *
58   * @type { string }
59   * @syscap SystemCapability.ArkUI.ArkUI.Full
60   * @since 10
61   * @form
62   */
63  abilityName: string;
64
65  /**
66   * The additional parameters, use JSON format key value pairs for content.
67   *
68   * @type { ?Object }
69   * @syscap SystemCapability.ArkUI.ArkUI.Full
70   * @since 10
71   * @form
72   */
73  params?: Object;
74}
75
76/**
77 * Defines the FormLink interface.
78 *
79 * @interface FormLinkInterface
80 * @syscap SystemCapability.ArkUI.ArkUI.Full
81 * @since 10
82 * @form
83 */
84interface FormLinkInterface {
85  /**
86   * Init FormLink component with options.
87   *
88   * @param { FormLinkOptions } options
89   * @returns { FormLinkAttribute }
90   * @syscap SystemCapability.ArkUI.ArkUI.Full
91   * @since 10
92   * @form
93   */
94  (options: FormLinkOptions): FormLinkAttribute;
95}
96
97/**
98 * Defines the FormLink attribute.
99 *
100 * @extends CommonMethod
101 * @syscap SystemCapability.ArkUI.ArkUI.Full
102 * @since 10
103 * @form
104 */
105declare class FormLinkAttribute extends CommonMethod<FormLinkAttribute> {
106}
107
108/**
109 * Defines FormLink component.
110 *
111 * @syscap SystemCapability.ArkUI.ArkUI.Full
112 * @since 10
113 * @form
114 */
115declare const FormLink: FormLinkInterface;
116
117/**
118 * Defines FormLink component instance.
119 *
120 * @syscap SystemCapability.ArkUI.ArkUI.Full
121 * @since 10
122 * @form
123 */
124declare const FormLinkInstance: FormLinkAttribute;
125