提交 2660b4d4 编写于 作者: ahjxliubao2's avatar ahjxliubao2

IssueNo: #I4PCWF:【资料】服务组件说明

Description: 修改文档评审意见
Sig: SIG_ApplicationFramework
Feature or Bugfix: Feature
Binary Source: No
Signed-off-by: ahjxliubao2's avatarwuliubao <ahjxliubao@163.com>
上级 078a1064
# AbilityContext # AbilityContext
- [属性](#属性)
- [startAbility](#startAbility)
- [startAbility](#startAbility)
- [startAbilityForResult](#startAbilityForResult)
- [startAbilityForResult](#startAbilityForResult)
- [terminateSelf](#terminateSelf)
- [terminateSelf](#terminateSelf)
- [terminateSelfWithResult](#terminateSelfWithResult)
- [terminateSelfWithResult](#terminateSelfWithResult)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...@@ -9,10 +18,10 @@ Ability的上下文环境,继承自Context。 ...@@ -9,10 +18,10 @@ Ability的上下文环境,继承自Context。
## 属性 ## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | | abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
## startAbility ## startAbility
...@@ -22,10 +31,10 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void ...@@ -22,10 +31,10 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
启动Ability。 启动Ability。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
- 示例: - 示例:
``` ```
...@@ -42,19 +51,19 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void ...@@ -42,19 +51,19 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
## startAbility ## startAbility
startAbility(want: Want): Promise&lt;void&gt; startAbility(want: Want): Promise&lt;void&gt;;
启动Ability。 启动Ability。通过Promise返回结果。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | Promise形式返回启动结果。 | | Promise&lt;void&gt; | Promise形式返回启动结果。 |
- 示例: - 示例:
``` ```
...@@ -74,15 +83,16 @@ startAbility(want: Want): Promise&lt;void&gt; ...@@ -74,15 +83,16 @@ startAbility(want: Want): Promise&lt;void&gt;
## startAbilityForResult ## startAbilityForResult
startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在结束的时候返回执行结果。 启动Ability并在结束的时候返回执行结果。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | | want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| callback | Callback&lt;[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)&gt; | 是 | 执行结果回调函数。 | | callback | Callback&lt;[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)&gt; | 是 | 执行结果回调函数。 |
- 示例: - 示例:
``` ```
...@@ -98,19 +108,19 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): ...@@ -98,19 +108,19 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;):
## startAbilityForResult ## startAbilityForResult
startAbilityForResult(want: Want): Promise&lt;AbilityResult&gt; startAbilityForResult(want: Want): Promise&lt;AbilityResult&gt;;
启动Ability并在结束的时候返回执行结果。 启动Ability并在结束的时候返回执行结果。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)&gt; | Promise形式返回执行结果。 | | Promise&lt;[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)&gt; | Promise形式返回执行结果。 |
- 示例: - 示例:
``` ```
...@@ -124,14 +134,14 @@ startAbilityForResult(want: Want): Promise&lt;AbilityResult&gt; ...@@ -124,14 +134,14 @@ startAbilityForResult(want: Want): Promise&lt;AbilityResult&gt;
## terminateSelf ## terminateSelf
terminateSelf(callback: AsyncCallback&lt;void&gt;): void terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
停止自身。 停止Ability自身。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 |
- 示例: - 示例:
``` ```
...@@ -143,14 +153,14 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void ...@@ -143,14 +153,14 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void
## terminateSelf ## terminateSelf
terminateSelf(): Promise&lt;void&gt; terminateSelf(): Promise&lt;void&gt;;
停止自身 停止Ability自身。通过Promise返回结果
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 | | Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
- 示例: - 示例:
``` ```
...@@ -164,15 +174,15 @@ terminateSelf(): Promise&lt;void&gt; ...@@ -164,15 +174,15 @@ terminateSelf(): Promise&lt;void&gt;
## terminateSelfWithResult ## terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void;
停止Ability并返回给startAbilityForResult 调用方的信息。 停止Ability,并返回给调用startAbilityForResult 接口调用方的相关信息。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 | | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| callback | Callback&lt;void&gt; | 否 | callback形式返回停止结果 | | callback | Callback&lt;void&gt; | 否 | callback形式返回停止结果 |
- 示例: - 示例:
``` ```
...@@ -189,19 +199,19 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi ...@@ -189,19 +199,19 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi
## terminateSelfWithResult ## terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt; terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
停止Ability并返回给startAbilityForResult 调用方的信息。 停止Ability,并返回给调用startAbilityForResult 接口相关信息。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 | | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | promise形式返回停止结果 | | Promise&lt;void&gt; | promise形式返回停止结果 |
- 示例: - 示例:
``` ```
......
# ExtensionContext # ExtensionContext
- [属性](#属性)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Extension的上下文环境,继承自Context。 Extension的上下文环境,继承自Context。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 | | currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 |
# ServiceExtensionContext # ServiceExtensionContext
- [startAbility](#startAbility)
- [startAbility](#startAbility)
- [terminateSelf](#terminateSelf)
- [terminateSelf](#terminateSelf)
- [connectAbility](#connectAbility)
- [disconnectAbility](#disconnectAbility)
- [disconnectAbility](#disconnectAbility)
- [ConnectOptions](#ConnectOptions)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
ServiceExtension的上下文环境,提供ServiceExtension具有的能力和接口,继承自ExtensionContext。 ServiceExtension的上下文环境,提供ServiceExtension具有的能力和接口,继承自ExtensionContext。
## startAbility ## startAbility
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
启动Ability。 启动Ability。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 |
- 示例: - 示例:
``` ```
...@@ -34,19 +44,19 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void ...@@ -34,19 +44,19 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
## startAbility ## startAbility
startAbility(want: Want): Promise&lt;void&gt; startAbility(want: Want): Promise&lt;void&gt;;
启动Ability。 启动Ability。通过Promise返回结果。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 | | Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
- 示例: - 示例:
``` ```
...@@ -64,14 +74,14 @@ startAbility(want: Want): Promise&lt;void&gt; ...@@ -64,14 +74,14 @@ startAbility(want: Want): Promise&lt;void&gt;
## terminateSelf ## terminateSelf
terminateSelf(callback: AsyncCallback&lt;void&gt;): void terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
停止自身。 停止Ability自身。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 |
- 示例: - 示例:
``` ```
...@@ -83,14 +93,14 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void ...@@ -83,14 +93,14 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void
## terminateSelf ## terminateSelf
terminateSelf(): Promise&lt;void&gt; terminateSelf(): Promise&lt;void&gt;;
停止自身。 停止自身。通过Promise返回结果。
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 | | Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
- 示例: - 示例:
``` ```
...@@ -104,20 +114,20 @@ terminateSelf(): Promise&lt;void&gt; ...@@ -104,20 +114,20 @@ terminateSelf(): Promise&lt;void&gt;
## connectAbility ## connectAbility
connectAbility(want: Want, options: ConnectOptions): number connectAbility(want: Want, options: ConnectOptions): number;
启动Ability 将一个Ability与服务类型的Ability绑定
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数,返回服务连接成功、断开或连接失败后的信息。 | | options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数,返回服务连接成功、断开或连接失败后的信息。 |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| number | 返回一个number,后续根据这个number去断开连接。 | | number | 返回一个number,后续根据这个number去断开连接。 |
- 示例: - 示例:
``` ```
...@@ -136,15 +146,15 @@ connectAbility(want: Want, options: ConnectOptions): number ...@@ -136,15 +146,15 @@ connectAbility(want: Want, options: ConnectOptions): number
## disconnectAbility ## disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void;
启动Ability 将一个Ability与绑定的服务类型的Ability解绑
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 | | connection | number | 是 | 在connectAbility中返回的number。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数,返回接口调用是否成功的结果。 |
- 示例: - 示例:
``` ```
...@@ -156,19 +166,19 @@ disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void ...@@ -156,19 +166,19 @@ disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void
## disconnectAbility ## disconnectAbility
disconnectAbility(connection: number): Promise&lt;void&gt; disconnectAbility(connection: number): Promise&lt;void&gt;;
启动Ability 将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 | | connection | number | 是 | 在connectAbility中返回的number。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 | | Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
- 示例: - 示例:
``` ```
...@@ -184,8 +194,8 @@ disconnectAbility(connection: number): Promise&lt;void&gt; ...@@ -184,8 +194,8 @@ disconnectAbility(connection: number): Promise&lt;void&gt;
ConnectOptions数据结构。 ConnectOptions数据结构。
| 名称 | 说明 | | 名称 | 说明 |
| -------- | -------- | | -------- | -------- |
| onConnect(elementName:ElementName,&nbsp;remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | | onConnect(elementName:ElementName,&nbsp;remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | | onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 |
| onFailed(code:&nbsp;number) | 连接失败时回调该接口。 | | onFailed(code:&nbsp;number) | 连接失败时回调该接口。 |
# ServiceExtension # ServiceExtension
- [导入模块](#导入模块)
- [权限](#权限)
- [属性](#属性)
- [onCreate](#onCreate)
- [onDestroy](#onDestroy)
- [onRequest](#onRequest)
- [onConnect](#onConnect)
- [onDisconnect](#onDisconnect)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
提供ServiceExtension先关服务接口。 提供ServiceExtension服务扩展相关接口。
## 导入模块 ## 导入模块
...@@ -21,21 +29,21 @@ import ServiceExtension from '@ohos.application.ServiceExtension'; ...@@ -21,21 +29,21 @@ import ServiceExtension from '@ohos.application.ServiceExtension';
## 属性 ## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 | | context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 |
## onCreate ## onCreate
onCreate(want: Want): void onCreate(want: Want): void;
Extension的生命周期,在创建时回调,可以做一些初始化操作。 Extension生命周期回调,在创建时回调,执行初始化业务逻辑操作。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
- 示例: - 示例:
``` ```
...@@ -47,29 +55,30 @@ Extension的生命周期,在创建时回调,可以做一些初始化操作 ...@@ -47,29 +55,30 @@ Extension的生命周期,在创建时回调,可以做一些初始化操作
## onDestroy ## onDestroy
onDestroy(): void onDestroy(): void;
Extension的生命周期,在销毁时回调,可以做资源清理等操作。 Extension生命周期回调,在销毁时回调,执行资源清理等操作。
- 示例: - 示例:
``` ```
onDestroy() { onDestroy() {
console.log('onDestroy'); console.log('onDestroy');
destory();
} }
``` ```
## onRequest ## onRequest
onRequest(want: Want, startId: number): void onRequest(want: Want, startId: number): void;
Extension的生命周期,如果是startAbility拉起的服务,会在onCreate之后回调。每次拉起服务都会回调,startId会递增。 Extension生命周期回调,如果是startAbility拉起的服务,会在onCreate之后回调。每次拉起服务都会回调,startId会递增。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| startId | number | 是 | 首次拉起值是1,多次拉起会递增。 | | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 |
- 示例: - 示例:
``` ```
...@@ -81,19 +90,19 @@ Extension的生命周期,如果是startAbility拉起的服务,会在onCreate ...@@ -81,19 +90,19 @@ Extension的生命周期,如果是startAbility拉起的服务,会在onCreate
## onConnect ## onConnect
onConnect(want: Want): rpc.RemoteObject onConnect(want: Want): rpc.RemoteObject;
Extension的生命周期,如果是connectAbility拉起的服务,会在onCreate之后回调。返回一个RemoteObject对象,用于和客户端进行通信。 Extension生命周期回调,如果是connectAbility拉起的服务,会在onCreate之后回调。返回一个RemoteObject对象,用于和客户端进行通信。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | | want | [Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 | | rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 |
- 示例: - 示例:
``` ```
...@@ -115,14 +124,14 @@ Extension的生命周期,如果是connectAbility拉起的服务,会在onCrea ...@@ -115,14 +124,14 @@ Extension的生命周期,如果是connectAbility拉起的服务,会在onCrea
## onDisconnect ## onDisconnect
onDisconnect(want: Want): void onDisconnect(want: Want): void;
Extension的生命周期,断开服务连接时回调。 Extension的生命周期,断开服务连接时回调。
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | | want |[Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
- 示例: - 示例:
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册