• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024 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 Defines the fullScreen launch component
18 * @kit ArkUI
19 */
20
21import AtomicServiceOptions from '@ohos.app.ability.AtomicServiceOptions';
22import { Callback, ErrorCallback } from '@ohos.base';
23
24/**
25 * Declares the FullScreenLaunchComponent, a component provided by ArkUI that allows
26 * you to define and use it in your application through the ArkTS-based declarative
27 * development paradigm.
28 * @syscap SystemCapability.ArkUI.ArkUI.Full
29 * @atomicservice
30 * @since 12
31 */
32@Component
33export declare struct FullScreenLaunchComponent {
34  /**
35   * Sets the component content.
36   * @type { Callback<void> }
37   * @syscap SystemCapability.ArkUI.ArkUI.Full
38   * @atomicservice
39   * @since 12
40   */
41  @BuilderParam content: Callback<void>;
42  /**
43   * Indicates atomic service appId.
44   * @type { string }
45   * @syscap SystemCapability.ArkUI.ArkUI.Full
46   * @atomicservice
47   * @since 12
48   */
49  appId: string;
50  /**
51   * Indicates the atomic service start options.
52   * @type { ?AtomicServiceOptions }
53   * @syscap SystemCapability.ArkUI.ArkUI.Full
54   * @atomicservice
55   * @since 12
56   */
57  options?: AtomicServiceOptions;
58    /**
59    * Callback triggered when an error occurs during running of the started ExtensionAbility.
60    * It is supported only when the atomic service runs in embedded mode,
61    * with the parameter being of type BusinessError.
62    * @type { ?ErrorCallback }
63    * @syscap SystemCapability.ArkUI.ArkUI.Full
64    * @atomicservice
65    * @since 18
66    */
67    onError?: ErrorCallback;
68    /**
69    * Callback triggered when the EmbeddableUIAbility is terminated to receive the information
70    * about the termination. It is supported only when the atomic service runs in embedded mode,
71    * with the parameter being of type TerminationInfo.
72    * @type { ?Callback<TerminationInfo> }
73    * @syscap SystemCapability.ArkUI.ArkUI.Full
74    * @atomicservice
75    * @since 18
76    */
77    onTerminated?: Callback<TerminationInfo>;
78    /**
79    * Indicates the callback of onReceive.
80    * @type { ?Callback<Record<string, Object>> }
81    * @syscap SystemCapability.ArkUI.ArkUI.Full
82    * @atomicservice
83    * @since 20
84    */
85    onReceive?: Callback<Record<string, Object>>;
86}