• 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 * @file
18 * @kit ArkUI
19 */
20
21/**
22 * Defines the FormLink options.
23 *
24 * @interface FormLinkOptions
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @form
27 * @since 10
28*/
29/**
30 * Defines the FormLink options.
31 *
32 * @interface FormLinkOptions
33 * @syscap SystemCapability.ArkUI.ArkUI.Full
34 * @form
35 * @atomicservice
36 * @since 11
37*/
38declare interface FormLinkOptions {
39  /**
40   * Action types: "router" and "message".
41   *
42   * @type { string }
43   * @syscap SystemCapability.ArkUI.ArkUI.Full
44   * @form
45   * @since 10
46   */
47  /**
48   * Action types: "router" and "message".
49   *
50   * @type { string }
51   * @syscap SystemCapability.ArkUI.ArkUI.Full
52   * @form
53   * @atomicservice
54   * @since 11
55   */
56  action: string;
57
58  /**
59   * Module name of destination UIAbility.
60   *
61   * @type { ?string }
62   * @syscap SystemCapability.ArkUI.ArkUI.Full
63   * @form
64   * @since 10
65   */
66  /**
67   * Module name of destination UIAbility.
68   *
69   * @type { ?string }
70   * @syscap SystemCapability.ArkUI.ArkUI.Full
71   * @form
72   * @atomicservice
73   * @since 11
74   */
75  moduleName?: string;
76
77  /**
78   * Bundle name of destination UIAbility.
79   *
80   * @type { ?string }
81   * @syscap SystemCapability.ArkUI.ArkUI.Full
82   * @form
83   * @since 10
84   */
85  /**
86   * Bundle name of destination UIAbility.
87   *
88   * @type { ?string }
89   * @syscap SystemCapability.ArkUI.ArkUI.Full
90   * @form
91   * @atomicservice
92   * @since 11
93   */
94  bundleName?: string;
95
96  /**
97   * Name of destination UIAbility.
98   *
99   * @type { string }
100   * @syscap SystemCapability.ArkUI.ArkUI.Full
101   * @form
102   * @since 10
103   */
104  /**
105   * Name of destination UIAbility.
106   *
107   * @type { ?string }
108   * @syscap SystemCapability.ArkUI.ArkUI.Full
109   * @form
110   * @atomicservice
111   * @since 11
112   */
113  abilityName?: string;
114
115  /**
116   * uri of destination UIAbility.
117   *
118   * @type { ?string }
119   * @syscap SystemCapability.ArkUI.ArkUI.Full
120   * @form
121   * @atomicservice
122   * @since 11
123   */
124  uri?: string;
125
126  /**
127   * The additional parameters, use JSON format key value pairs for content.
128   *
129   * @type { ?Object }
130   * @syscap SystemCapability.ArkUI.ArkUI.Full
131   * @form
132   * @since 10
133   */
134  /**
135   * The additional parameters, use JSON format key value pairs for content.
136   *
137   * @type { ?Object }
138   * @syscap SystemCapability.ArkUI.ArkUI.Full
139   * @form
140   * @atomicservice
141   * @since 11
142   */
143  params?: Object;
144}
145
146/**
147 * Defines the FormLink interface.
148 *
149 * @interface FormLinkInterface
150 * @syscap SystemCapability.ArkUI.ArkUI.Full
151 * @form
152 * @since 10
153 */
154/**
155 * Defines the FormLink interface.
156 *
157 * @interface FormLinkInterface
158 * @syscap SystemCapability.ArkUI.ArkUI.Full
159 * @form
160 * @atomicservice
161 * @since 11
162 */
163interface FormLinkInterface {
164  /**
165   * Init FormLink component with options.
166   *
167   * @param { FormLinkOptions } options
168   * @returns { FormLinkAttribute }
169   * @syscap SystemCapability.ArkUI.ArkUI.Full
170   * @form
171   * @since 10
172   */
173  /**
174   * Init FormLink component with options.
175   *
176   * @param { FormLinkOptions } options
177   * @returns { FormLinkAttribute }
178   * @syscap SystemCapability.ArkUI.ArkUI.Full
179   * @form
180   * @atomicservice
181   * @since 11
182   */
183  (options: FormLinkOptions): FormLinkAttribute;
184}
185
186/**
187 * Defines the FormLink attribute.
188 *
189 * @extends CommonMethod<FormLinkAttribute>
190 * @syscap SystemCapability.ArkUI.ArkUI.Full
191 * @form
192 * @since 10
193 */
194/**
195 * Defines the FormLink attribute.
196 *
197 * @extends CommonMethod<FormLinkAttribute>
198 * @syscap SystemCapability.ArkUI.ArkUI.Full
199 * @form
200 * @atomicservice
201 * @since 11
202 */
203declare class FormLinkAttribute extends CommonMethod<FormLinkAttribute> {
204}
205
206/**
207 * Defines FormLink component.
208 *
209 * @syscap SystemCapability.ArkUI.ArkUI.Full
210 * @form
211 * @since 10
212 */
213/**
214 * Defines FormLink component.
215 *
216 * @syscap SystemCapability.ArkUI.ArkUI.Full
217 * @form
218 * @atomicservice
219 * @since 11
220 */
221declare const FormLink: FormLinkInterface;
222
223/**
224 * Defines FormLink component instance.
225 *
226 * @syscap SystemCapability.ArkUI.ArkUI.Full
227 * @form
228 * @since 10
229 */
230/**
231 * Defines FormLink component instance.
232 *
233 * @syscap SystemCapability.ArkUI.ArkUI.Full
234 * @form
235 * @atomicservice
236 * @since 11
237 */
238declare const FormLinkInstance: FormLinkAttribute;
239