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