From 078a106497227145a699bf6286218a07dcb477d4 Mon Sep 17 00:00:00 2001 From: wuliubao Date: Wed, 19 Jan 2022 17:31:03 +0800 Subject: [PATCH 1/2] =?UTF-8?q?IssueNo:#I4PCWF:=E3=80=90=E8=B5=84=E6=96=99?= =?UTF-8?q?=E3=80=91=E6=9C=8D=E5=8A=A1=E7=BB=84=E4=BB=B6=E8=AF=B4=E6=98=8E?= =?UTF-8?q?=20Description:=E6=8F=90=E4=BE=9B=E6=9C=8D=E5=8A=A1=E7=BB=84?= =?UTF-8?q?=E4=BB=B6=E6=96=B0=E5=A2=9E/=E5=A2=9E=E5=BC=BA=E7=89=B9?= =?UTF-8?q?=E6=80=A7=E8=B5=84=E6=96=99=E8=AF=B4=E6=98=8E=20Sig:SIG=5FAppli?= =?UTF-8?q?cationFramework=20Feature=20or=20Bugfix:Feature=20Binary=20Sour?= =?UTF-8?q?ce:No?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by:wuliubao --- .../reference/apis/js-apis-ability-context.md | 216 ++++++++++++++++++ .../apis/js-apis-extension-context.md | 11 + .../apis/js-apis-service-extension-context.md | 191 ++++++++++++++++ .../apis/js-apis-service-extension.md | 132 +++++++++++ 4 files changed, 550 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-ability-context.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-extension-context.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-service-extension.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md new file mode 100644 index 00000000000..5392f5b038e --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -0,0 +1,216 @@ +# AbilityContext + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +Ability的上下文环境，继承自Context。 + + +## 属性 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | +| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | + + +## startAbility + +startAbility(want: Want, callback: AsyncCallback<void>): void + +启动Ability。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | + +- 示例： + ``` + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "com.extreme.test.MainAbility" + }; + this.context.startAbility(want, (error) => { + console.log("error.code = " + error.code) + }) + ``` + + +## startAbility + +startAbility(want: Want): Promise<void> + +启动Ability。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | Promise形式返回启动结果。 | + +- 示例： + ``` + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "com.extreme.test.MainAbility" + }; + this.context.startAbility(want) + .then((data) => { + console.log('Operation successful.') + }).catch((error) => { + console.log('Operation failed.'); + }) + ``` + + +## startAbilityForResult + +startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void + +启动Ability并在结束的时候返回执行结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | callback | Callback<[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)> | 是 | 执行结果回调函数。 | + +- 示例： + ``` + this.context.startAbilityForResult( + {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"}, + (error, result) => { + console.log("startAbilityForResult AsyncCallback is called, error.code = " + error.code) + console.log("startAbilityForResult AsyncCallback is called, result.resultCode = " + result.resultCode) + } + ); + ``` + + +## startAbilityForResult + +startAbilityForResult(want: Want): Promise<AbilityResult> + +启动Ability并在结束的时候返回执行结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Promise<[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)> | Promise形式返回执行结果。 | + +- 示例： + ``` + this.context.startAbilityForResult({bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"}).then((result) => { + console.log("startAbilityForResult Promise.resolve is called, result.resultCode = " + result.resultCode) + }, (error) => { + console.log("startAbilityForResult Promise.Reject is called, error.code = " + error.code) + }) + ``` + + +## terminateSelf + +terminateSelf(callback: AsyncCallback<void>): void + +停止自身。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + +- 示例： + ``` + this.context.terminateSelf((err) => { + console.log('terminateSelf result:' + JSON.stringfy(err); + } + ``` + + +## terminateSelf + +terminateSelf(): Promise<void> + +停止自身。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 返回一个Promise，包含接口的结果。 | + +- 示例： + ``` + this.context.terminateSelf(want).then((data) => { + console.log('success:' + JSON.stringfy(data)); + )).catch((error) => { + console.log('failed:' + JSON.stringfy(error)); + }); + ``` + + +## terminateSelfWithResult + +terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void + +停止Ability并返回给startAbilityForResult 调用方的信息。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult 调用方的信息。 | + | callback | Callback<void> | 否 | callback形式返回停止结果 | + +- 示例： + ``` + this.context.terminateSelfWithResult( + { + want: {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo"}, + resultCode: 100 + }, (error) => { + console.log("terminateSelfWithResult is called = " + error.code) + } + ); + ``` + + +## terminateSelfWithResult + +terminateSelfWithResult(parameter: AbilityResult): Promise<void> + +停止Ability并返回给startAbilityForResult 调用方的信息。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult 调用方的信息。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | promise形式返回停止结果 | + +- 示例： + ``` + this.context.terminateSelfWithResult( + { + want: {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo"}, + resultCode: 100 + }).then((result) => { + console.log("terminateSelfWithResult") + } + ) + ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md new file mode 100644 index 00000000000..49ab751724d --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md @@ -0,0 +1,11 @@ +# ExtensionContext + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +Extension的上下文环境，继承自Context。 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md new file mode 100644 index 00000000000..644ffc62194 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md @@ -0,0 +1,191 @@ +# ServiceExtensionContext + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +ServiceExtension的上下文环境，提供ServiceExtension具有的能力和接口，继承自ExtensionContext。 + +## startAbility + +startAbility(want: Want, callback: AsyncCallback<void>): void + + +启动Ability。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + +- 示例： + ``` + let want = { + "bundleName": "com.example.myapp", + "abilityName": "com.example.myapp.MyAbility" + }; + this.context.startAbility(want, (err) => { + console.log('startAbility result:' + JSON.stringfy(err); + } + ``` + + +## startAbility + +startAbility(want: Want): Promise<void> + +启动Ability。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 返回一个Promise，包含接口的结果。 | + +- 示例： + ``` + let want = { + "bundleName": "com.example.myapp", + "abilityName": "com.example.myapp.MyAbility" + }; + this.context.startAbility(want).then((data) => { + console.log('success:' + JSON.stringfy(data)); + )).catch((error) => { + console.log('failed:' + JSON.stringfy(error)); + }); + ``` + + +## terminateSelf + +terminateSelf(callback: AsyncCallback<void>): void + +停止自身。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + +- 示例： + ``` + this.context.terminateSelf((err) => { + console.log('terminateSelf result:' + JSON.stringfy(err); + } + ``` + + +## terminateSelf + +terminateSelf(): Promise<void> + +停止自身。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 返回一个Promise，包含接口的结果。 | + +- 示例： + ``` + this.context.terminateSelf(want).then((data) => { + console.log('success:' + JSON.stringfy(data)); + )).catch((error) => { + console.log('failed:' + JSON.stringfy(error)); + }); + ``` + + +## connectAbility + +connectAbility(want: Want, options: ConnectOptions): number + +启动Ability。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回一个number，后续根据这个number去断开连接。 | + +- 示例： + ``` + let want = { + "bundleName": "com.example.myapp", + "abilityName": "com.example.myapp.MyAbility" + }; + let options = { + onConnect: function(elementName, proxy) {} + onDisConnect: function(elementName) {} + onFailed: function(code) {} + } + let connection = this.context.connectAbility(want,options); + ``` + + +## disconnectAbility + +disconnectAbility(connection: number, callback:AsyncCallback<void>): void + +启动Ability。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | connection | number | 是 | 在connectAbility中返回的number。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + +- 示例： + ``` + this.context.disconnectAbility(connection, (err) => { // connection为connectAbility中的返回值 + console.log('terminateSelf result:' + JSON.stringfy(err); + } + ``` + + +## disconnectAbility + +disconnectAbility(connection: number): Promise<void> + +启动Ability。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | connection | number | 是 | 在connectAbility中返回的number。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 返回一个Promise，包含接口的结果。 | + +- 示例： + ``` + this.context.disconnectAbility(connection).then((data) => { // connection为connectAbility中的返回值 + console.log('success:' + JSON.stringfy(data)); + )).catch((error) => { + console.log('failed:' + JSON.stringfy(error)); + }); + ``` + + +## ConnectOptions + +ConnectOptions数据结构。 + +| 名称 | 说明 | +| -------- | -------- | +| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | +| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | +| onFailed(code: number) | 连接失败时回调该接口。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension.md new file mode 100644 index 00000000000..79aa8f17794 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension.md @@ -0,0 +1,132 @@ +# ServiceExtension + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +提供ServiceExtension先关服务接口。 + + +## 导入模块 + +``` +import ServiceExtension from '@ohos.application.ServiceExtension'; +``` + + +## 权限 + +无 + + +## 属性 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | + + +## onCreate + +onCreate(want: Want): void + +Extension的生命周期，在创建时回调，可以做一些初始化操作。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + +- 示例： + ``` + onCreate(want) { + console.log('onCreate, want:' + want.abilityName); + } + ``` + + +## onDestroy + +onDestroy(): void + +Extension的生命周期，在销毁时回调，可以做资源清理等操作。 + +- 示例： + ``` + onDestroy() { + console.log('onDestroy'); + } + ``` + + +## onRequest + +onRequest(want: Want, startId: number): void + +Extension的生命周期，如果是startAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | startId | number | 是 | 首次拉起值是1，多次拉起会递增。 | + +- 示例： + ``` + onRequest(want: Want, startId: number) { + console.log('onRequest, want:' + want.abilityName); + } + ``` + + +## onConnect + +onConnect(want: Want): rpc.RemoteObject + +Extension的生命周期，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于和客户端进行通信。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 | + +- 示例： + ``` + import rpc from '@ohos.rpc' + class StubTest extends rpc.RemoteObject{ + constructor(des) { + super(des); + } + onRemoteRequest(code, data, reply, option) { + } + } + ... + onConnect(want) { + console.log('onConnect , want:' + want.abilityName); + return new StubTest("test"); + } + ``` + + +## onDisconnect + +onDisconnect(want: Want): void + +Extension的生命周期，断开服务连接时回调。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + +- 示例： + ``` + onDisconnect(want) { + console.log('onDisconnect, want:' + want.abilityName); + } + ``` -- Gitee From 2660b4d4576caeb64ed1a6b65a1200eb4c9476b5 Mon Sep 17 00:00:00 2001 From: wuliubao Date: Fri, 21 Jan 2022 17:21:41 +0800 Subject: [PATCH 2/2] =?UTF-8?q?IssueNo:=20#I4PCWF:=E3=80=90=E8=B5=84?= =?UTF-8?q?=E6=96=99=E3=80=91=E6=9C=8D=E5=8A=A1=E7=BB=84=E4=BB=B6=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=20Description:=20=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E8=AF=84=E5=AE=A1=E6=84=8F=E8=A7=81=20Sig:=20SIG=5FApplication?= =?UTF-8?q?Framework=20Feature=20or=20Bugfix:=20Feature=20Binary=20Source:?= =?UTF-8?q?=20No?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: wuliubao --- .../reference/apis/js-apis-ability-context.md | 90 ++++++++++--------- .../apis/js-apis-extension-context.md | 8 +- .../apis/js-apis-service-extension-context.md | 90 ++++++++++--------- .../apis/js-apis-service-extension.md | 55 +++++++----- 4 files changed, 138 insertions(+), 105 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index 5392f5b038e..a06bca19748 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -1,5 +1,14 @@ # 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) **说明：** > 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -9,10 +18,10 @@ Ability的上下文环境，继承自Context。 ## 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | +| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | +| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | ## startAbility @@ -22,10 +31,10 @@ startAbility(want: Want, callback: AsyncCallback<void>): void 启动Ability。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 | - 示例： ``` @@ -42,19 +51,19 @@ startAbility(want: Want, callback: AsyncCallback<void>): void ## startAbility -startAbility(want: Want): Promise<void> +startAbility(want: Want): Promise<void>; -启动Ability。 +启动Ability。通过Promise返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | - 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<void> | Promise形式返回启动结果。 | + | Promise<void> | Promise形式返回启动结果。 | - 示例： ``` @@ -74,15 +83,16 @@ startAbility(want: Want): Promise<void> ## startAbilityForResult -startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void +startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void; 启动Ability并在结束的时候返回执行结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | - | callback | Callback<[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)> | 是 | 执行结果回调函数。 | + | want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | callback | Callback<[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)> | 是 | 执行结果回调函数。 | + - 示例： ``` @@ -98,19 +108,19 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): ## startAbilityForResult -startAbilityForResult(want: Want): Promise<AbilityResult> +startAbilityForResult(want: Want): Promise<AbilityResult>; 启动Ability并在结束的时候返回执行结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 | - 返回值 - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)> | Promise形式返回执行结果。 | + | Promise<[AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明)> | Promise形式返回执行结果。 | - 示例： ``` @@ -124,14 +134,14 @@ startAbilityForResult(want: Want): Promise<AbilityResult> ## terminateSelf -terminateSelf(callback: AsyncCallback<void>): void +terminateSelf(callback: AsyncCallback<void>): void; -停止自身。 +停止Ability自身。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - 示例： ``` @@ -143,14 +153,14 @@ terminateSelf(callback: AsyncCallback<void>): void ## terminateSelf -terminateSelf(): Promise<void> +terminateSelf(): Promise<void>; -停止自身。 +停止Ability自身。通过Promise返回结果。 - 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | + | Promise<void> | 返回一个Promise，包含接口的结果。 | - 示例： ``` @@ -164,15 +174,15 @@ terminateSelf(): Promise<void> ## terminateSelfWithResult -terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void +terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void; -停止Ability并返回给startAbilityForResult 调用方的信息。 +停止Ability，并返回给调用startAbilityForResult 接口调用方的相关信息。 - 参数 - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult 调用方的信息。 | - | callback | Callback<void> | 否 | callback形式返回停止结果 | + | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给调用startAbilityForResult 接口调用方的相关信息。 | + | callback | Callback<void> | 否 | callback形式返回停止结果 | - 示例： ``` @@ -189,19 +199,19 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi ## terminateSelfWithResult -terminateSelfWithResult(parameter: AbilityResult): Promise<void> +terminateSelfWithResult(parameter: AbilityResult): Promise<void>; -停止Ability并返回给startAbilityForResult 调用方的信息。 +停止Ability，并返回给调用startAbilityForResult 接口相关信息。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult 调用方的信息。 | + | parameter | [AbilityResult](js-apis-featureAbility.md#AbilityResult类型说明) | 是 | 返回给startAbilityForResult 调用方的信息。 | - 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<void> | promise形式返回停止结果 | + | Promise<void> | promise形式返回停止结果 | - 示例： ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md index 49ab751724d..bf211462e4c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md @@ -1,11 +1,15 @@ # ExtensionContext +- [属性](#属性) > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 Extension的上下文环境，继承自Context。 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | + +## 属性 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 | +| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md index 644ffc62194..ba9210e9274 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md @@ -1,24 +1,34 @@ # 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) **说明：** > 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ServiceExtension的上下文环境，提供ServiceExtension具有的能力和接口，继承自ExtensionContext。 + ## startAbility -startAbility(want: Want, callback: AsyncCallback<void>): void + +startAbility(want: Want, callback: AsyncCallback<void>): void; 启动Ability。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - 示例： ``` @@ -34,19 +44,19 @@ startAbility(want: Want, callback: AsyncCallback<void>): void ## startAbility -startAbility(want: Want): Promise<void> +startAbility(want: Want): Promise<void>; -启动Ability。 +启动Ability。通过Promise返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | + | Promise<void> | 返回一个Promise，包含接口的结果。 | - 示例： ``` @@ -64,14 +74,14 @@ startAbility(want: Want): Promise<void> ## terminateSelf -terminateSelf(callback: AsyncCallback<void>): void +terminateSelf(callback: AsyncCallback<void>): void; -停止自身。 +停止Ability自身。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - 示例： ``` @@ -83,14 +93,14 @@ terminateSelf(callback: AsyncCallback<void>): void ## terminateSelf -terminateSelf(): Promise<void> +terminateSelf(): Promise<void>; -停止自身。 +停止自身。通过Promise返回结果。 - 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | + | Promise<void> | 返回一个Promise，包含接口的结果。 | - 示例： ``` @@ -104,20 +114,20 @@ terminateSelf(): Promise<void> ## 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名称，包名等。 | - | options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | - 返回值 - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | number | 返回一个number，后续根据这个number去断开连接。 | + | number | 返回一个number，后续根据这个number去断开连接。 | - 示例： ``` @@ -136,15 +146,15 @@ connectAbility(want: Want, options: ConnectOptions): number ## disconnectAbility -disconnectAbility(connection: number, callback:AsyncCallback<void>): void +disconnectAbility(connection: number, callback:AsyncCallback<void>): void; -启动Ability。 +将一个Ability与绑定的服务类型的Ability解绑。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | connection | number | 是 | 在connectAbility中返回的number。 | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + | connection | number | 是 | 在connectAbility中返回的number。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - 示例： ``` @@ -156,19 +166,19 @@ disconnectAbility(connection: number, callback:AsyncCallback<void>): void ## disconnectAbility -disconnectAbility(connection: number): Promise<void> +disconnectAbility(connection: number): Promise<void>; -启动Ability。 +将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | connection | number | 是 | 在connectAbility中返回的number。 | + | connection | number | 是 | 在connectAbility中返回的number。 | - 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | + | Promise<void> | 返回一个Promise，包含接口的结果。 | - 示例： ``` @@ -184,8 +194,8 @@ disconnectAbility(connection: number): Promise<void> ConnectOptions数据结构。 -| 名称 | 说明 | +| 名称 | 说明 | | -------- | -------- | -| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | -| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | -| onFailed(code: number) | 连接失败时回调该接口。 | +| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | +| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | +| onFailed(code: number) | 连接失败时回调该接口。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension.md index 79aa8f17794..cde5ba29020 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension.md @@ -1,10 +1,18 @@ # ServiceExtension +- [导入模块](#导入模块) +- [权限](#权限) +- [属性](#属性) +- [onCreate](#onCreate) +- [onDestroy](#onDestroy) +- [onRequest](#onRequest) +- [onConnect](#onConnect) +- [onDisconnect](#onDisconnect) > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -提供ServiceExtension先关服务接口。 +提供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(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的生命周期，在创建时回调，可以做一些初始化操作 ## onDestroy -onDestroy(): void +onDestroy(): void; -Extension的生命周期，在销毁时回调，可以做资源清理等操作。 +Extension生命周期回调，在销毁时回调，执行资源清理等操作。 - 示例： ``` onDestroy() { console.log('onDestroy'); + destory(); } ``` ## 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名称等。 | - | startId | number | 是 | 首次拉起值是1，多次拉起会递增。 | + | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | - 示例： ``` @@ -81,19 +90,19 @@ Extension的生命周期，如果是startAbility拉起的服务，会在onCreate ## 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 ## onDisconnect -onDisconnect(want: Want): void +onDisconnect(want: Want): void; Extension的生命周期，断开服务连接时回调。 - 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + | want |[Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - 示例： ``` -- Gitee