HarmonyOS Kit

« 返回索引

HarmonyOS Kit

目录:

场景自适应(AdaptiveExperience)

场景自适应组件 - 鸿蒙场景感知助手,用于响应式布局、导航和流程设计。 鸿蒙独有组件,根据设备场景给出推荐列数、导航模式和场景档位。

使用指导读取当前场景、选择响应式文字的完整案例与运行前提查看 →

属性

当前设备类型(CurrentDeviceType)
系统识别到的当前鸿蒙设备类型。
推荐列数(RecommendedColumns)
当前场景推荐的网格列数。
推荐导航(RecommendedNavigation)
当前场景推荐的导航模式。
场景档位(SceneProfile)
当前场景档位:compact、medium 或 expanded。

事件

场景变化时(SceneChanged)(场景JSON)
刷新后场景档位发生变化时触发。

方法

构建响应式值(BuildResponsiveValue)(紧凑值,中等值,展开值)
根据场景档位,在 compact、medium、expanded 三组值中选择结果。
获取推荐列数(GetRecommendedColumns)()
获取当前场景推荐的网格列数。
获取推荐导航(GetRecommendedNavigation)()
获取当前场景推荐的导航模式。
获取场景JSON(GetSceneJson)()
以 JSON 形式获取完整的当前场景快照。
获取场景档位(GetSceneProfile)()
获取当前场景档位。
刷新场景(RefreshScene)()
刷新当前场景快照,并在变化时触发 SceneChanged。

鸿蒙桥接(HarmonyBridge)

鸿蒙桥接组件 - Want 桥接,用于原子服务、服务卡片和无缝流转入口。 鸿蒙独有组件,可构建 Want 快照并直接启动目标 Ability。

使用指导构建目标 Want、启动已安装 Ability的完整案例与运行前提查看 →

属性

默认Ability(DefaultAbilityName)
准备或启动桥接 Want 时默认使用的目标 Ability 名称。
默认包名(DefaultBundleName)
准备或启动桥接 Want 时默认使用的目标包名。
最近错误(LastError)
最近一次启动失败的错误信息。
最近Want JSON(LastWantJson)
最近一次准备或启动的 Want 快照 JSON。

事件

启动失败时(LaunchFailed)(种类,消息)
桥接组件无法启动 Want 时触发。
启动成功时(LaunchSucceeded)(种类,启动请求JSON)
startAbility 调用成功后触发。
Want已准备时(WantPrepared)(种类,启动请求JSON)
组件完成 Want 快照准备后触发。

方法

获取最近错误(GetLastError)()
获取最近一次启动失败的错误信息。
获取最近Want JSON(GetLastWantJson)()
获取最近一次准备或启动的 Want 快照 JSON。
启动Ability(LaunchAbility)(包名,能力名,参数JSON)
使用给定的包名、Ability 名称和参数 JSON 立即启动目标 Ability。
启动Want JSON(LaunchWantJson)(启动请求JSON)
启动之前准备好的 Want 快照 JSON。
准备原子服务Want(PrepareAtomicServiceWant)(包名,能力名,入口路径,数据JSON)
构建适用于原子服务轻入口场景的 Want 快照。
准备卡片Want(PrepareCardWant)(卡片ID,路由名,数据JSON)
构建适用于卡片点击跳转和卡片恢复场景的 Want 快照。
准备流转Want(PrepareContinuationWant)(目标设备类型,能力名,数据JSON)
构建适用于流转和多设备接续场景的 Want 快照。

鸿蒙流转(HarmonyFlow)

鸿蒙流转组件 - 流转载荷构建,用于原子服务路由、服务卡片和跨设备流转。 鸿蒙独有组件,支持状态缓存、状态包导入导出以及流转命令构建。

使用指导保存页面状态包、恢复状态包的完整案例与运行前提查看 →

属性

最近载荷(LastPayload)
最近一次生成的鸿蒙流转载荷 JSON。
状态数量(StateSize)
当前流转状态中已缓存的键数量。

事件

载荷已生成时(FlowPayloadBuilt)(种类,数据JSON)
每次生成新的载荷封装时触发。
状态包已导入时(StatePacketImported)(数据包JSON)
导入鸿蒙状态包后触发。

方法

构建原子服务载荷(BuildAtomicServicePayload)(服务ID,入口路径,参数JSON)
构建用于启动或恢复原子服务的路由载荷。
构建卡片模型(BuildCardModel)(卡片ID,标题,副标题,路由名)
基于当前状态构建服务卡片模型。
构建流转命令(BuildContinuationCommand)(目标设备类型,能力名,数据包JSON)
构建跨设备流转命令封装。
清空状态(ClearState)()
清空当前缓存的全部流转状态。
导出状态包(ExportStatePacket)(流转名称,路由名)
将当前流转状态导出为可携带的鸿蒙状态包。
获取最近载荷(GetLastPayload)()
获取最近一次生成的载荷。
获取状态值(GetStateValue)(键)
按键名读取一项流转状态值。
导入状态包(ImportStatePacket)(数据包JSON)
导入之前导出的鸿蒙状态包。
删除状态值(RemoveStateValue)(键)
按键名删除已保存的状态值。
设置状态值(SetStateValue)(键,值)
按键名保存一项流转状态值。

发布包构建(HarmonyLaunchKit)

启动包组件 - 鸿蒙原子服务/卡片/流转一体化启动包构建。 鸿蒙独有组件,把模板、主题、Want 入口打包成单个可分发的启动包 JSON。

使用指导构建原子服务启动包、构建设备控制启动包的完整案例与运行前提查看 →

属性

最近发布包JSON(LastPackageJson)
最近一次生成的启动包 JSON。

事件

发布包已生成时(LaunchPackageBuilt)(种类,包信息JSON)
生成启动包后触发。

方法

构建原子入口发布包(BuildAtomicLaunchPackage)(场景档案,标题,服务ID,包名,能力名,入口路径,强调色文本,参数JSON)
构建原子服务启动包 JSON。
构建流转发布包(BuildContinuationLaunchPackage)(场景档案,标题,目标设备类型,包名,能力名,强调色文本,数据包JSON,路由名)
构建跨设备流转启动包 JSON。
构建设备控制发布包(BuildDeviceControlLaunchPackage)(场景档案,标题,路由名,包名,能力名,强调色文本,设备状态JSON)
构建设备控制启动包 JSON。
构建服务中心发布包(BuildServiceCenterLaunchPackage)(场景档案,标题,路由名,包名,能力名,强调色文本,卡片ID)
构建服务中心启动包 JSON。
获取最近发布包JSON(GetLastPackageJson)()
获取最近一次生成的启动包 JSON。

场景模板(HarmonyScenarioKit)

场景模板组件 - 鸿蒙场景模板构建,用于服务中心、设备控制台和流转工作区。 鸿蒙独有组件,可生成适配不同场景的页面模板 JSON。

使用指导构建设备控制模板、构建服务中心模板的完整案例与运行前提查看 →

属性

最近模板JSON(LastTemplateJson)
最近一次生成的场景模板 JSON。

事件

模板已生成时(TemplateBuilt)(种类,模板JSON)
生成场景模板后触发。

方法

构建原子落地页模板(BuildAtomicLandingTemplate)(场景档案,标题,原子化服务数据JSON,启动Want JSON)
构建原子服务落地场景的页面模板 JSON。
构建流转工作区模板(BuildContinuationWorkspaceTemplate)(场景档案,标题,接续数据JSON,启动Want JSON)
构建流转工作区场景的页面模板 JSON。
构建设备控制模板(BuildDeviceControlTemplate)(场景档案,标题,设备状态JSON,启动Want JSON)
构建设备控制台场景的页面模板 JSON。
构建服务中心模板(BuildServiceCenterTemplate)(场景档案,标题,流转数据JSON,启动Want JSON)
构建服务中心场景的页面模板 JSON。
获取最近模板JSON(GetLastTemplateJson)()
获取最近一次生成的场景模板 JSON。

场景样式(HarmonyStyleKit)

主题样式组件 - 鸿蒙场景主题构建与应用。 鸿蒙独有组件,根据场景档位生成主题 JSON,并可应用到模板或当前屏幕。

使用指导生成自适应主题、应用主题到当前表单的完整案例与运行前提查看 →

属性

最近应用数量(LastAppliedCount)
最近一次主题应用所影响的组件数量。
最近主题JSON(LastThemeJson)
最近一次生成的主题 JSON。

事件

主题已应用时(ThemeApplied)(根组件名,组件数量)
主题应用完成后触发。
主题应用失败时(ThemeApplyFailed)(消息)
主题应用失败时触发。
主题已生成时(ThemeBuilt)(风格,主题JSON)
生成主题后触发。

方法

应用主题到表单(ApplyThemeToForm)(主题JSON)
将主题应用到当前屏幕。
应用主题到模板(ApplyThemeToTemplate)(根组件名,模板JSON,主题JSON)
将主题应用到模板落地生成的布局上。
构建场景主题(BuildSceneTheme)(场景档案,风格,强调色文本)
根据场景档位、风格和强调色构建主题 JSON。
获取最近应用数量(GetLastAppliedCount)()
获取最近一次主题应用所影响的组件数量。
获取最近主题JSON(GetLastThemeJson)()
获取最近一次生成的主题 JSON。

模板落地(HarmonyTemplateRenderer)

模板落地组件 - 鸿蒙模板落地,可将场景模板展开为运行时布局骨架。 鸿蒙独有组件,便于在积木应用中继续补充组件和逻辑。

使用指导渲染一个现有模板、生成模板再渲染的完整案例与运行前提查看 →

属性

最近组件数量(LastComponentCount)
最近一次模板落地生成的组件数量。
最近根布局名称(LastRootName)
最近一次生成的根布局名称。

事件

模板落地失败时(TemplateMaterializeFailed)(消息)
模板无法落地生成时触发。
模板已落地时(TemplateMaterialized)(根组件名,组件数量)
模板展开为运行时组件后触发。

方法

获取最近组件数量(GetLastComponentCount)()
获取最近一次生成的组件数量。
获取最近根布局名(GetLastRootName)()
获取最近一次生成的根布局名称。
模板落地(MaterializeTemplate)(容器名,模板JSON,名称前缀)
将鸿蒙场景模板展开为目标容器下的布局骨架。

工作区编排(HarmonyWorkspaceKit)

工作区组件 - 鸿蒙一站式工作区编排(模板 + 主题 + 落地)。 鸿蒙独有组件,一次调用即可生成场景模板、应用主题并落地为运行时布局。

使用指导一键搭建设备工作区、搭建服务工作区并检查结果的完整案例与运行前提查看 →

属性

最近组件数量(LastComponentCount)
最近一次工作区落地生成的组件数量。
最近根布局名称(LastRootName)
最近一次生成的根布局名称。
最近模板JSON(LastTemplateJson)
最近一次生成的场景模板 JSON。
最近主题JSON(LastThemeJson)
最近一次生成的主题 JSON。

事件

工作区编排失败时(WorkspaceComposeFailed)(种类,消息)
工作区编排失败时触发。
工作区已编排时(WorkspaceComposed)(种类,根组件名,组件数量)
工作区编排完成后触发。

方法

编排原子入口工作区(ComposeAtomicLandingWorkspace)(容器名,场景档案,标题,原子化服务数据JSON,启动Want JSON,强调色文本,名称前缀)
一站式编排原子服务落地工作区(模板+主题+落地)。
编排流转工作区(ComposeContinuationWorkspace)(容器名,场景档案,标题,接续数据JSON,启动Want JSON,强调色文本,名称前缀)
一站式编排流转工作区(模板+主题+落地)。
编排设备控制工作区(ComposeDeviceControlWorkspace)(容器名,场景档案,标题,设备状态JSON,启动Want JSON,强调色文本,名称前缀)
一站式编排设备控制台工作区(模板+主题+落地)。
编排服务中心工作区(ComposeServiceCenterWorkspace)(容器名,场景档案,标题,流转数据JSON,启动Want JSON,强调色文本,名称前缀)
一站式编排服务中心工作区(模板+主题+落地)。
获取最近组件数量(GetLastComponentCount)()
获取最近一次工作区落地生成的组件数量。
获取最近根布局名(GetLastRootName)()
获取最近一次生成的根布局名称。
获取最近模板JSON(GetLastTemplateJson)()
获取最近一次生成的场景模板 JSON。
获取最近主题JSON(GetLastThemeJson)()
获取最近一次生成的主题 JSON。
文档反馈