diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 08593677a5fa5ce02018dc74e77a2d97e655622e..369346fadd4ea06245066e22ff82f78c8bead792 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -24,12 +24,8 @@ - application/[abilityDelegator (AbilityDelegator)](js-apis-application-abilityDelegator.md) - application/[abilityDelegatorArgs (AbilityDelegatorArgs)](js-apis-application-abilityDelegatorArgs.md) - application/[AbilityRunningInfo (AbilityRunningInfo)](js-apis-abilityrunninginfo.md) - - application/[ExtensionContext (ExtensionContext)](js-apis-extension-context.md) - - application/[ExtensionRunningInfo (ExtensionRunningInfo)](js-apis-extensionrunninginfo.md) - - application/[FormExtensionContext (FormExtensionContext)](js-apis-formextensioncontext.md) - application/[MissionSnapshot (MissionSnapshot)](js-apis-application-MissionSnapshot.md) - application/[ProcessRunningInfo (ProcessRunningInfo)](js-apis-processrunninginfo.md) - - application/[ServiceExtensionContext (ServiceExtensionContext)](js-apis-service-extension-context.md) - application/[shellCmdResult (ShellCmdResult)](js-apis-application-shellCmdResult.md) - 公共事件与通知 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 deleted file mode 100644 index f694b30bc265beab508be32478aab2228e2193dd..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ /dev/null @@ -1,16 +0,0 @@ -# ExtensionContext - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - - -Extension的上下文环境，继承自Context。 - - -## 属性 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md deleted file mode 100644 index 3c4d9a31743339f8459e3b634c6f522bd9b72744..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ /dev/null @@ -1,57 +0,0 @@ -# ExtensionRunningInfo - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - - -Extension运行相关信息。 - - -## 使用说明 - - -通过abilityManager中方法获取。 - - - -``` -import abilitymanager from '@ohos.application.abilityManager'; -abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { - console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); -}); -``` - - -### 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| extension | ElementName | 是 | 否 | Extension匹配信息。 | -| pid | number | 是 | 否 | 进程ID。 | -| uid | number | 是 | 否 | 用户ID。 | -| processName | string | 是 | 否 | 进程名称。 | -| startTime | number | 是 | 否 | Extension启动时间。 | -| clientPackage | Array<String> | 是 | 否 | 表示当期进程下的所有包名。 | -| type | [bundle.ExtensionAbilityType](#bundleextensionabilitytype) | 是 | 否 | Extension类型。 | - - -## bundle.ExtensionAbilityType - -Extension类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework - - | 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| FORM | 0 | 表示带有form类型的扩展信息。< | -| WORK_SCHEDULER | 1 | 表示带有work scheduler类型的扩展信息。< | -| INPUT_METHOD | 2 | 表示用输入法类型的扩展信息。< | -| SERVICE | 3 | 表示带有service类型的扩展信息。< | -| ACCESSIBILITY | 4 | 表示具有可访问性类型的扩展信息。< | -| DATA_SHARE | 5 | 表示带有datashare类型的扩展信息。< | -| FILE_SHARE | 6 | 表示带有fileshare类型的扩展信息。< | -| STATIC_SUBSCRIBER | 7 | 表示带有静态订阅者类型的扩展信息。< | -| WALLPAPER | 8 | 表示带有wallpaper类型的扩展信息。< | -| UNSPECIFIED | 9 | 表示未指定类型信息。< | diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md deleted file mode 100644 index cad850c9aff0bcbb7aef3803645caa47a489de65..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md +++ /dev/null @@ -1,63 +0,0 @@ -# FormExtensionContext - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -FormExtension的上下文环境，提供FormExtension具有的能力和接口，继承自ExtensionContext。 - -## FormExtensionContext.updateForm - -updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\): void - -主动更新卡片。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | --------------- | ------------------------------------------------------------ | ---- | -------------------------------------- | - | formId | string | 是 | 请求更新的卡片ID。 | - | formBindingData | [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 卡片新的数据。 | - | callback | AsyncCallback\ | 是 | 回调函数，返回接口调用是否成功的结果。 | - -**示例：** - - ```js - let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); - this.context.updateForm(formId, obj2, (data)=>{ - console.log('FormExtension context updateForm, data:' + data); - }); - ``` - -## FormExtensionContext.updateForm - -updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise\ - -更新卡片。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | --------------- | ------------------------------------------------------------ | ---- | ------------------ | - | formId | string | 是 | 请求更新的卡片ID。 | - | formBindingData | [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 卡片新的数据。 | - -**返回值：** - - | 类型 | 说明 | - | -------------- | --------------------------------- | - | Promise\ | 返回一个Promise，包含接口的结果。 | - -**示例：** - - ``` - let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); - this.context.updateForm(formId, obj2) - .then((data)=>{ - console.log('FormExtension context updateForm, data:' + data); - }).catch((error) => { - console.error('Operation updateForm failed. Cause: ' + error);}); - ``` \ No newline at end of file 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 deleted file mode 100644 index 4a0c2748f211e444f436c7821de63772305d1343..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md +++ /dev/null @@ -1,223 +0,0 @@ -# ServiceExtensionContext - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - - -ServiceExtension的上下文环境，提供ServiceExtension具有的能力和接口，继承自ExtensionContext。 - - -## startAbility - -startAbility(want: Want, callback: AsyncCallback<void>): void; - -启动Ability。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - -**示例：** - - ```js - let want = { - "bundleName": "com.example.myapp", - "abilityName": "com.example.myapp.MyAbility" - }; - this.context.startAbility(want, (err) => { - console.log('startAbility result:' + JSON.stringfy(err)); - }); - ``` - - -## ServiceExtensionContext.startAbility - -startAbility(want: Want): Promise<void>; - -启动Ability。通过Promise返回结果。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | - -**示例：** - - ```js - 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)); - }); - ``` - - -## ServiceExtensionContext.terminateSelf - -terminateSelf(callback: AsyncCallback<void>): void; - -停止Ability自身。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - -**示例：** - - ```js - this.context.terminateSelf((err) => { - console.log('terminateSelf result:' + JSON.stringfy(err)); - }); - ``` - - -## ServiceExtensionContext.terminateSelf - -terminateSelf(): Promise<void>; - -停止自身。通过Promise返回结果。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | - -**示例：** - - ```js - this.context.terminateSelf(want).then((data) => { - console.log('success:' + JSON.stringfy(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringfy(error)); - }); - ``` - - -## ServiceExtensionContext.connectAbility - -connectAbility(want: Want, options: ConnectOptions): number; - -将一个Ability与服务类型的Ability绑定。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - | options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | number | 返回一个number，后续根据这个number去断开连接。 | - -**示例：** - - ```js - 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); - ``` - - -## ServiceExtensionContext.disconnectAbility - -disconnectAbility(connection: number, callback:AsyncCallback<void>): void; - -将一个Ability与绑定的服务类型的Ability解绑。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | connection | number | 是 | 在connectAbility中返回的number。 | - | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | - -**示例：** - - ```js - this.context.disconnectAbility(connection, (err) => { // connection为connectAbility中的返回值 - console.log('terminateSelf result:' + JSON.stringfy(err)); - }); - ``` - - -## ServiceExtensionContext.disconnectAbility - -disconnectAbility(connection: number): Promise<void>; - -将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | connection | number | 是 | 在connectAbility中返回的number。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | - -**示例：** - - ```js - this.context.disconnectAbility(connection).then((data) => { // connection为connectAbility中的返回值 - console.log('success:' + JSON.stringfy(data)); - }).catch((error) => { - console.log('failed:' + JSON.stringfy(error)); - }); - ``` - - -## ConnectOptions - -ConnectOptions数据结构。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 说明 | -| -------- | -------- | -| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | -| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | -| onFailed(code: number) | 连接失败时回调该接口。 |