• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# FullScreenLaunchComponent
2
3
4全屏启动原子化服务组件，当被拉起方授权使用方可以嵌入式运行原子化服务时，使用方全屏嵌入式运行原子化服务；未授权时，使用方跳出式拉起原子化服务。
5
6
7> **说明：**
8>
9> 该组件从API Version 12开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
10>
11> 该组件不支持在Wearable设备上使用。
12>
13> 如果需要在该组件中实现一个可嵌入式运行的原子化服务时，必须继承自[EmbeddableUIAbility](../../apis-ability-kit/js-apis-app-ability-embeddableUIAbility.md)。若不继承自EmbeddableUIAbility，系统无法保证原子化服务功能正常。
14
15
16## 导入模块
17
18```ts
19import { FullScreenLaunchComponent } from '@kit.ArkUI'
20```
21
22
23## 子组件
24
25无
26
27## 属性
28不支持[通用属性](ts-component-general-attributes.md)。
29
30## 事件
31不支持[通用事件](ts-component-general-events.md)。
32
33## FullScreenLaunchComponent
34
35FullScreenLaunchComponent({ content: Callback\<void>, appId: string, options?: AtomicServiceOptions, onError?: ErrorCallback, onTerminated?: Callback\<TerminationInfo> })
36
37**装饰器类型：**\@Component
38
39**系统能力：** SystemCapability.ArkUI.ArkUI.Full
40
41| 名称 | 类型 | 必填 | 装饰器类型 | 说明 |
42| -------- | -------- | -------- | -------- | -------- |
43| content | Callback\<void> | 是 | \@BuilderParam | 可以使用组件组合来自定义拉起原子化服务前的占位图标，实现类似大桌面应用图标的效果。点击占位组件后，将拉起原子化服务。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。|
44| appId | string | 是 | - |  需要拉起的原子化服务appId，appId是原子化服务的唯一标识。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。<!--RP1--><!--RP1End-->|
45| options | [AtomicServiceOptions](../../apis-ability-kit/js-apis-app-ability-atomicServiceOptions.md) | 否 | - | 拉起原子化服务参数。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
46| onError<sup>18+<sup> | [ErrorCallback](../../apis-basic-services-kit/js-apis-base.md#errorcallback) | 否 | - | 被拉起的嵌入式运行原子化服务在运行过程中发生异常时触发本回调。可通过回调参数中的code、name和message获取错误信息并做处理。<br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 |
47| onTerminated<sup>18+<sup> | [Callback](../../apis-basic-services-kit/js-apis-base.md#callback)\<[TerminationInfo](ts-container-embedded-component.md#terminationinfo)> | 否 | - | 被拉起的嵌入式运行原子化服务通过调用[terminateSelfWithResult](../../apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult)或者[terminateSelf](../../apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateself)正常退出时，触发本回调函数。<br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 |
48
49> **说明：**
50>
51> - 若原子化服务通过调用[terminateSelfWithResult](../../apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult)退出，其携带的信息会传给回调函数的入参；
52> - 若原子化服务通过调用[terminateSelf](../../apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateself)退出，上述回调函数的入参中，"code"取默认值"0"，"want"为"undefined"。
53
54## 示例
55
56```ts
57import { FullScreenLaunchComponent } from '@kit.ArkUI';
58
59@Entry
60@Component
61struct Index {
62  @State appId: string = '6918661953712445909'; // 原子化服务appId
63
64  build() {
65    Row() {
66      Column() {
67        FullScreenLaunchComponent({
68          content: ColumChild,
69          appId: this.appId,
70          options: {},
71          onTerminated: (info) => {
72            console.info("onTerminated code: " + info.code.toString());
73          },
74          onError: (err) => {
75            console.error("onError code: " + err.code + ", message: ", err.message);
76          }
77        }).width("80vp").height("80vp")
78      }
79      .width('100%')
80    }
81    .height('100%')
82  }
83}
84
85@Builder
86function ColumChild() {
87  Column() {
88    Image($r('app.media.icon'))
89    Text('test')
90  }
91}
92```