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