1# @ohos.app.ability.ShareExtensionAbility (分享模板服务扩展能力) 2 3ShareExtensionAbility是为开发者提供分享操作业务模板，继承自[UIExtensionAbility](js-apis-app-ability-uiExtensionAbility.md)。ShareExtension为人们提供了一种通过应用程序、社交媒体帐户和其他服务共享当前上下文信息的便捷方式。 4 5> **说明：** 6> 7> 本模块首批接口从API version 10 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 本模块接口仅可在Stage模型下使用。 9 10## 场景介绍 11 12以分享文本为例。用户选择一段文本，拉起要分享应用，此时被分享拉起的应用会根据分享信息将分享模板拉起，并将数据按分享模板内容显示。 13 14## 导入模块 15 16```ts 17import ShareExtensionAbility from '@ohos.app.ability.ShareExtensionAbility'; 18``` 19 20## 属性 21 22**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 23 24| 名称 | 类型 | 可读 | 可写 | 说明 | 25| -------- | -------- | -------- | -------- | -------- | 26| context | [UIExtensionContext](js-apis-inner-application-uiExtensionContext.md) | 是 | 否 | 上下文。 | 27 28## ShareExtensionAbility.onCreate 29 30onCreate(): void 31 32ShareExtensionAbility创建时回调，执行初始化业务逻辑操作。 33 34**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 35 36## ShareExtensionAbility.onSessionCreate 37 38onSessionCreate(want: Want, session: UIExtensionContentSession): void 39 40当ShareExtensionAbility界面内容对象创建后调用。 41 42**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 43 44**参数：** 45 46| 参数名 | 类型 | 必填 | 说明 | 47| -------- | -------- | -------- | -------- | 48| want | [Want](js-apis-app-ability-want.md) | 是 | 当前ShareExtensionAbility的Want类型信息，包括ability名称、bundle名称等。 | 49| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | ShareExtensionAbility界面内容相关信息。 | 50 51## ShareExtensionAbility.onSessionDestroy 52 53onSessionDestroy(session: UIExtensionContentSession): void 54 55当ShareExtensionAbility界面内容对象销毁后调用。 56 57**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 58 59**参数：** 60 61| 参数名 | 类型 | 必填 | 说明 | 62| -------- | -------- | -------- | -------- | 63| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | ShareExtensionAbility界面内容相关信息。 | 64 65## ShareExtensionAbility.onForeground 66 67onForeground(): void; 68 69ShareExtensionAbility生命周期回调，当ShareExtensionAbility从后台转到前台时触发。 70 71**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 72 73## ShareExtensionAbility.onBackground 74 75onBackground(): void; 76 77ShareExtensionAbility生命周期回调，当ShareExtensionAbility从前台转到后台时触发。 78 79**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 80 81## ShareExtensionAbility.onDestroy 82 83onDestroy(): void | Promise<void>; 84 85ShareExtensionAbility生命周期回调，在销毁时回调，执行资源清理等操作。 86在执行完onDestroy生命周期回调后，应用可能会退出，从而可能导致onDestroy中的异步函数未能正确执行，比如异步写入数据库。可以使用异步生命周期，以确保异步onDestroy完成后再继续后续的生命周期。 87 88**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore 89 90## 创建ShareExtensionAbility 91 92在DevEco Studio工程中手动新建一个ShareExtensionAbility，具体步骤如下： 93 941. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为ShareExtAbility。 95 962. 在ShareExtAbility目录，右键选择“New > TypeScript File”，新建一个TypeScript文件并命名为ShareExtAbility.ts。 97 98 ``` 99 ├── ets 100 │ ├── ShareExtAbility 101 │ │ ├── ShareExtAbility.ts 102 └ 103 ``` 104 1053. ShareExtAbility.ts文件中，增加导入ShareExtensionAbility的依赖包，自定义类继承ShareExtensionAbility并实现生命周期回调。 106 107 ```ts 108 import ShareExtensionAbility from '@ohos.app.ability.ShareExtensionAbility'; 109 import UIExtensionContentSession from '@ohos.app.ability.UIExtensionContentSession'; 110 import Want from '@ohos.app.ability.Want'; 111 112 const TAG: string = "[ShareExtAbility]"; 113 114 export default class ShareExtAbility extends ShareExtensionAbility { 115 onCreate() { 116 console.info(TAG, `onCreate`); 117 } 118 119 onForeground() { 120 console.info(TAG, `ononForeground`); 121 } 122 123 onBackground() { 124 console.info(TAG, `onBackground`); 125 } 126 127 onSessionCreate(want: Want, session: UIExtensionContentSession) { 128 console.info(TAG, `onSessionCreate, want: ${want.abilityName}`); 129 if (want.parameters) { 130 let obj: Record<string, UIExtensionContentSession | object> = { 131 'session': session, 132 'messages': want.parameters.shareMessages 133 } 134 let storage: LocalStorage = new LocalStorage(obj); 135 session.loadContent('pages/Index', storage); 136 session.loadContent('pages/Index', storage); 137 } 138 } 139 140 onSessionDestroy() { 141 console.info(TAG, `onSessionDestroy`); 142 } 143 144 onDestroy() { 145 console.info(TAG, `onDestroy`); 146 } 147 } 148 ``` 149 1504. 在工程Module对应的[module.json5配置文件](../../quick-start/module-configuration-file.md)中注册ShareExtensionAbility，type标签需要设置为“share”，srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。 151 152 ```json 153 { 154 "module": { 155 ... 156 "extensionAbilities": [ 157 { 158 "name": "ShareExtAbility", 159 "icon": "$media:icon", 160 "description": "share", 161 "type": "share", 162 "exported": true, 163 "srcEntry": "./ets/ShareExtAbility/ShareExtAbility.ts" 164 } 165 ] 166 } 167 } 168 ```