harmony 鸿蒙@ohos.app.ability.ShareExtensionAbility (分享详情页扩展能力)

2025-06-12
浏览 (4)

@ohos.app.ability.ShareExtensionAbility (分享详情页扩展能力)

ShareExtensionAbility继承自UIExtensionAbility，为开发者提供分享详情页扩展能力。该模块支持开发者创建接收分享内容的分享详情页面，将应用入口展示于系统分享面板的推荐应用区域。各类Ability的继承关系详见继承关系说明。

说明：

本模块首批接口从API version 10 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

场景介绍

以分享文本为例。用户选择一段文本，拉起要分享应用，此时被分享拉起的应用会根据分享信息将分享模板拉起，并将数据按分享模板内容显示。

导入模块

import { ShareExtensionAbility } from '@kit.AbilityKit';

属性

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

名称	类型	只读	必填	说明
context	UIExtensionContext	否	是	上下文。

ShareExtensionAbility.onCreate

onCreate(): void

ShareExtensionAbility创建时回调，执行初始化业务逻辑操作。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

参见创建ShareExtensionAbility。

ShareExtensionAbility.onSessionCreate

onSessionCreate(want: Want, session: UIExtensionContentSession): void

当ShareExtensionAbility界面内容对象创建后调用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

参数名	类型	必填	说明
want	Want	是	当前ShareExtensionAbility的Want类型信息，包括ability名称、bundle名称等。
session	UIExtensionContentSession	是	ShareExtensionAbility界面内容相关信息。

示例：

参见创建ShareExtensionAbility。

ShareExtensionAbility.onForeground

onForeground(): void

ShareExtensionAbility生命周期回调，当ShareExtensionAbility从后台转到前台时触发。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

参见创建ShareExtensionAbility。

ShareExtensionAbility.onBackground

onBackground(): void

ShareExtensionAbility生命周期回调，当ShareExtensionAbility从前台转到后台时触发。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

示例：

参见创建ShareExtensionAbility。

ShareExtensionAbility.onSessionDestroy

onSessionDestroy(session: UIExtensionContentSession): void

当ShareExtensionAbility界面内容对象销毁后调用。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

参数：

参数名	类型	必填	说明
session	UIExtensionContentSession	是	ShareExtensionAbility界面内容相关信息。

示例：

参见创建ShareExtensionAbility。

ShareExtensionAbility.onDestroy

onDestroy(): void|Promise<void>

ShareExtensionAbility生命周期回调，在销毁时回调，执行资源清理等操作。在执行完onDestroy生命周期回调后，应用可能会退出，从而可能导致onDestroy中的异步函数未能正确执行，比如异步写入数据库。可以使用异步生命周期，以确保异步onDestroy完成后再继续后续的生命周期。

系统能力：SystemCapability.Ability.AbilityRuntime.AbilityCore

返回值：

类型	说明
void \| Promise<void>	无返回结果或无返回结果的Promise对象。

示例：

参见创建ShareExtensionAbility。

创建ShareExtensionAbility

在DevEco Studio工程中手动新建一个ShareExtensionAbility，具体步骤如下：

在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为ShareExtAbility。
在ShareExtAbility目录，右键选择“New > ArkTS File”，新建一个文件并命名为ShareExtAbility.ets。
```
├── ets
│ ├── ShareExtAbility
│ │   ├── ShareExtAbility.ets
└
```

ShareExtAbility.ets文件中，增加导入ShareExtensionAbility的依赖包，自定义类继承ShareExtensionAbility并实现生命周期回调。

import { ShareExtensionAbility, UIExtensionContentSession, Want } from '@kit.AbilityKit';


const TAG: string = "[ShareExtAbility]";


export default class ShareExtAbility extends ShareExtensionAbility {
  onCreate() {
    console.info(TAG, `onCreate`);
  }
  onSessionCreate(want: Want, session: UIExtensionContentSession) {
    console.info(TAG, `onSessionCreate, want: ${want.abilityName}`);
    if (want.parameters) {
      let obj: Record<string, UIExtensionContentSession|object> = {
        'session': session,
        'messages': want.parameters.shareMessages
      }
      let storage: LocalStorage = new LocalStorage(obj);
      session.loadContent('pages/Index', storage);
    }
  }
  onForeground() {
    console.info(TAG, `onForeground`);
  }
  onBackground() {
    console.info(TAG, `onBackground`);
  }
  onSessionDestroy(session: UIExtensionContentSession) {
    console.info(TAG, `onSessionDestroy`);
  }
  onDestroy() {
    console.info(TAG, `onDestroy`);
  }
}

在工程Module对应的module.json5配置文件中注册ShareExtensionAbility，type标签需要设置为“share”，srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。

   {
     "module": {
       // ...
       "extensionAbilities": [
         {
           "name": "ShareExtAbility",
           "icon": "$media:icon",
           "description": "share",
           "type": "share",
           "exported": true,
           "srcEntry": "./ets/ShareExtAbility/ShareExtAbility.ets"
         }
       ]
     }
   }