1# @ohos.app.ability.common (Ability公共模块) 2 3<!--Kit: Ability Kit--> 4<!--Subsystem: Ability--> 5<!--Owner: @zexin_c--> 6<!--Designer: @li-weifeng2--> 7<!--Tester: @lixueqing513--> 8<!--Adviser: @huipeizi--> 9 10本模块提供Ability Kit中常用公共能力的纯类型定义，包含各类上下文对象、回调接口和数据结构。本模块仅导出类型声明，不包含具体实现逻辑或可执行代码。 11 12> **说明：** 13> 14> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 15 16## 导入模块 17 18```ts 19import { common } from '@kit.AbilityKit'; 20``` 21 22## UIAbilityContext 23 24type UIAbilityContext = _UIAbilityContext.default 25 26[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)组件上下文，继承自Context。 27 28**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 29 30**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 31 32**模型约束**：此接口仅可在Stage模型下使用。 33 34| 类型 | 说明 | 35| --- | --- | 36| [_UIAbilityContext.default](js-apis-inner-application-uiAbilityContext.md) | UIAbilityContext组件上下文。 | 37 38## AbilityStageContext 39 40type AbilityStageContext = _AbilityStageContext.default 41 42[AbilityStage](../apis-ability-kit/js-apis-app-ability-abilityStage.md)组件上下文，继承自Context。 43 44**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 45 46**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 47 48**模型约束**：此接口仅可在Stage模型下使用。 49 50| 类型 | 说明 | 51| --- | --- | 52| [_AbilityStageContext.default](js-apis-inner-application-abilityStageContext.md) | AbilityStage组件上下文。 | 53 54## ApplicationContext 55 56type ApplicationContext = _ApplicationContext.default 57 58应用上下文，继承自Context。 59 60**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 61 62**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 63 64**模型约束**：此接口仅可在Stage模型下使用。 65 66| 类型 | 说明 | 67| --- | --- | 68| [_ApplicationContext.default](js-apis-inner-application-applicationContext.md) | 应用上下文。 | 69 70## BaseContext 71 72type BaseContext = _BaseContext.default 73 74所有Context类型的父类。 75 76**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 77 78**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 79 80**模型约束**：此接口仅可在Stage模型下使用。 81 82| 类型 | 说明 | 83| --- | --- | 84| [_BaseContext.default](js-apis-inner-application-baseContext.md) | 所有Context的父类。 | 85 86## Context 87 88type Context = _Context.default 89 90Stage模型的上下文基类。 91 92**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 93 94**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 95 96**模型约束**：此接口仅可在Stage模型下使用。 97 98| 类型 | 说明 | 99| --- | --- | 100| [_Context.default](js-apis-inner-application-context.md) | Stage模型的上下文基类。 | 101 102## ExtensionContext 103 104type ExtensionContext = _ExtensionContext.default 105 106[ExtensionAbility](../apis-ability-kit/js-apis-app-ability-extensionAbility.md)组件上下文，继承自Context。 107 108**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 109 110**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 111 112**模型约束**：此接口仅可在Stage模型下使用。 113 114| 类型 | 说明 | 115| --- | --- | 116| [_ExtensionContext.default](js-apis-inner-application-extensionContext.md) | ExtensionAbility组件上下文。 | 117 118## FormExtensionContext 119 120type FormExtensionContext = _FormExtensionContext.default 121 122[FormExtensionAbility](../apis-form-kit/js-apis-app-form-formExtensionAbility.md)组件上下文，继承自Context。 123 124**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 125 126**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 127 128**模型约束**：此接口仅可在Stage模型下使用。 129 130| 类型 | 说明 | 131| --- | --- | 132| [_FormExtensionContext.default](../apis-form-kit/js-apis-inner-application-formExtensionContext.md) | FormExtensionAbility组件上下文。 | 133 134## VpnExtensionContext<sup>11+<sup> 135 136type VpnExtensionContext = _VpnExtensionContext.default 137 138[VpnExtensionAbility](../apis-network-kit/js-apis-VpnExtensionAbility.md)组件上下文，继承自Context。 139 140**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 141 142**模型约束**：此接口仅可在Stage模型下使用。 143 144| 类型 | 说明 | 145| --- | --- | 146| [_VpnExtensionContext.default](../apis-network-kit/js-apis-inner-application-VpnExtensionContext.md) | VpnExtensionAbility组件上下文。 | 147 148## EventHub 149 150type EventHub = _EventHub.default 151 152EventHub是系统提供的基于发布-订阅模式实现的事件通信机制。 153 154**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 155 156**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 157 158**模型约束**：此接口仅可在Stage模型下使用。 159 160| 类型 | 说明 | 161| --- | --- | 162| [_EventHub.default](js-apis-inner-application-eventHub.md) | 系统提供的基于发布-订阅模式实现的事件通信机制。 | 163 164## PacMap 165 166type PacMap = _PacMap 167 168存储基础数据类型的容器。 169 170**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 171 172**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 173 174| 类型 | 说明 | 175| --- | --- | 176| [_PacMap](js-apis-inner-ability-dataAbilityHelper.md#pacmap) | 存储基础数据类型的容器。 | 177 178## AbilityResult 179 180type AbilityResult = _AbilityResult 181 182定义Ability被拉起并退出后返回的结果码和数据。 183 184**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 185 186**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 187 188**模型约束**：此接口仅可在Stage模型下使用。 189 190| 类型 | 说明 | 191| --- | --- | 192| [_AbilityResult](js-apis-inner-ability-abilityResult.md) | 定义Ability被拉起并退出后返回的结果码和数据。 | 193 194## AbilityStartCallback<sup>11+<sup> 195 196type AbilityStartCallback = _AbilityStartCallback 197 198定义了拉起UIExtensionAbility的回调结果，通常作为[UIAbilityContext.startAbilityByType](js-apis-inner-application-uiAbilityContext.md#startabilitybytype11)/[UIExtensionContext.startAbilityByType](js-apis-app-ability-uiExtensionContentSession.md#startabilitybytype11)的入参传入。 199 200**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 201 202**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 203 204**模型约束**：此接口仅可在Stage模型下使用。 205 206| 类型 | 说明 | 207| --- | --- | 208| [_AbilityStartCallback](js-apis-inner-application-abilityStartCallback.md) | 定义拉起UIExtensionAbility的回调结果。 | 209 210## ConnectOptions 211 212type ConnectOptions = _ConnectOptions 213 214在连接指定的后台服务时作为入参，用于接收与后台服务的连接状态。 215 216**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 217 218**模型约束**：此接口仅可在Stage模型下使用。 219 220| 类型 | 说明 | 221| --- | --- | 222| [_ConnectOptions](js-apis-inner-ability-connectOptions.md) | 在连接指定的后台服务时作为入参，用于接收与后台服务的连接状态。 | 223 224## UIExtensionContext<sup>10+</sup> 225 226type UIExtensionContext = _UIExtensionContext.default 227 228[UIExtensionAbility](../apis-ability-kit/js-apis-app-ability-uiExtensionAbility.md)组件上下文，继承自Context。 229 230**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 231 232**模型约束**：此接口仅可在Stage模型下使用。 233 234| 类型 | 说明 | 235| --- | --- | 236| [_UIExtensionContext.default](js-apis-inner-application-uiExtensionContext.md) | UIExtensionAbility组件上下文。 | 237 238## EmbeddableUIAbilityContext<sup>12+<sup> 239 240type EmbeddableUIAbilityContext = _EmbeddableUIAbilityContext.default 241 242[EmbeddableUIAbility](../apis-ability-kit/js-apis-app-ability-embeddableUIAbility.md)组件上下文，继承自Context。 243 244**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 245 246**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 247 248**模型约束**：此接口仅可在Stage模型下使用。 249 250| 类型 | 说明 | 251| --- | --- | 252| [_EmbeddableUIAbilityContext.default](js-apis-inner-application-EmbeddableUIAbilityContext.md) | EmbeddableUIAbility组件上下文。 | 253 254## PhotoEditorExtensionContext<sup>12+<sup> 255 256type PhotoEditorExtensionContext = _PhotoEditorExtensionContext.default 257 258[PhotoEditorExtensionAbility](../apis-ability-kit/js-apis-app-ability-photoEditorExtensionAbility.md)组件上下文，继承自Context。 259 260**系统能力**：SystemCapability.Ability.AppExtension.PhotoEditorExtension 261 262**模型约束**：此接口仅可在Stage模型下使用。 263 264| 类型 | 说明 | 265| --- | --- | 266| [_PhotoEditorExtensionContext.default](js-apis-app-ability-photoEditorExtensionContext.md) | PhotoEditorExtensionAbility组件上下文。 | 267 268## UIServiceProxy<sup>14+<sup> 269 270type UIServiceProxy = _UIServiceProxy.default 271 272UIServiceProxy提供了与UIServiceExtensionAbility服务端数据通信的能力。UIServiceExtensionAbility是一类特殊的ExtensionAbility组件，这类组件由系统提供，通常用于提供浮窗组件相关扩展能力。 273 274**原子化服务API**：从API version 14开始，该接口支持在原子化服务中使用。 275 276**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 277 278**模型约束**：此接口仅可在Stage模型下使用。 279 280| 类型 | 说明 | 281| --- | --- | 282| [_UIServiceProxy.default](js-apis-inner-application-uiserviceproxy.md) | 提供与UIServiceExtensionAbility服务端数据通信的能力。 | 283 284## UIServiceExtensionConnectCallback<sup>14+<sup> 285 286type UIServiceExtensionConnectCallback = _UIServiceExtensionConnectCallback.default 287 288在连接指定的UIServiceExtensionAbility服务时作为入参，用于提供UIServiceExtensionAbility连接回调数据能力。 289 290**原子化服务API**：从API version 14开始，该接口支持在原子化服务中使用。 291 292**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 293 294**模型约束**：此接口仅可在Stage模型下使用。 295 296| 类型 | 说明 | 297| --- | --- | 298| [_UIServiceExtensionConnectCallback.default](js-apis-inner-application-uiServiceExtensionconnectcallback.md) | 提供UIServiceExtensionAbility连接回调数据能力。 | 299 300## AppServiceExtensionContext<sup>20+</sup> 301 302type AppServiceExtensionContext = _AppServiceExtensionContext.default 303 304[AppServiceExtensionAbility](js-apis-app-ability-appServiceExtensionAbility.md)组件上下文，继承自Context。 305 306**系统能力**：SystemCapability.Ability.AbilityRuntime.Core 307 308**模型约束**：此接口仅可在Stage模型下使用。 309 310| 类型 | 说明 | 311| --- | --- | 312| [_AppServiceExtensionContext.default](js-apis-inner-application-appServiceExtensionContext.md) | AppServiceExtensionAbility组件上下文。 | 313 314**示例：** 315 316```ts 317import { common } from '@kit.AbilityKit'; 318 319let uiAbilityContext: common.UIAbilityContext; 320let abilityStageContext: common.AbilityStageContext; 321let applicationContext: common.ApplicationContext; 322let baseContext: common.BaseContext; 323let context: common.Context; 324let uiExtensionContext: common.UIExtensionContext; 325let extensionContext: common.ExtensionContext; 326let formExtensionContext: common.FormExtensionContext; 327let vpnExtensionContext: common.VpnExtensionContext; 328let eventHub: common.EventHub; 329let pacMap: common.PacMap; 330let abilityResult: common.AbilityResult; 331let abilityStartCallback: common.AbilityStartCallback; 332let connectOptions: common.ConnectOptions; 333let embeddableUIAbilityContext: common.EmbeddableUIAbilityContext; 334let photoEditorExtensionContext: common.PhotoEditorExtensionContext; 335let uiServiceProxy : common.UIServiceProxy; 336let uiServiceExtensionConnectCallback : common.UIServiceExtensionConnectCallback; 337let appServiceExtensionContext : common.AppServiceExtensionContext; 338``` 339