• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-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/*** if arkts 1.2 */
22import {
23  Rectangle, AnimateParam, Callback, ShadowOptions, ShadowStyle, KeyboardAvoidMode, BlurStyle, HoverModeAreaType,
24  DismissReason, BackgroundBlurStyleOptions, BackgroundEffectOptions
25} from './common';
26import { CustomBuilder } from './builder';
27import { DialogAlignment } from './alertDialog';
28import { Offset, ResourceColor, Dimension, BorderRadiuses, EdgeWidths, EdgeColors, EdgeStyles } from './units';
29import { BorderStyle } from './enums';
30import { LengthMetrics } from '../Graphics';
31import { LevelMode, LevelOrder, ImmersiveMode } from '../../@ohos.promptAction';
32import { CustomBuilder } from './builder';
33/*** endif */
34
35/**
36 * Defines the options of CustomDialogController.
37 *
38 * @interface CustomDialogControllerOptions
39 * @syscap SystemCapability.ArkUI.ArkUI.Full
40 * @since 7
41 */
42/**
43 * Defines the options of CustomDialogController.
44 *
45 * @interface CustomDialogControllerOptions
46 * @syscap SystemCapability.ArkUI.ArkUI.Full
47 * @crossplatform
48 * @since 10
49 */
50/**
51 * Defines the options of CustomDialogController.
52 *
53 * @interface CustomDialogControllerOptions
54 * @syscap SystemCapability.ArkUI.ArkUI.Full
55 * @crossplatform
56 * @atomicservice
57 * @since arkts {'1.1':'11','1.2':'20'}
58 * @arkts 1.1&1.2
59 */
60declare interface CustomDialogControllerOptions {
61  /**
62   * Custom builder function.
63   *
64   * @type { any }
65   * @syscap SystemCapability.ArkUI.ArkUI.Full
66   * @since 7
67   */
68  /**
69   * Custom builder function.
70   *
71   * @type { any }
72   * @syscap SystemCapability.ArkUI.ArkUI.Full
73   * @crossplatform
74   * @since 10
75   */
76  /**
77   * Custom builder function.
78   *
79   * @type { any }
80   * @syscap SystemCapability.ArkUI.ArkUI.Full
81   * @crossplatform
82   * @atomicservice
83   * @since 11
84   */
85  builder: any;
86
87  /**
88   * Custom builder function.
89   *
90   * @type { CustomBuilder }
91   * @syscap SystemCapability.ArkUI.ArkUI.Full
92   * @crossplatform
93   * @atomicservice
94   * @since 20
95   * @arkts 1.2
96   */
97  builder: CustomBuilder;
98
99  /**
100   * Defines the cancel function.
101   *
102   * @type { ?function }
103   * @syscap SystemCapability.ArkUI.ArkUI.Full
104   * @since 7
105   */
106  /**
107   * Defines the cancel function.
108   *
109   * @type { ?function }
110   * @syscap SystemCapability.ArkUI.ArkUI.Full
111   * @crossplatform
112   * @since 10
113   */
114  /**
115   * Defines the cancel function.
116   *
117   * @type { ?function }
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @crossplatform
120   * @atomicservice
121   * @since arkts {'1.1':'11','1.2':'20'}
122   * @arkts 1.1&1.2
123   */
124  cancel?: () => void;
125
126  /**
127   * Defines if use auto cancel when click on the outside of the dialog.
128   *
129   * @type { ?boolean }
130   * @syscap SystemCapability.ArkUI.ArkUI.Full
131   * @since 7
132   */
133  /**
134   * Defines if use auto cancel when click on the outside of the dialog.
135   *
136   * @type { ?boolean }
137   * @syscap SystemCapability.ArkUI.ArkUI.Full
138   * @crossplatform
139   * @since 10
140   */
141  /**
142   * Defines if use auto cancel when click on the outside of the dialog.
143   *
144   * @type { ?boolean }
145   * @syscap SystemCapability.ArkUI.ArkUI.Full
146   * @crossplatform
147   * @atomicservice
148   * @since arkts {'1.1':'11','1.2':'20'}
149   * @arkts 1.1&1.2
150   */
151  autoCancel?: boolean;
152
153  /**
154   * Defines the dialog alignment of the screen.
155   *
156   * @type { ?DialogAlignment }
157   * @syscap SystemCapability.ArkUI.ArkUI.Full
158   * @since 7
159   */
160  /**
161   * Defines the dialog alignment of the screen.
162   *
163   * @type { ?DialogAlignment }
164   * @syscap SystemCapability.ArkUI.ArkUI.Full
165   * @crossplatform
166   * @since 10
167   */
168  /**
169   * Defines the dialog alignment of the screen.
170   *
171   * @type { ?DialogAlignment }
172   * @syscap SystemCapability.ArkUI.ArkUI.Full
173   * @crossplatform
174   * @atomicservice
175   * @since arkts {'1.1':'11','1.2':'20'}
176   * @arkts 1.1&1.2
177   */
178  alignment?: DialogAlignment;
179
180  /**
181   * Defines the dialog offset.
182   *
183   * @type { ?Offset }
184   * @syscap SystemCapability.ArkUI.ArkUI.Full
185   * @since 7
186   */
187  /**
188   * Defines the dialog offset.
189   *
190   * @type { ?Offset }
191   * @syscap SystemCapability.ArkUI.ArkUI.Full
192   * @crossplatform
193   * @since 10
194   */
195  /**
196   * Defines the dialog offset.
197   *
198   * @type { ?Offset }
199   * @syscap SystemCapability.ArkUI.ArkUI.Full
200   * @crossplatform
201   * @atomicservice
202   * @since arkts {'1.1':'11','1.2':'20'}
203   * @arkts 1.1&1.2
204   */
205  offset?: Offset;
206
207  /**
208   * Defines if use custom style.
209   *
210   * @type { ?boolean }
211   * @syscap SystemCapability.ArkUI.ArkUI.Full
212   * @since 7
213   */
214  /**
215   * Defines if use custom style.
216   *
217   * @type { ?boolean }
218   * @syscap SystemCapability.ArkUI.ArkUI.Full
219   * @crossplatform
220   * @since 10
221   */
222  /**
223   * Defines if use custom style.
224   *
225   * @type { ?boolean }
226   * @syscap SystemCapability.ArkUI.ArkUI.Full
227   * @crossplatform
228   * @atomicservice
229   * @since arkts {'1.1':'11','1.2':'20'}
230   * @arkts 1.1&1.2
231   */
232  customStyle?: boolean;
233
234  /**
235   * Grid count of dialog.
236   *
237   * @type { ?number }
238   * @syscap SystemCapability.ArkUI.ArkUI.Full
239   * @since 8
240   */
241  /**
242   * Grid count of dialog.
243   *
244   * @type { ?number }
245   * @syscap SystemCapability.ArkUI.ArkUI.Full
246   * @crossplatform
247   * @since 10
248   */
249  /**
250   * Grid count of dialog.
251   *
252   * @type { ?number }
253   * @syscap SystemCapability.ArkUI.ArkUI.Full
254   * @crossplatform
255   * @atomicservice
256   * @since arkts {'1.1':'11','1.2':'20'}
257   * @arkts 1.1&1.2
258   */
259  gridCount?: number;
260
261  /**
262   * Mask color of dialog.
263   *
264   * @type { ?ResourceColor }
265   * @syscap SystemCapability.ArkUI.ArkUI.Full
266   * @crossplatform
267   * @since 10
268   */
269  /**
270   * Mask color of dialog.
271   *
272   * @type { ?ResourceColor }
273   * @syscap SystemCapability.ArkUI.ArkUI.Full
274   * @crossplatform
275   * @atomicservice
276   * @since arkts {'1.1':'11','1.2':'20'}
277   * @arkts 1.1&1.2
278   */
279  maskColor?: ResourceColor;
280
281  /**
282   * Mask Region of dialog. The size cannot exceed the main window.
283   *
284   * @type { ?Rectangle }
285   * @syscap SystemCapability.ArkUI.ArkUI.Full
286   * @crossplatform
287   * @since 10
288   */
289  /**
290   * Mask Region of dialog. The size cannot exceed the main window.
291   *
292   * @type { ?Rectangle }
293   * @syscap SystemCapability.ArkUI.ArkUI.Full
294   * @crossplatform
295   * @atomicservice
296   * @since arkts {'1.1':'11','1.2':'20'}
297   * @arkts 1.1&1.2
298   */
299  maskRect?: Rectangle;
300
301  /**
302   * Animation parameters of dialog opening.
303   *
304   * @type { ?AnimateParam }
305   * @syscap SystemCapability.ArkUI.ArkUI.Full
306   * @crossplatform
307   * @since 10
308   */
309  /**
310   * Animation parameters of dialog opening.
311   *
312   * @type { ?AnimateParam }
313   * @syscap SystemCapability.ArkUI.ArkUI.Full
314   * @crossplatform
315   * @atomicservice
316   * @since arkts {'1.1':'11','1.2':'20'}
317   * @arkts 1.1&1.2
318   */
319  openAnimation?: AnimateParam;
320
321  /**
322   * Animation parameters of dialog closing.
323   *
324   * @type { ?AnimateParam }
325   * @syscap SystemCapability.ArkUI.ArkUI.Full
326   * @crossplatform
327   * @since 10
328   */
329  /**
330   * Animation parameters of dialog closing.
331   *
332   * @type { ?AnimateParam }
333   * @syscap SystemCapability.ArkUI.ArkUI.Full
334   * @crossplatform
335   * @atomicservice
336   * @since arkts {'1.1':'11','1.2':'20'}
337   * @arkts 1.1&1.2
338   */
339  closeAnimation?: AnimateParam;
340
341  /**
342   * Whether to display in the sub window.
343   *
344   * @type { ?boolean }
345   * @syscap SystemCapability.ArkUI.ArkUI.Full
346   * @crossplatform
347   * @since 10
348   */
349  /**
350   * Whether to display in the sub window.
351   *
352   * @type { ?boolean }
353   * @default false
354   * @syscap SystemCapability.ArkUI.ArkUI.Full
355   * @crossplatform
356   * @atomicservice
357   * @since arkts {'1.1':'11','1.2':'20'}
358   * @arkts 1.1&1.2
359   */
360  showInSubWindow?: boolean;
361
362  /**
363   * Background color of dialog.
364   *
365   * @type { ?ResourceColor }
366   * @syscap SystemCapability.ArkUI.ArkUI.Full
367   * @crossplatform
368   * @since 10
369   */
370  /**
371   * Background color of dialog.
372   *
373   * @type { ?ResourceColor }
374   * @syscap SystemCapability.ArkUI.ArkUI.Full
375   * @crossplatform
376   * @atomicservice
377   * @since arkts {'1.1':'11','1.2':'20'}
378   * @arkts 1.1&1.2
379   */
380  backgroundColor?: ResourceColor;
381
382  /**
383   * Corner radius of dialog.
384   *
385   * @type { ?(Dimension | BorderRadiuses) }
386   * @syscap SystemCapability.ArkUI.ArkUI.Full
387   * @crossplatform
388   * @since 10
389   */
390  /**
391   * Corner radius of dialog.
392   *
393   * @type { ?(Dimension | BorderRadiuses) }
394   * @syscap SystemCapability.ArkUI.ArkUI.Full
395   * @crossplatform
396   * @atomicservice
397   * @since arkts {'1.1':'11','1.2':'20'}
398   * @arkts 1.1&1.2
399   */
400  cornerRadius?: Dimension | BorderRadiuses;
401
402  /**
403   * Whether it is a modal dialog
404   * @type { ?boolean }
405   * @default true
406   * @syscap SystemCapability.ArkUI.ArkUI.Full
407   * @crossplatform
408   * @since 11
409   */
410  /**
411   * Whether it is a modal dialog
412   * @type { ?boolean }
413   * @default true
414   * @syscap SystemCapability.ArkUI.ArkUI.Full
415   * @crossplatform
416   * @atomicservice
417   * @since arkts {'1.1':'12','1.2':'20'}
418   * @arkts 1.1&1.2
419   */
420  isModal?: boolean;
421
422  /**
423   * Callback function when the CustomDialog interactive dismiss.
424   *
425   * @type { ?Callback<DismissDialogAction> }
426   * @syscap SystemCapability.ArkUI.ArkUI.Full
427   * @crossplatform
428   * @atomicservice
429   * @since arkts {'1.1':'12','1.2':'20'}
430   * @arkts 1.1&1.2
431   */
432  onWillDismiss?: Callback<DismissDialogAction>;
433
434  /**
435   * Defines the custom dialog's width.
436   *
437   * @type { ?Dimension }
438   * @syscap SystemCapability.ArkUI.ArkUI.Full
439   * @crossplatform
440   * @atomicservice
441   * @since arkts {'1.1':'12','1.2':'20'}
442   * @arkts 1.1&1.2
443   */
444  width?: Dimension;
445
446  /**
447   * Defines the custom dialog's height.
448   *
449   * @type { ?Dimension }
450   * @syscap SystemCapability.ArkUI.ArkUI.Full
451   * @crossplatform
452   * @atomicservice
453   * @since arkts {'1.1':'12','1.2':'20'}
454   * @arkts 1.1&1.2
455   */
456  height?: Dimension;
457
458  /**
459   * Defines the custom dialog's border width.
460   *
461   * @type { ?(Dimension | EdgeWidths) }
462   * @syscap SystemCapability.ArkUI.ArkUI.Full
463   * @crossplatform
464   * @atomicservice
465   * @since arkts {'1.1':'12','1.2':'20'}
466   * @arkts 1.1&1.2
467   */
468  borderWidth?: Dimension | EdgeWidths;
469
470  /**
471   * Defines the custom dialog's border color.
472   *
473   * @type { ?(ResourceColor | EdgeColors) }
474   * @syscap SystemCapability.ArkUI.ArkUI.Full
475   * @crossplatform
476   * @atomicservice
477   * @since arkts {'1.1':'12','1.2':'20'}
478   * @arkts 1.1&1.2
479   */
480  borderColor?: ResourceColor | EdgeColors;
481
482  /**
483   * Defines the custom dialog's border style.
484   *
485   * @type { ?(BorderStyle | EdgeStyles) }
486   * @syscap SystemCapability.ArkUI.ArkUI.Full
487   * @crossplatform
488   * @atomicservice
489   * @since arkts {'1.1':'12','1.2':'20'}
490   * @arkts 1.1&1.2
491   */
492  borderStyle?: BorderStyle | EdgeStyles;
493
494  /**
495   * Defines the custom dialog's shadow.
496   *
497   * @type { ?(ShadowOptions | ShadowStyle) }
498   * @syscap SystemCapability.ArkUI.ArkUI.Full
499   * @crossplatform
500   * @atomicservice
501   * @since arkts {'1.1':'12','1.2':'20'}
502   * @arkts 1.1&1.2
503   */
504  shadow?: ShadowOptions | ShadowStyle;
505
506  /**
507   * Defines the customDialog's background blur Style
508   *
509   * @type { ?BlurStyle }
510   * @default BlurStyle.COMPONENT_ULTRA_THICK
511   * @syscap SystemCapability.ArkUI.ArkUI.Full
512   * @crossplatform
513   * @atomicservice
514   * @since arkts {'1.1':'12','1.2':'20'}
515   * @arkts 1.1&1.2
516   */
517  backgroundBlurStyle?: BlurStyle;
518
519  /**
520   * Defines the customDialog's background blur style with options
521   *
522   * @type { ?BackgroundBlurStyleOptions }
523   * @syscap SystemCapability.ArkUI.ArkUI.Full
524   * @crossplatform
525   * @atomicservice
526   * @since arkts {'1.1':'19','1.2':'20'}
527   * @arkts 1.1&1.2
528   */
529  backgroundBlurStyleOptions?: BackgroundBlurStyleOptions;
530
531  /**
532   * Defines the customDialog's background effect with options
533   *
534   * @type { ?BackgroundEffectOptions }
535   * @syscap SystemCapability.ArkUI.ArkUI.Full
536   * @crossplatform
537   * @atomicservice
538   * @since arkts {'1.1':'19','1.2':'20'}
539   * @arkts 1.1&1.2
540   */
541  backgroundEffect?: BackgroundEffectOptions;
542
543  /**
544   * Defines the customDialog's keyboard avoid mode
545   *
546   * @type { ?KeyboardAvoidMode }
547   * @default KeyboardAvoidMode.DEFAULT
548   * @syscap SystemCapability.ArkUI.ArkUI.Full
549   * @crossplatform
550   * @atomicservice
551   * @since arkts {'1.1':'12','1.2':'20'}
552   * @arkts 1.1&1.2
553   */
554  keyboardAvoidMode?: KeyboardAvoidMode;
555
556  /**
557   * Defines whether to respond to the hover mode.
558   *
559   * @type { ?boolean }
560   * @default false
561   * @syscap SystemCapability.ArkUI.ArkUI.Full
562   * @crossplatform
563   * @atomicservice
564   * @since arkts {'1.1':'14','1.2':'20'}
565   * @arkts 1.1&1.2
566   */
567  enableHoverMode?: boolean;
568
569  /**
570   * Defines the customDialog's display area in hover mode.
571   *
572   * @type { ?HoverModeAreaType }
573   * @default HoverModeAreaType.BOTTOM_SCREEN
574   * @syscap SystemCapability.ArkUI.ArkUI.Full
575   * @crossplatform
576   * @atomicservice
577   * @since arkts {'1.1':'14','1.2':'20'}
578   * @arkts 1.1&1.2
579   */
580  hoverModeArea?: HoverModeAreaType;
581
582  /**
583   * Callback function when the dialog appears.
584   *
585   * @type { ?Callback<void> }
586   * @syscap SystemCapability.ArkUI.ArkUI.Full
587   * @crossplatform
588   * @atomicservice
589   * @since arkts {'1.1':'19','1.2':'20'}
590   * @arkts 1.1&1.2
591   */
592  onDidAppear?: Callback<void>;
593
594  /**
595   * Callback function when the dialog disappears.
596   *
597   * @type { ?Callback<void> }
598   * @syscap SystemCapability.ArkUI.ArkUI.Full
599   * @crossplatform
600   * @atomicservice
601   * @since arkts {'1.1':'19','1.2':'20'}
602   * @arkts 1.1&1.2
603   */
604  onDidDisappear?: Callback<void>;
605
606  /**
607   * Callback function before the dialog openAnimation starts.
608   *
609   * @type { ?Callback<void> }
610   * @syscap SystemCapability.ArkUI.ArkUI.Full
611   * @crossplatform
612   * @atomicservice
613   * @since arkts {'1.1':'19','1.2':'20'}
614   * @arkts 1.1&1.2
615   */
616  onWillAppear?: Callback<void>;
617
618  /**
619   * Callback function before the dialog closeAnimation starts.
620   *
621   * @type { ?Callback<void> }
622   * @syscap SystemCapability.ArkUI.ArkUI.Full
623   * @crossplatform
624   * @atomicservice
625   * @since arkts {'1.1':'19','1.2':'20'}
626   * @arkts 1.1&1.2
627   */
628  onWillDisappear?: Callback<void>;
629
630  /**
631   * Defines the distance between the customDialog and system keyboard.
632   *
633   * @type { ?LengthMetrics }
634   * @syscap SystemCapability.ArkUI.ArkUI.Full
635   * @crossplatform
636   * @atomicservice
637   * @since arkts {'1.1':'15','1.2':'20'}
638   * @arkts 1.1&1.2
639   */
640  keyboardAvoidDistance?: LengthMetrics;
641
642  /**
643   * Determine the display level of the dialog.
644   *
645   * @type { ?LevelMode }
646   * @default LevelMode.OVERLAY
647   * @syscap SystemCapability.ArkUI.ArkUI.Full
648   * @crossplatform
649   * @atomicservice
650   * @since arkts {'1.1':'15','1.2':'20'}
651   * @arkts 1.1&1.2
652   */
653  levelMode?: LevelMode;
654
655  /**
656   * The uniqueId of any node in the router or navigation page.
657   *
658   * @type { ?number }
659   * @syscap SystemCapability.ArkUI.ArkUI.Full
660   * @crossplatform
661   * @atomicservice
662   * @since arkts {'1.1':'15','1.2':'20'}
663   * @arkts 1.1&1.2
664   */
665  levelUniqueId?: number;
666
667  /**
668   * Determine the immersive mode of the dialog.
669   *
670   * @type { ?ImmersiveMode }
671   * @default ImmersiveMode.DEFAULT
672   * @syscap SystemCapability.ArkUI.ArkUI.Full
673   * @crossplatform
674   * @atomicservice
675   * @since arkts {'1.1':'15','1.2':'20'}
676   * @arkts 1.1&1.2
677   */
678  immersiveMode?: ImmersiveMode;
679
680  /**
681   * Determine the display order of the dialog.
682   *
683   * @type { ?LevelOrder }
684   * @default The value returns by LevelOrder.clamp(0)
685   * @syscap SystemCapability.ArkUI.ArkUI.Full
686   * @crossplatform
687   * @atomicservice
688   * @since arkts {'1.1':'18','1.2':'20'}
689   * @arkts 1.1&1.2
690   */
691  levelOrder?: LevelOrder;
692
693  /**
694   * Specifies whether to get focus when the custom dialog is displayed.
695   *
696   * @type { ?boolean }
697   * @default true
698   * @syscap SystemCapability.ArkUI.ArkUI.Full
699   * @crossplatform
700   * @atomicservice
701   * @since arkts {'1.1':'19','1.2':'20'}
702   * @arkts 1.1&1.2
703   */
704  focusable?: boolean;
705}
706
707/**
708 * Component dialog dismiss action.
709 *
710 * @interface DismissDialogAction
711 * @syscap SystemCapability.ArkUI.ArkUI.Full
712 * @crossplatform
713 * @atomicservice
714 * @since arkts {'1.1':'12','1.2':'20'}
715 * @arkts 1.1&1.2
716 */
717declare interface DismissDialogAction {
718  /**
719   * Defines dialog dismiss function
720   *
721   * @type { Callback<void> }
722   * @syscap SystemCapability.ArkUI.ArkUI.Full
723   * @crossplatform
724   * @atomicservice
725   * @since arkts {'1.1':'12','1.2':'20'}
726   * @arkts 1.1&1.2
727   */
728  dismiss: Callback<void>;
729
730  /**
731   * Dismiss reason type.
732   *
733   * @type { DismissReason }
734   * @syscap SystemCapability.ArkUI.ArkUI.Full
735   * @crossplatform
736   * @atomicservice
737   * @since arkts {'1.1':'12','1.2':'20'}
738   * @arkts 1.1&1.2
739   */
740  reason: DismissReason;
741}
742
743/**
744 * Import the CommonState type from promptAction.
745 *
746 * @typedef { import('../api/@ohos.promptAction').promptAction.CommonState } PromptActionCommonState
747 * @syscap SystemCapability.ArkUI.ArkUI.Full
748 * @atomicservice
749 * @since 20
750 */
751declare type PromptActionCommonState = import('../api/@ohos.promptAction').promptAction.CommonState;
752
753/**
754 * Use the CustomDialogController class to display the custom pop-up window.
755 *
756 * @syscap SystemCapability.ArkUI.ArkUI.Full
757 * @since 7
758 */
759/**
760 * Use the CustomDialogController class to display the custom pop-up window.
761 *
762 * @syscap SystemCapability.ArkUI.ArkUI.Full
763 * @crossplatform
764 * @since 10
765 */
766/**
767 * Use the CustomDialogController class to display the custom pop-up window.
768 *
769 * @syscap SystemCapability.ArkUI.ArkUI.Full
770 * @crossplatform
771 * @atomicservice
772 * @since arkts {'1.1':'11','1.2':'20'}
773 * @arkts 1.1&1.2
774 */
775declare class CustomDialogController {
776  /**
777   * The constructor transfers parameter settings.
778   *
779   * @param { CustomDialogControllerOptions } value
780   * @syscap SystemCapability.ArkUI.ArkUI.Full
781   * @since 7
782   */
783  /**
784   * The constructor transfers parameter settings.
785   *
786   * @param { CustomDialogControllerOptions } value
787   * @syscap SystemCapability.ArkUI.ArkUI.Full
788   * @crossplatform
789   * @since 10
790   */
791  /**
792   * The constructor transfers parameter settings.
793   *
794   * @param { CustomDialogControllerOptions } value
795   * @syscap SystemCapability.ArkUI.ArkUI.Full
796   * @crossplatform
797   * @atomicservice
798   * @since arkts {'1.1':'11','1.2':'20'}
799   * @arkts 1.1&1.2
800   */
801  constructor(value: CustomDialogControllerOptions);
802
803  /**
804   * Display the content of the customized pop-up window. If the content has been displayed, it does not take effect.
805   *
806   * @syscap SystemCapability.ArkUI.ArkUI.Full
807   * @since 7
808   */
809  /**
810   * Display the content of the customized pop-up window. If the content has been displayed, it does not take effect.
811   *
812   * @syscap SystemCapability.ArkUI.ArkUI.Full
813   * @crossplatform
814   * @since 10
815   */
816  /**
817   * Display the content of the customized pop-up window. If the content has been displayed, it does not take effect.
818   *
819   * @syscap SystemCapability.ArkUI.ArkUI.Full
820   * @crossplatform
821   * @atomicservice
822   * @since 11
823   */
824  open();
825
826  /**
827   * Display the content of the customized pop-up window. If the content has been displayed, it does not take effect.
828   *
829   * @syscap SystemCapability.ArkUI.ArkUI.Full
830   * @crossplatform
831   * @atomicservice
832   * @since 20
833   * @arkts 1.2
834   */
835  open(): void;
836
837  /**
838   * Closes the custom pop-up window. If the window is closed, the window does not take effect.
839   *
840   * @syscap SystemCapability.ArkUI.ArkUI.Full
841   * @since 7
842   */
843  /**
844   * Closes the custom pop-up window. If the window is closed, the window does not take effect.
845   *
846   * @syscap SystemCapability.ArkUI.ArkUI.Full
847   * @crossplatform
848   * @since 10
849   */
850  /**
851   * Closes the custom pop-up window. If the window is closed, the window does not take effect.
852   *
853   * @syscap SystemCapability.ArkUI.ArkUI.Full
854   * @crossplatform
855   * @atomicservice
856   * @since 11
857   */
858  close();
859
860  /**
861   * Closes the custom pop-up window. If the window is closed, the window does not take effect.
862   *
863   * @syscap SystemCapability.ArkUI.ArkUI.Full
864   * @crossplatform
865   * @atomicservice
866   * @since 20
867   * @arkts 1.2
868   */
869  close(): void;
870
871  /**
872   * Get the state of the custom pop-up window.
873   *
874   * @returns { PromptActionCommonState } return the state of dialog.
875   * @syscap SystemCapability.ArkUI.ArkUI.Full
876   * @crossplatform
877   * @atomicservice
878   * @since 20
879   */
880  getState(): PromptActionCommonState;
881}
882