From 8012663a138bb3f3af73b5d29203345375f65cb8 Mon Sep 17 00:00:00 2001 From: yuyaozhi Date: Thu, 18 May 2023 10:32:37 +0800 Subject: [PATCH] Fix document consistency issues of ability Signed-off-by: yuyaozhi --- .../js-apis-app-ability-abilityConstant.md | 6 +- .../apis/js-apis-app-ability-appManager.md | 14 +- .../apis/js-apis-app-ability-configuration.md | 6 + .../apis/js-apis-app-ability-dataUriUtils.md | 306 ++++---- .../apis/js-apis-app-ability-dialogRequest.md | 679 +++++++++++------- ...js-apis-app-ability-environmentCallback.md | 10 +- .../js-apis-app-ability-quickFixManager.md | 12 +- .../apis/js-apis-app-ability-startOptions.md | 3 - .../apis/js-apis-app-ability-uiAbility.md | 7 +- .../apis/js-apis-app-ability-want.md | 53 +- .../apis/js-apis-app-ability-wantAgent.md | 27 +- .../apis/js-apis-app-ability-wantConstant.md | 16 +- .../apis/js-apis-app-form-formHost.md | 118 +-- .../apis/js-apis-app-form-formInfo.md | 3 + .../apis/js-apis-app-form-formProvider.md | 55 +- .../apis/js-apis-application-appManager.md | 12 +- .../apis/js-apis-application-configuration.md | 7 + .../apis/js-apis-distributedMissionManager.md | 4 +- .../js-apis-inner-ability-connectOptions.md | 4 + ...s-inner-application-abilityStageMonitor.md | 7 +- ...apis-inner-application-abilityStateData.md | 37 +- ...is-inner-application-applicationContext.md | 8 +- ...er-application-applicationStateObserver.md | 18 +- ...apis-inner-application-continueCallback.md | 12 +- ...is-inner-application-continueDeviceInfo.md | 4 + ...js-apis-inner-application-errorObserver.md | 18 +- ...apis-inner-application-missionCallbacks.md | 4 + .../js-apis-inner-application-missionInfo.md | 4 + ...-apis-inner-application-missionListener.md | 10 +- ...apis-inner-application-missionParameter.md | 4 + .../js-apis-inner-application-processData.md | 17 +- ...apis-inner-application-uiAbilityContext.md | 143 ++-- .../js-apis-inner-wantAgent-triggerInfo.md | 4 + .../js-apis-inner-wantAgent-wantAgentInfo.md | 4 + .../reference/apis/js-apis-wantAgent.md | 4 + 35 files changed, 1031 insertions(+), 609 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md index d34d7553e1..74eb654504 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md @@ -30,7 +30,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; Ability初次启动原因，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onCreate(want, launchParam)](js-apis-app-ability-uiAbility.md#uiabilityoncreate)方法根据launchParam.launchReason的不同类型执行相应操作。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | 名称 | 值 | 说明 | | ----------------------------- | ---- | ------------------------------------------------------------ | @@ -58,7 +58,7 @@ class MyAbility extends UIAbility { Ability上次退出原因，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onCreate(want, launchParam)](js-apis-app-ability-uiAbility.md#uiabilityoncreate)方法根据launchParam.lastExitReason的不同类型执行相应操作。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | 名称 | 值 | 说明 | | ----------------------------- | ---- | ------------------------------------------------------------ | @@ -84,7 +84,7 @@ class MyAbility extends UIAbility { Ability迁移结果，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onContinue(wantParam)](js-apis-app-ability-uiAbility.md#uiabilityoncontinue)方法进完成相应的返回。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | 名称 | 值 | 说明 | | ----------------------------- | ---- | ------------------------------------------------------------ | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md index 1f7bf17749..573588860b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md @@ -669,7 +669,11 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\ 切断account进程（Promise形式）。 -**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES，ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS，当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。 +> **说明：** +> +> 当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES，ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -715,12 +719,16 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal 切断account进程（callback形式）。 +> **说明：** +> +> 当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES，ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**: 此接口为系统接口，三方应用不支持调用。 -**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES，ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS，当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。 - **参数：** | 参数名 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md index f7db417887..ec934c197c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md @@ -6,6 +6,12 @@ > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 导入模块 + +```ts +import Configuration from '@ohos.app.ability.Configuration'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md index 74b37b9ae4..15b94a4fb2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md @@ -1,150 +1,156 @@ -# @ohos.app.ability.dataUriUtils (DataUriUtils模块) - -DataUriUtils模块提供用于处理uri对象的能力，包括获取、绑定、删除和更新指定uri对象的路径末尾的ID。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 导入模块 - -```ts -import dataUriUtils from '@ohos.app.ability.dataUriUtils'; -``` - -## dataUriUtils.getId - -getId(uri: string): number - -获取指定uri路径末尾的ID。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | --------------------------- | -| uri | string | 是 | 表示uri对象。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------ | -| number | 返回uri路径末尾的ID。 | - -**示例：** - -```ts -try { - let id = dataUriUtils.getId('com.example.dataUriUtils/1221'); - console.info('get id: ${id}'); -} catch(err) { - console.error('get id err ,check the uri ${err}'); -} -``` - -## dataUriUtils.attachId - -attachId(uri: string, id: number): string - -将ID附加到uri的路径末尾。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | --------------------------- | -| uri | string | 是 | 表示uri对象。 | -| id | number | 是 | 表示要附加的ID。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | --------------------- | -| string | 返回附加ID之后的uri对象。 | - -**示例：** - -```ts -let id = 1122; -try { - let uri = dataUriUtils.attachId( - 'com.example.dataUriUtils', - id, - ); - console.info('attachId the uri is: ${uri}'); -} catch (err) { - console.error('get id err ,check the uri ${err}'); -} - -``` - -## dataUriUtils.deleteId - -deleteId(uri: string): string - -删除指定uri路径末尾的ID。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | --------------------------- | -| uri | string | 是 | 表示要从中删除ID的uri对象。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------- | -| string | 返回删除ID之后的uri对象。 | - -**示例：** - -```ts -try { - let uri = dataUriUtils.deleteId('com.example.dataUriUtils/1221'); - console.info('delete id with the uri is: ${uri}'); -} catch(err) { - console.error('delete uri err, check the input uri ${err}'); -} - -``` - -## dataUriUtils.updateId - -updateId(uri: string, id: number): string - -更新指定uri中的ID。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | ------------------- | -| uri | string | 是 | 表示uri对象 | -| id | number | 是 | 表示要更新的ID | - -**返回值：** - -| 类型 | 说明 | -| ------ | --------------- | -| string | 返回更新ID之后的uri对象。 | - -**示例：** - -```ts - -try { - let id = 1122; - let uri = dataUriUtils.updateId( - 'com.example.dataUriUtils/1221', - id - ); -} catch (err) { - console.error('delete uri err, check the input uri ${err}'); -} -``` - +# @ohos.app.ability.dataUriUtils (DataUriUtils模块) + +DataUriUtils模块提供用于处理uri对象的能力，包括获取、绑定、删除和更新指定uri对象的路径末尾的ID。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```ts +import dataUriUtils from '@ohos.app.ability.dataUriUtils'; +``` + +## dataUriUtils.getId + +getId(uri: string): number + +获取指定uri路径末尾的ID。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------------------------- | +| uri | string | 是 | 表示uri对象。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------ | +| number | 返回uri路径末尾的ID。 | + +**示例：** + +```ts +try { + let id = dataUriUtils.getId('com.example.dataUriUtils/1221'); + console.info('get id: ${id}'); +} catch(err) { + console.error('get id err ,check the uri ${err}'); +} +``` + + + +## dataUriUtils.attachId + +attachId(uri: string, id: number): string + +将ID附加到uri的路径末尾。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------------------------- | +| uri | string | 是 | 表示uri对象。 | +| id | number | 是 | 表示要附加的ID。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | --------------------- | +| string | 返回附加ID之后的uri对象。 | + +**示例：** + +```ts +let id = 1122; +try { + let uri = dataUriUtils.attachId( + 'com.example.dataUriUtils', + id, + ); + console.info('attachId the uri is: ${uri}'); +} catch (err) { + console.error('get id err ,check the uri ${err}'); +} + +``` + + + +## dataUriUtils.deleteId + +deleteId(uri: string): string + +删除指定uri路径末尾的ID。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------------------------- | +| uri | string | 是 | 表示要从中删除ID的uri对象。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------- | +| string | 返回删除ID之后的uri对象。 | + +**示例：** + +```ts +try { + let uri = dataUriUtils.deleteId('com.example.dataUriUtils/1221'); + console.info('delete id with the uri is: ${uri}'); +} catch(err) { + console.error('delete uri err, check the input uri ${err}'); +} + +``` + + + +## dataUriUtils.updateId + +updateId(uri: string, id: number): string + +更新指定uri中的ID。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------------- | +| uri | string | 是 | 表示uri对象 | +| id | number | 是 | 表示要更新的ID | + +**返回值：** + +| 类型 | 说明 | +| ------ | --------------- | +| string | 返回更新ID之后的uri对象。 | + +**示例：** + +```ts + +try { + let id = 1122; + let uri = dataUriUtils.updateId( + 'com.example.dataUriUtils/1221', + id + ); +} catch (err) { + console.error('delete uri err, check the input uri ${err}'); +} +``` + diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md index ebdcfaa9f8..f68d823973 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md @@ -1,262 +1,419 @@ -# @ohos.app.ability.dialogRequest (dialogRequest模块) - -dialogRequest模块用于处理模态弹框的能力，包括获取RequestInfo（用于绑定模态弹框）、获取RequestCallback（用于设置结果）。 -模态弹框是指一个系统弹出框，其特点在于：该弹出框会拦截弹框之下的页面的鼠标、键盘、触屏等事件，销毁该弹框，才能操作下面的页面。 - -> **说明：** -> -> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> - 本模块接口在ServiceExtensionAbility下使用，如果ServiceExtensionAbility实现了模态弹框，则可以使用本模块的接口获取请求方的RequestInfo、RequestCallback并返回请求结果。 - -## 导入模块 - -```js -import dialogRequest from '@ohos.app.ability.dialogRequest'; -``` - -## dialogRequest.getRequestInfo - -getRequestInfo(want: Want): RequestInfo - -从Want中获取请求方的RequestInfo。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | --------------------------- | -| want | [Want](js-apis-application-want.md) | 是 | 表示发起方请求弹框时传入的want信息。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------ | -| [RequestInfo](#requestinfo) | 请求方RequestInfo,用于绑定模态窗口。 | - -**示例：** - -```ts - import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; - import rpc from '@ohos.rpc'; - import dialogRequest from '@ohos.app.ability.dialogRequest'; - - export default class ServiceExtAbility extends ServiceExtensionAbility { - onCreate(want) { - console.info(TAG, `onCreate, want: ${want.abilityName}`); - } - - onRequest(want, startId) { - console.info(TAG, `onRequest, want: ${want.abilityName}`); - try { - var requestInfo = dialogRequest.getRequestInfo(want); - } catch(err) { - console.error('getRequestInfo err= ${JSON.stringify(err)}'); - } - } - - onConnect(want) { - console.info(TAG, `onConnect, want: ${want.abilityName}`); - } - - onDisconnect(want) { - console.info(TAG, `onDisconnect, want: ${want.abilityName}`); - } - - onDestroy() { - console.info(TAG, `onDestroy`); - } - } - ``` - -## dialogRequest.getRequestCallback - -getRequestCallback(want: Want): RequestCallback - -从Want中获取请求方的RequestCallback。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | --------------------------- | -| want | [Want](js-apis-application-want.md) | 是 | 表示发起方请求弹框时传入的want信息。 | - -**返回值：** - -| 类型 | 说明 | -| ------ | ------------------------ | -| [RequestCallback](#requestcallback) | 请求方RequestCallback,用于设置返回结果。 | - -**示例：** - -```ts - import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; - import rpc from '@ohos.rpc'; - import dialogRequest from '@ohos.app.ability.dialogRequest'; - - export default class ServiceExtAbility extends ServiceExtensionAbility { - onCreate(want) { - console.info(TAG, `onCreate, want: ${want.abilityName}`); - } - - onRequest(want, startId) { - console.info(TAG, `onRequest, want: ${want.abilityName}`); - try { - var requestCallback = dialogRequest.getRequestCallback(want); - } catch(err) { - console.error('getRequestInfo err= ${JSON.stringify(err)}'); - } - } - - onConnect(want) { - console.info(TAG, `onConnect, want: ${want.abilityName}`); - } - - onDisconnect(want) { - console.info(TAG, `onDisconnect, want: ${want.abilityName}`); - } - - onDestroy() { - console.info(TAG, `onDestroy`); - } - } - ``` - -## RequestInfo - -表示发起方请求信息，作为窗口绑定模态弹框的入参。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**示例：** - -```ts - import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; - import rpc from '@ohos.rpc'; - import dialogRequest from '@ohos.app.ability.dialogRequest'; - import window from '@ohos.window'; - - export default class ServiceExtAbility extends ServiceExtensionAbility { - onCreate(want) { - console.info(TAG, `onCreate, want: ${want.abilityName}`); - } - - onRequest(want, startId) { - console.info(TAG, `onRequest, want: ${want.abilityName}`); - try { - var requestInfo = dialogRequest.getRequestInfo(want); - window.bindDialogTarget(requestInfo, () => { - console.info('Dialog Window Need Destroy.'); - }, (err) => { - if (err.code) { - console.error('Failed to bind dialog target. Cause: ${JSON.stringify(err)}'); - return; - } - console.info('Succeeded in binding dialog target.'); - }); - } catch(err) { - console.error('getRequestInfo err= ${JSON.stringify(err)}'); - } - } - - onConnect(want) { - console.info(TAG, `onConnect, want: ${want.abilityName}`); - } - - onDisconnect(want) { - console.info(TAG, `onDisconnect, want: ${want.abilityName}`); - } - - onDestroy() { - console.info(TAG, `onDestroy`); - } - } - ``` - -## ResultCode - -模态弹框请求结果码。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore。 - -| 名称 | 值 | 说明 | -| ------------ | ------------------ | ---------------------- | -| RESULT_OK | 0 | 表示成功。 | -| RESULT_CANCEL | 1 | 表示失败。 | - -## RequestResult -模态弹框请求结果，当前只包含结果码，即RequestResult只当前只有ResultCode这一个成员。 - -## 属性 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| result | [ResultCode](#resultcode) | 是 | 是 | 表示结果码。 | - -## RequestCallback - -用于设置模态弹框请求结果的callback接口。 - -### RequestCallback.setRequestResult - -setRequestResult(result: RequestResult): void; - -设置请求结果 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| result | [RequestResult](#requestresult) | 是 | 模态弹框请求结果信息。 | - -**错误码：** - -| 错误码ID | 错误信息 | -| ------- | -------------------------------- | -| 401 | If the input parameter is not valid parameter. | - -以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)。 - -**示例：** - -```ts - import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; - import rpc from '@ohos.rpc'; - import dialogRequest from '@ohos.app.ability.dialogRequest'; - - export default class ServiceExtAbility extends ServiceExtensionAbility { - onCreate(want) { - console.info(TAG, `onCreate, want: ${want.abilityName}`); - } - - onRequest(want, startId) { - console.info(TAG, `onRequest, want: ${want.abilityName}`); - try { - var requestCallback = dialogRequest.getRequestCallback(want); - let myResult = { - result : dialogRequest.ResultCode.RESULT_CANCEL, - }; - requestCallback.setRequestResult(myResult); - } catch(err) { - console.error('getRequestInfo err= ${JSON.stringify(err)}'); - } - } - - onConnect(want) { - console.info(TAG, `onConnect, want: ${want.abilityName}`); - } - - onDisconnect(want) { - console.info(TAG, `onDisconnect, want: ${want.abilityName}`); - } - - onDestroy() { - console.info(TAG, `onDestroy`); - } - } +# @ohos.app.ability.dialogRequest (dialogRequest模块) + +dialogRequest模块用于处理模态弹框的能力，包括获取RequestInfo（用于绑定模态弹框）、获取RequestCallback（用于设置结果）。 +模态弹框是指一个系统弹出框，其特点在于：该弹出框会拦截弹框之下的页面的鼠标、键盘、触屏等事件，销毁该弹框，才能操作下面的页面。 + +> **说明：** +> +> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 本模块接口在ServiceExtensionAbility下使用，如果ServiceExtensionAbility实现了模态弹框，则可以使用本模块的接口获取请求方的RequestInfo、RequestCallback并返回请求结果。 + +## 导入模块 + +```js +import dialogRequest from '@ohos.app.ability.dialogRequest'; +``` + +## dialogRequest.getRequestInfo + +getRequestInfo(want: Want): RequestInfo + +从Want中获取请求方的RequestInfo。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------------------------- | +| want | [Want](js-apis-application-want.md) | 是 | 表示发起方请求弹框时传入的want信息。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------ | +| [RequestInfo](#requestinfo) | 请求方RequestInfo,用于绑定模态窗口。 | + +**示例：** + +```ts + import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; + import rpc from '@ohos.rpc'; + import dialogRequest from '@ohos.app.ability.dialogRequest'; + + const REQUEST_VALUE = 1; + + class StubTest extends rpc.RemoteObject { + constructor(des) { + super(des); + } + + onRemoteRequest(code, data, reply, option) { + if (code === REQUEST_VALUE) { + let optFir = data.readInt(); + let optSec = data.readInt(); + reply.writeInt(optFir + optSec); + } + return true; + } + + queryLocallInterface(descriptor) { + return null; + } + + getInterfaceDescriptor() { + return ""; + } + + getCallingPid() { + return REQUEST_VALUE; + } + + getCallingUid() { + return REQUEST_VALUE; + } + + attachLocalInterface(localInterface, descriptor) { + } + } + + let TAG = "getRequestInfoTest"; + + export default class ServiceExtAbility extends ServiceExtensionAbility { + onCreate(want) { + console.info(TAG, `onCreate, want: ${want.abilityName}`); + } + + onRequest(want, startId) { + console.info(TAG, `onRequest, want: ${want.abilityName}`); + try { + var requestInfo = dialogRequest.getRequestInfo(want); + } catch (err) { + console.error('getRequestInfo err= ${JSON.stringify(err)}'); + } + } + + onConnect(want) { + console.info(TAG, `onConnect, want: ${want.abilityName}`); + return new StubTest("test"); + } + + onDisconnect(want) { + console.info(TAG, `onDisconnect, want: ${want.abilityName}`); + } + + onDestroy() { + console.info(TAG, `onDestroy`); + } + } + ``` + +## dialogRequest.getRequestCallback + +getRequestCallback(want: Want): RequestCallback + +从Want中获取请求方的RequestCallback。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------------------------- | +| want | [Want](js-apis-application-want.md) | 是 | 表示发起方请求弹框时传入的want信息。 | + +**返回值：** + +| 类型 | 说明 | +| ------ | ------------------------ | +| [RequestCallback](#requestcallback) | 请求方RequestCallback,用于设置返回结果。 | + +**示例：** + +```ts + import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; + import rpc from '@ohos.rpc'; + import dialogRequest from '@ohos.app.ability.dialogRequest'; + + let TAG = "getRequestCallbackTest"; + + const REQUEST_VALUE = 1; + + class StubTest extends rpc.RemoteObject { + constructor(des) { + super(des); + } + + onRemoteRequest(code, data, reply, option) { + if (code === REQUEST_VALUE) { + let optFir = data.readInt(); + let optSec = data.readInt(); + reply.writeInt(optFir + optSec); + } + return true; + } + + queryLocallInterface(descriptor) { + return null; + } + + getInterfaceDescriptor() { + return ""; + } + + getCallingPid() { + return REQUEST_VALUE; + } + + getCallingUid() { + return REQUEST_VALUE; + } + + attachLocalInterface(localInterface, descriptor) { + } + } + + export default class ServiceExtAbility extends ServiceExtensionAbility { + onCreate(want) { + console.info(TAG, `onCreate, want: ${want.abilityName}`); + } + + onRequest(want, startId) { + console.info(TAG, `onRequest, want: ${want.abilityName}`); + try { + var requestCallback = dialogRequest.getRequestCallback(want); + } catch(err) { + console.error('getRequestInfo err= ${JSON.stringify(err)}'); + } + } + + onConnect(want) { + console.info(TAG, `onConnect, want: ${want.abilityName}`); + return new StubTest("test"); + } + + onDisconnect(want) { + console.info(TAG, `onDisconnect, want: ${want.abilityName}`); + } + + onDestroy() { + console.info(TAG, `onDestroy`); + } + } + ``` + +## RequestInfo + +表示发起方请求信息，作为窗口绑定模态弹框的入参。 +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**示例：** + +```ts + import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; + import rpc from '@ohos.rpc'; + import dialogRequest from '@ohos.app.ability.dialogRequest'; + import window from '@ohos.window'; + + let TAG = "RequestInfoTest"; + + const REQUEST_VALUE = 1; + + class StubTest extends rpc.RemoteObject { + constructor(des) { + super(des); + } + + onRemoteRequest(code, data, reply, option) { + if (code === REQUEST_VALUE) { + let optFir = data.readInt(); + let optSec = data.readInt(); + reply.writeInt(optFir + optSec); + } + return true; + } + + queryLocallInterface(descriptor) { + return null; + } + + getInterfaceDescriptor() { + return ""; + } + + getCallingPid() { + return REQUEST_VALUE; + } + + getCallingUid() { + return REQUEST_VALUE; + } + + attachLocalInterface(localInterface, descriptor) { + } + } + + export default class ServiceExtAbility extends ServiceExtensionAbility { + onCreate(want) { + console.info(TAG, `onCreate, want: ${want.abilityName}`); + } + + onRequest(want, startId) { + console.info(TAG, `onRequest, want: ${want.abilityName}`); + try { + var requestInfo = dialogRequest.getRequestInfo(want); + window.bindDialogTarget(requestInfo, () => { + console.info('Dialog Window Need Destroy.'); + }, (err) => { + if (err.code) { + console.error('Failed to bind dialog target. Cause: ${JSON.stringify(err)}'); + return; + } + console.info('Succeeded in binding dialog target.'); + }); + } catch(err) { + console.error('getRequestInfo err= ${JSON.stringify(err)}'); + } + } + + onConnect(want) { + console.info(TAG, `onConnect, want: ${want.abilityName}`); + return new StubTest("test"); + + } + + onDisconnect(want) { + console.info(TAG, `onDisconnect, want: ${want.abilityName}`); + } + + onDestroy() { + console.info(TAG, `onDestroy`); + } + } + ``` + +## ResultCode + +模态弹框请求结果码。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +| 参数名 | 值 | 说明 | +| ------------ | ------------------ | ---------------------- | +| RESULT_OK | 0 | 表示成功。 | +| RESULT_CANCEL | 1 | 表示失败。 | + +## RequestResult +模态弹框请求结果，当前只包含结果码，即RequestResult只当前只有ResultCode这一个成员。 + +## 属性 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| result | [ResultCode](#resultcode) | 是 | 是 | 表示结果码。 | + +## RequestCallback + +用于设置模态弹框请求结果的callback接口。 + +### RequestCallback.setRequestResult + +setRequestResult(result: RequestResult): void; + +设置请求结果 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| result | [RequestResult](#requestresult) | 是 | 模态弹框请求结果信息。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | + +以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)。 + +**示例：** + +```ts + import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility'; + import rpc from '@ohos.rpc'; + import dialogRequest from '@ohos.app.ability.dialogRequest'; + + let TAG = "setRequestResultTest"; + + const REQUEST_VALUE = 1; + + class StubTest extends rpc.RemoteObject { + constructor(des) { + super(des); + } + + onRemoteRequest(code, data, reply, option) { + if (code === REQUEST_VALUE) { + let optFir = data.readInt(); + let optSec = data.readInt(); + reply.writeInt(optFir + optSec); + } + return true; + } + + queryLocallInterface(descriptor) { + return null; + } + + getInterfaceDescriptor() { + return ""; + } + + getCallingPid() { + return REQUEST_VALUE; + } + + getCallingUid() { + return REQUEST_VALUE; + } + + attachLocalInterface(localInterface, descriptor) { + } + } + + export default class ServiceExtAbility extends ServiceExtensionAbility { + onCreate(want) { + console.info(TAG, `onCreate, want: ${want.abilityName}`); + } + + onRequest(want, startId) { + console.info(TAG, `onRequest, want: ${want.abilityName}`); + try { + var requestCallback = dialogRequest.getRequestCallback(want); + let myResult = { + result : dialogRequest.ResultCode.RESULT_CANCEL, + }; + requestCallback.setRequestResult(myResult); + } catch(err) { + console.error('getRequestInfo err= ${JSON.stringify(err)}'); + } + } + + onConnect(want) { + console.info(TAG, `onConnect, want: ${want.abilityName}`); + return new StubTest("test"); + } + + onDisconnect(want) { + console.info(TAG, `onDisconnect, want: ${want.abilityName}`); + } + + onDestroy() { + console.info(TAG, `onDestroy`); + } + } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md index a2cdfc3ff1..30c2239379 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md @@ -45,9 +45,8 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; **示例：** - - ```ts -import UIAbility from '@ohos.app.ability.UIAbility'; +```ts +import UIAbility from '@ohos.app.ability.Ability'; let callbackId; @@ -57,8 +56,9 @@ export default class MyAbility extends UIAbility { globalThis.applicationContext = this.context.getApplicationContext(); let EnvironmentCallback = { onConfigurationUpdated(config){ - console.log('onConfigurationUpdated config:' + JSON.stringify(config)); + console.log(`onConfigurationUpdated config: ${JSON.stringify(config)}`); }, + onMemoryLevel(level){ console.log('onMemoryLevel level: ${JSON.stringify(level)}'); } @@ -76,4 +76,4 @@ export default class MyAbility extends UIAbility { }); } } - ``` \ No newline at end of file +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md index a5dbda2be0..9fa29082f8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md @@ -66,10 +66,10 @@ applyQuickFix(hapModuleQuickFixFiles: Array\, callback: AsyncCallback\): Promise\; | 错误码ID | 错误信息 | | ------- | -------- | -| 18500002 | Copy file failed, maybe not exist or inaccessible. | +| 18500002 | The specified quick fix is invalid. It may not exist or inaccessible. | | 18500008 | Internal error. | -在打补丁过程中发生的错误，其错误码及错误信息通过公共事件[COMMON_EVENT_QUICK_FIX_APPLY_RESULT](commonEvent-definitions.md#common_event_quick_fix_apply_result9)的参数返回给应用开发者。这部分错误码及错误信息如下： +在打补丁过程中发生的错误，其错误码及错误信息通过公共事件[COMMON_EVENT_QUICK_FIX_APPLY_RESULT](commonEventManager-definitions.md#common_event_quick_fix_apply_result-9)的参数返回给应用开发者。这部分错误码及错误信息如下： | 错误码ID | 错误信息 | | ------- | -------- | @@ -185,7 +185,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器）。在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | | uri | string | 否 | 表示携带的数据，一般配合type使用，指明待处理的数据类型。如果在Want中指定了uri，则Want将匹配指定的Uri信息，包括`scheme`、`schemeSpecificPart`、`authority`和`path`信息。 | | type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如：'text/xml' 、 'image/*'等，MIME定义请参见https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | -| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：
- ohos.aafwk.callerPid：表示拉起方的pid。
- ohos.aafwk.param.callerBundleName：表示拉起方的Bundle Name。
- ohos.aafwk.param.callerToken：表示拉起方的token。
- ohos.aafwk.param.callerUid：表示[BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。
- component.startup.newRules：表示是否启用新的管控规则。
- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。
- ohos.dlp.params.sandbox：表示dlp文件才会有。 | +| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：
- ohos.aafwk.callerPid：表示拉起方的pid。
- ohos.aafwk.param.callerBundleName：表示拉起方的Bundle Name。
- ohos.aafwk.param.callerToken：表示拉起方的token。
- ohos.aafwk.param.callerUid：表示[BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。
- component.startup.newRules：表示是否启用新的管控规则。
- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。
- ohos.dlp.params.sandbox：表示dlp文件才会有。
- ability.params.backToOtherMissionStack：表示是否支持跨任务链返回。 | | [flags](js-apis-ability-wantConstant.md#wantconstantflags) | number | 否 | 表示处理Want的方式。默认传数字。
例如通过wantConstant.Flags.FLAG_ABILITY_CONTINUATION表示是否以设备间迁移方式启动Ability。 | **示例：** @@ -34,7 +34,8 @@ import Want from '@ohos.app.ability.Want'; - 基础用法：在UIAbility对象中调用，示例中的context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。 ```ts - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let want = { 'deviceId': '', // deviceId为空表示本设备 'bundleName': 'com.example.myapplication', @@ -52,7 +53,8 @@ import Want from '@ohos.app.ability.Want'; * 字符串（String） ```ts - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let want = { bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', @@ -67,7 +69,8 @@ import Want from '@ohos.app.ability.Want'; ``` * 数字（Number） ```ts - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let want = { bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', @@ -83,7 +86,8 @@ import Want from '@ohos.app.ability.Want'; ``` * 布尔（Boolean） ```ts - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let want = { bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', @@ -98,7 +102,8 @@ import Want from '@ohos.app.ability.Want'; ``` * 对象（Object） ```ts - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let want = { bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', @@ -118,7 +123,8 @@ import Want from '@ohos.app.ability.Want'; ``` * 数组（Array） ```ts - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let want = { bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', @@ -138,7 +144,8 @@ import Want from '@ohos.app.ability.Want'; ```ts import fs from '@ohos.file.fs'; - let context = ...; // UIAbilityContext + import common from '@ohos.app.ability.common'; + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext let fd; try { @@ -160,3 +167,33 @@ import Want from '@ohos.app.ability.Want'; console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); }); ``` + - parameter参数用法：以ability.params.backToOtherMissionStack为例，ServiceExtension在拉起UIAbility的时候，可以支持跨任务链返回。 + + ```ts + // (1) UIAbility1启动一个ServiceExtension + let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext + let want = { + bundleName: 'com.example.myapplication1', + abilityName: 'ServiceExtensionAbility', + }; + + context.startAbility(want, (err) => { + console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); + }); + + // (2) 该ServiceExtension去启动另一个UIAbility2，并在启动的时候携带参数ability.params.backToOtherMissionStack为true + let context = ...; // ServiceExtensionContext + let want = { + bundleName: 'com.example.myapplication2', + abilityName: 'MainAbility', + parameters: { + "ability.params.backToOtherMissionStack": true, + }, + }; + + context.startAbility(want, (err) => { + console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); + }); + ``` + + 说明：上例中，如果ServiceExtension启动UIAbility2时不携带ability.params.backToOtherMissionStack参数，或者携带的ability.params.backToOtherMissionStack参数为false，则UIAbility1和UIAbility2不在同一个任务栈里面，在UIAbility2的界面点back键，不会回到UIAbility1的界面。如果携带的ability.params.backToOtherMissionStack参数为true，则表示支持跨任务链返回，此时在UIAbility2的界面点back键，会回到UIAbility1的界面。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md index 59a9a8ba62..73551d324a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md @@ -113,10 +113,8 @@ getWantAgent(info: WantAgentInfo): Promise\ **示例：** -```js -import WantAgent from '@ohos.app.ability.wantAgent'; - - +```ts +let wantAgent; //WantAgentInfo对象 let wantAgentInfo = { wants: [ @@ -1126,6 +1124,27 @@ let wantAgentInfo = { wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] }; +//getWantAgent回调 +function getWantAgentCallback(err, data) { + if (err === undefined) { + wantAgent = data; + } else { + console.error('getWantAgent failed ${JSON.stringify(wantAgent)}'); + } + //getOperationTypeCallback回调 + function getOperationTypeCallback(err, data) { + if(err) { + console.error('getOperationType failed! ${err.code} ${err.message}'); + } else { + console.info('getOperationType ok! ${JSON.stringify(data)}'); + } + } + try { + WantAgent.getOperationType(wantAgent, getOperationTypeCallback); + } catch(err) { + console.error('getOperationTypeCallback failed! ${err.code} ${err.message}'); + } +} try { WantAgent.getWantAgent(wantAgentInfo).then((data) => { console.info('==========================>getWantAgentCallback=======================>'); diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md index 9ca76cf932..10db9966d4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md @@ -18,14 +18,14 @@ want操作的常数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 名称 | 值 | 说明 | -| ------------ | ------------------ | ---------------------- | -| DLP_PARAMS_SANDBOX |ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_BUNDLE_NAME |ohos.dlp.params.bundleName |指示DLP包名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_MODULE_NAME |ohos.dlp.params.moduleName |指示DLP模块名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_ABILITY_NAME |ohos.dlp.params.abilityName |指示DLP能力名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_INDEX |ohos.dlp.params.index |指示DLP索引参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| ABILITY_BACK_TO_OTHER_MISSION_STACK |ability.params.backToOtherMissionStack |表示该Ability能返回到其它任务栈中。 | +| 名称 | 值 | 说明 | +| ----------------------- | ---------------------------------- | ------------------------------------------------------------------------------ | +| DLP_PARAMS_SANDBOX | ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_BUNDLE_NAME | ohos.dlp.params.bundleName | 指示DLP Bundle名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_MODULE_NAME | ohos.dlp.params.moduleName | 指示DLP模块名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_ABILITY_NAME | ohos.dlp.params.abilityName | 指示DLP能力名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_INDEX | ohos.dlp.params.index | 指示DLP索引参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| ABILITY_BACK_TO_OTHER_MISSION_STACK | ability.params.backToOtherMissionStack | 表示是否支持跨任务链返回。
**系统API**：该接口为系统接口，三方应用不支持调用。 | ## wantConstant.Flags diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md index 512a4ccefc..4c8035b511 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md @@ -35,14 +35,15 @@ deleteForm(formId: string, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | -------- | | 201 | Permissions denied. | +| 202 | The application is not a system application. | | 401 | If the input parameter is not valid parameter. | | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | -| 202 | The application is not a system application. | | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -97,7 +98,8 @@ deleteForm(formId: string): Promise<void> | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **参数：** @@ -143,7 +145,8 @@ releaseForm(formId: string, callback: AsyncCallback<void>): void | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -190,7 +193,8 @@ releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback< | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -242,7 +246,8 @@ releaseForm(formId: string, isReleaseCache?: boolean): Promise<void> | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -288,7 +293,8 @@ requestForm(formId: string, callback: AsyncCallback<void>): void | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -339,7 +345,8 @@ requestForm(formId: string): Promise<void> | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -386,7 +393,8 @@ castToNormalForm(formId: string, callback: AsyncCallback<void>): void | 16501001 | The ID of the form to be operated does not exist. | | 16501002 | The number of forms exceeds upper bound. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -437,7 +445,8 @@ castToNormalForm(formId: string): Promise<void> | 16501001 | The ID of the form to be operated does not exist. | | 16501002 | The number of forms exceeds upper bound. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -481,7 +490,8 @@ notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -530,7 +540,8 @@ notifyVisibleForms(formIds: Array<string>): Promise<void> | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -574,7 +585,8 @@ notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<vo | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -623,7 +635,8 @@ notifyInvisibleForms(formIds: Array<string>): Promise<void> | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -668,7 +681,8 @@ enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void& | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -718,7 +732,8 @@ enableFormsUpdate(formIds: Array<string>): Promise<void> | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -764,7 +779,8 @@ disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -815,7 +831,8 @@ disableFormsUpdate(formIds: Array<string>): Promise<void> | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -852,7 +869,8 @@ isSystemReady(callback: AsyncCallback<void>): void | -------- | -------- | | 202 | The application is not a system application. | | 401 | If the input parameter is not valid parameter. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -888,7 +906,8 @@ isSystemReady(): Promise<void> | 错误码ID | 错误信息 | | -------- | -------- | | 202 | The application is not a system application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -925,7 +944,8 @@ getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **参数：** @@ -968,7 +988,8 @@ getAllFormsInfo(): Promise<Array<formInfo.FormInfo>> | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **返回值：** @@ -1018,7 +1039,8 @@ getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.Fo | 16500060 | A service connection error happened, please try again later. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1065,7 +1087,8 @@ getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback< | 16500060 | A service connection error happened, please try again later. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1117,7 +1140,8 @@ getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formI | 16500060 | A service connection error happened, please try again later. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1160,7 +1184,8 @@ deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<numb | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1211,7 +1236,8 @@ deleteInvalidForms(formIds: Array<string>): Promise<number> | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1256,7 +1282,8 @@ acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo&g | 16500060 | A service connection error happened, please try again later. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1317,7 +1344,8 @@ acquireFormState(want: Want): Promise<formInfo.FormStateInfo> | 16500060 | A service connection error happened, please try again later. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1364,7 +1392,8 @@ on(type: 'formUninstall', callback: Callback<string>): void | -------- | -------- | | 202 | The application is not a system application. | | 401 | If the input parameter is not valid parameter. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1396,7 +1425,8 @@ off(type: 'formUninstall', callback?: Callback<string>): void | -------- | -------- | | 202 | The application is not a system application. | | 401 | If the input parameter is not valid parameter. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1436,7 +1466,8 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: A | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1487,7 +1518,8 @@ notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise< | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1533,7 +1565,8 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, c | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1584,7 +1617,8 @@ notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1629,7 +1663,8 @@ shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>) | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1681,7 +1716,8 @@ shareForm(formId: string, deviceId: string): Promise<void> | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **参数：** @@ -1725,7 +1761,8 @@ notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean, callb | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -| 以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 | | + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -1746,7 +1783,7 @@ try { ## notifyFormsPrivacyProtected -function notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean): Promise\; +notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean): Promise\; 通知指定卡片隐私保护状态改变。使用Promise异步回调。 @@ -1777,7 +1814,8 @@ function notifyFormsPrivacyProtected(formIds: Array\, isProtected: bool | 16500050 | An IPC connection error happened. | | 16500060 | A service connection error happened, please try again later. | | 16501000 | An internal functional error occurred. | -| 以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 | | + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 ```ts import formHost from '@ohos.app.form.formHost'; diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md index a2f7519881..b71e342a70 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md @@ -18,6 +18,8 @@ import formInfo from '@ohos.app.form.formInfo'; **系统能力**：SystemCapability.Ability.Form +**系统API**: 此接口为系统接口，三方应用不支持调用。 + | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ | | bundleName | string | 是 | 否 | 卡片所属包的包名。 | @@ -136,5 +138,6 @@ import formInfo from '@ohos.app.form.formInfo'; | 名称 | 值 | 说明 | | ----------- | ---- | ------------ | +| UNKNOWN | 0 | 表示卡片为未知。 | | FORM_VISIBLE | 1 | 表示卡片为可见。 | | FORM_INVISIBLE | 2 | 表示卡片为不可见。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md index 56ceccaa5c..fb4d1c2667 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md @@ -39,7 +39,8 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l | 16501001 | The ID of the form to be operated does not exist. | | 16501002 | The number of forms exceeds upper bound. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -91,7 +92,8 @@ setFormNextRefreshTime(formId: string, minute: number): Promise<void> | 16501001 | The ID of the form to be operated does not exist. | | 16501002 | The number of forms exceeds upper bound. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -135,12 +137,14 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** ```ts -import formBindingData from '@ohos.application.formBindingData'; +import formBindingData from '@ohos.app.form.formBindingData'; + var formId = '12400633174999288'; try { let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); @@ -188,14 +192,16 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr | 16501000 | An internal functional error occurred. | | 16501001 | The ID of the form to be operated does not exist. | | 16501003 | The form can not be operated by the current application. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** ```ts -import formBindingData from '@ohos.application.formBindingData'; -var formId = '12400633174999288'; -let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); +import formBindingData from '@ohos.app.form.formBindingData'; + +let formId = '12400633174999288'; +let obj = formBindingData.createFormBindingData({ temperature: '22c', time: '22:00' }); try { formProvider.updateForm(formId, obj).then(() => { console.log('formProvider updateForm success'); @@ -228,7 +234,8 @@ getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): voi | 16500050 | An IPC connection error happened. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -269,7 +276,8 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array&l | 16500050 | An IPC connection error happened. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -321,7 +329,8 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.For | 16500050 | An IPC connection error happened. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -370,13 +379,15 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, | 16500050 | An IPC connection error happened. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** ```ts -import formBindingData from '@ohos.application.formBindingData'; -var want = { +import formBindingData from '@ohos.app.form.formBindingData'; + +let want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -424,12 +435,13 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void | 16500050 | An IPC connection error happened. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** ```ts -var want = { +let want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -483,12 +495,13 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData | 16500050 | An IPC connection error happened. | | 16500100 | Failed to obtain the configuration information. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** ```ts -var want = { +let want = { abilityName: 'FormAbility', parameters: { 'ohos.extra.param.key.form_dimension': 2, @@ -531,7 +544,8 @@ isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void | 401 | If the input parameter is not valid parameter. | | 16500050 | An IPC connection error happened. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** @@ -593,7 +607,8 @@ isRequestPublishFormSupported(): Promise<boolean> | 202 | The application is not a system application. | | 16500050 | An IPC connection error happened. | | 16501000 | An internal functional error occurred. | -|以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。|| + +以上错误码的详细介绍请参见[卡片错误码](../errorcodes/errorcode-form.md)。 **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md index 84ae31e59c..7fb2ded431 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-appManager.md @@ -389,7 +389,11 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\ 切断account进程（Promise形式）。 -**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES +> **说明：** +> +> 当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。 + +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES，ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -423,11 +427,15 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal 切断account进程（callback形式）。 +> **说明：** +> +> 当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。 + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**: 此接口为系统接口，三方应用不支持调用。 -**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES +**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES，ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md index e499403a30..a65f8c5b6d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-configuration.md @@ -3,9 +3,16 @@ 定义环境变化信息。Configuration是接口定义，仅做字段声明。 > **说明：** +> > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块从API version 9废弃，替换模块为[@ohos.app.ability.Configuration (Configuration)](js-apis-app-ability-configuration.md) +## 导入模块 + +```ts +import Configuration from '@ohos.app.application.Configuration'; +``` + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md b/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md index d346ef568f..c5f817c83f 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md @@ -360,7 +360,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callba 迁移任务，以回调函数的方式返回。 -**需要权限**：ohos.permission.MANAGE_MISSIONS and ohos.permission.DISTRIBUTED_DATASYNC +**需要权限**：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC **系统能力**：SystemCapability.Ability.AbilityRuntime.Mission @@ -418,7 +418,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi 迁移任务，以promise方式返回执行结果。 -**需要权限**：ohos.permission.MANAGE_MISSIONS and ohos.permission.DISTRIBUTED_DATASYNC +**需要权限**：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC **系统能力**：SystemCapability.Ability.AbilityRuntime.Mission diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md index ccac9612b0..9c92bed376 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md @@ -2,6 +2,10 @@ 在连接指定的后台服务时作为入参用于接收连接过程中的状态变化，如作为[connectServiceExtensionAbility](js-apis-inner-application-serviceExtensionContext.md#serviceextensioncontextconnectserviceextensionability)的入参连接指定的ServiceExtensionAbility。 +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md index 8f750ec63b..ba0cb0ff28 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md @@ -2,13 +2,16 @@ 提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。 +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| moduleName9+ | string | 是 | 是 | 要监视的abilityStage的模块名。 | -| srcEntrance9+ | string | 是 | 是 | 要监视的abilityStage的源路径。 | +| moduleName | string | 是 | 是 | 要监视的abilityStage的模块名。 | +| srcEntrance | string | 是 | 是 | 要监视的abilityStage的源路径。 | **示例：** ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md index 846c202e4c..583121d76c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md @@ -2,6 +2,10 @@ 定义Ability状态信息，可以通过[registerApplicationStateObserver](js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8)注册生命周期变化监听后，通过[ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md)的onAbilityStateChanged生命周期回调获取。 +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts @@ -12,11 +16,30 @@ import appManager from '@ohos.application.appManager'; | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------- | ---------| ---- | ---- | ------------------------- | -| pid8+ | number | 是 | 否 | 进程ID。 | -| bundleName8+ | string | 是 | 否 | 应用包名。 | -| abilityName8+ | string | 是 | 否 | Ability名称。 | -| uid8+ | number | 是 | 否 | 用户ID。 | -| state8+ | number | 是 | 否 | Ability状态。 | -| moduleName9+ | string | 是 | 否 | Ability所属的HAP包的名称。 | -| abilityType8+ | string | 是 | 否 | Ability类型：页面或服务等。 | +| pid | number | 是 | 否 | 进程ID。 | +| bundleName | string | 是 | 否 | 应用Bundle名称。 | +| abilityName | string | 是 | 否 | Ability名称。 | +| uid | number | 是 | 否 | 用户ID。 | +| state | number | 是 | 否 | [Ability状态](#ability状态)。 | +| moduleName9+ | string | 是 | 否 | Ability所属的HAP的名称。 | +| abilityType | number | 是 | 否 | [Ability类型](#ability类型)：页面或服务等。 | + +#### Ability状态 +| 值 | 状态 | 说明 | +| ---- | -------------------------- | ---------------------- | +| 0 | ABILITY_STATE_CREATE | Ability正在创建中 | +| 1 | ABILITY_STATE_READY | Ability已创建完成 | +| 2 | ABILITY_STATE_FOREGROUND | Ability处于前台 | +| 3 | ABILITY_STATE_FOCUS | Ability已经获焦 | +| 4 | ABILITY_STATE_BACKGROUND | Ability处于后台 | +| 5 | ABILITY_STATE_TERMINATED | Ability已经销毁 | +| 8 | ABILITY_STATE_CONNECTED | 后台服务已被客户端连接 | +| 9 | ABILITY_STATE_DISCONNECTED | 后台服务客户端断开连接 | + +#### Ability类型 +| 值 | 状态 | 说明 | +| ---- | ------- | --------------------- | +| 0 | UNKNOWN | 未知类型 | +| 1 | PAGE | UI界面类型的Ability | +| 2 | SERVICE | 后台服务类型的Ability | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md index 7bc37cd463..38939d9821 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md @@ -301,7 +301,6 @@ getRunningProcessInformation(): Promise\>; **示例：** ```ts -let applicationContext = this.context.getApplicationContext(); applicationContext.getRunningProcessInformation().then((data) => { console.log('The process running information is:' + JSON.stringify(data)); }).catch((error) => { @@ -339,7 +338,6 @@ getRunningProcessInformation(callback: AsyncCallback\ **示例：** ```ts -let applicationContext = this.context.getApplicationContext(); applicationContext.getRunningProcessInformation((err, data) => { if (err.code !== 0) { console.error('getRunningProcessInformation faile, err: ' + JSON.stringify(err)); @@ -407,10 +405,16 @@ killProcessesBySelf(callback: AsyncCallback\); **示例：** ```ts +<<<<<<< HEAD let applicationContext = this.context.getApplicationContext(); applicationContext.killProcessesBySelf(err => { if (err.code !== 0) { console.error('killProcessesBySelf faile, err: ' + JSON.stringify(err)); +======= +applicationContext.killAllProcesses(error => { + if (error) { + console.error('killAllProcesses fail, error: ${JSON.stringify(error)}'); +>>>>>>> 9643df3c1b (Fix document consistency issues of ability) } }) ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md index 3468d620a6..b60fa74791 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md @@ -2,10 +2,14 @@ 定义应用状态监听，可以作为[registerApplicationStateObserver](js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8)的入参监听当前应用的生命周期变化。 +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts -import appManager from '@ohos.application.appManager'; +import appManager from '@ohos.app.ability.appManager'; ``` **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -14,16 +18,14 @@ import appManager from '@ohos.application.appManager'; | 名称 | | 类型 | 可读 | 可写 | 说明 | | ----------------------- | ---------| ---- | ---- | ------------------------- | ------------------------- | -| onForegroundApplicationChanged8+ | [AppStateData](js-apis-inner-application-appStateData.md) | AsyncCallback\ | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 | -| onAbilityStateChanged8+ | [AbilityStateData](js-apis-inner-application-abilityStateData.md) | AsyncCallback\ | 是 | 否 | ability状态发生变化时执行的回调函数。 | -| onProcessCreated8+ | [ProcessData](js-apis-inner-application-processData.md) | AsyncCallback\ | 是 | 否 | 进程创建时执行的回调函数。 | -| onProcessDied8+ | [ProcessData](js-apis-inner-application-processData.md) | AsyncCallback\ | 是 | 否 | 进程销毁时执行的回调函数。 | -| onProcessStateChanged8+ | [ProcessData](js-apis-inner-application-processData.md) | AsyncCallback\ | 是 | 否 | 进程状态更新时执行的回调函数。 | +| onForegroundApplicationChanged | [AppStateData](js-apis-inner-application-appStateData.md) | AsyncCallback\ | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 | +| onAbilityStateChanged | [AbilityStateData](js-apis-inner-application-abilityStateData.md) | AsyncCallback\ | 是 | 否 | ability状态发生变化时执行的回调函数。 | +| onProcessCreated | [ProcessData](js-apis-inner-application-processData.md) | AsyncCallback\ | 是 | 否 | 进程创建时执行的回调函数。 | +| onProcessDied | [ProcessData](js-apis-inner-application-processData.md) | AsyncCallback\ | 是 | 否 | 进程销毁时执行的回调函数。 | +| onProcessStateChanged9+ | [ProcessData](js-apis-inner-application-processData.md) | AsyncCallback\ | 是 | 否 | 进程状态更新时执行的回调函数。 | **示例：** ```ts -import appManager from "@ohos.application.appManager"; - let applicationStateObserver = { onForegroundApplicationChanged(appStateData) { console.log('onForegroundApplicationChanged appStateData: ' + JSON.stringify(appStateData)); diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md index 7e12ce10bf..2212426881 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md @@ -1,6 +1,16 @@ # ContinueCallback -表示迁移完成后，返回迁移结果回调函数，可以作为[continueMission](js-apis-distributedMissionManager.md#distributedmissionmanagercontinuemission)的入参监听迁移回调。 +表示跨设备迁移Mission完成后，返回迁移结果的回调函数，迁移Mission详见：[continueMission接口](js-apis-distributedMissionManager.md#distributedmissionmanagercontinuemission)。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## ContinueCallback.onContinueDone + +onContinueDone(result: number): void; + +Mission迁移完成后调用，返回迁移结果。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Mission diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md index 39761db2a1..ea1ee33f71 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md @@ -2,6 +2,10 @@ 表示发起任务迁移时所需参数的枚举，可以作为[continueMission](js-apis-distributedMissionManager.md#distributedmissionmanagercontinuemission)的入参指定迁移相关参数。 +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + **系统能力**：SystemCapability.Ability.AbilityRuntime.Mission | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md index e6caa78afe..3ad1659ef1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md @@ -2,6 +2,10 @@ 定义异常监听，可以作为[errorManager.on](js-apis-app-ability-errorManager.md#errormanageron)的入参监听当前应用发生的异常。 +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts @@ -28,9 +32,15 @@ onUnhandledException(errMsg: string): void; import errorManager from '@ohos.app.ability.errorManager'; let observer = { - onUnhandledException(errorMsg) { - console.log('onUnhandledException, errorMsg: ' + JSON.stringify(errorMsg)); - } + onUnhandledException(errorMsg) { + console.error('onUnhandledException, errorMsg: ', errorMsg); + } }; -errorManager.on('error',observer); + +try { + errorManager.on('error', observer); +} catch (error) { + console.error('registerErrorObserver failed, error.code: ${error.code}, error.message: ${error.message}'); +} +``` ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md index a4885d4fdd..085745b151 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md @@ -2,6 +2,10 @@ 作为可以[registerMissionListener](js-apis-distributedMissionManager.md#distributedmissionmanagerregistermissionlistener)的入参，表示开始同步后，建立的回调函数。 +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + **系统能力**：SystemCapability.Ability.AbilityRuntime.Mission | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md index 089302a56f..0015992f72 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md @@ -2,6 +2,10 @@ 表示Ability对应的任务信息，可以通过[getMissionInfo](js-apis-app-ability-missionManager.md#missionmanagergetmissioninfo)获取。 +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md index fc7e9d754e..4bf839e5f1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md @@ -2,6 +2,10 @@ 定义系统任务状态监听，可以通过[registerMissionListener](js-apis-application-missionManager.md#missionmanagerregistermissionlistener)注册。 +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts @@ -16,9 +20,9 @@ import missionManager from '@ohos.app.ability.missionManager'; | onMissionDestroyed | function | 否 | 表示当系统销毁任务时回调执行。 | | onMissionSnapshotChanged | function | 否 | 表示当系统更新任务缩略图时回调执行。 | | onMissionMovedToFront | function | 否 | 表示当系统将任务移动到前台时回调执行。 | -| onMissionLabelUpdated | function | 否 | 表示当系统更新任务标签时回调执行。 | -| onMissionIconUpdated | function | 否 | 表示当系统更新任务图标时回调执行。 | -| onMissionClosed | function | 否 | 表示当系统关闭任务时回调执行。 | +| onMissionLabelUpdated9+ | function | 否 | 表示当系统更新任务标签时回调执行。 | +| onMissionIconUpdated9+ | function | 否 | 表示当系统更新任务图标时回调执行。 | +| onMissionClosed9+ | function | 否 | 表示当系统关闭任务时回调执行。 | **示例：** ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md index e96ca676a5..b8fe388bb0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md @@ -2,6 +2,10 @@ 作为[startSyncRemoteMissions](js-apis-distributedMissionManager.md#distributedmissionmanagerstartsyncremotemissions)的入参，表示同步时所需参数的枚举。 +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + **系统能力**：SystemCapability.Ability.AbilityRuntime.Mission | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md index cc7947bd6f..6bcaf701ab 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md @@ -2,10 +2,14 @@ 定义进程数据，可以通过[registerApplicationStateObserver](js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8)注册生命周期变化监听后，通过[ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md)的onProcessCreated生命周期回调获取。 +> **说明：** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts -import appManager from '@ohos.app.ability.appManager'; +import appManager from '@ohos.application.appManager'; ``` **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -14,11 +18,12 @@ import appManager from '@ohos.app.ability.appManager'; | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------- | ---------| ---- | ---- | ------------------------- | -| pid8+ | number | 是 | 否 | 进程ID。 | -| bundleName8+ | string | 是 | 否 | 应用包名。 | -| uid8+ | number | 是 | 否 | 用户ID。 | -| isContinuousTask9+ | boolean | 是 | 否 | 判断过程是否为连续任务。 | -| isKeepAlive9+ | boolean | 是 | 否 | 判断该过程是否保持活跃。 | +| pid | number | 是 | 否 | 进程ID。 | +| bundleName | string | 是 | 否 | 应用包名。 | +| uid | number | 是 | 否 | 应用的uid。 | +| isContinuousTask9+ | boolean | 是 | 否 | 是否为长时任务，true表示是，false表示不是 | +| isKeepAlive9+ | boolean | 是 | 否 | 是否为常驻进程，true表示是，false表示不是 | +| state9+ | number | 是 | 否 | 应用的状态，取值及对应的状态为：0(刚创建)，2(前台)，4(后台)，5(已终止)。 | **示例：** ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md index 15f0510cc5..656a73101d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md @@ -366,23 +366,20 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback windowMode: 0, }; - try { - this.context.startAbilityForResult(want, options, (error, result) => { - if (error.code) { - // 处理业务逻辑错误 - console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) + - ' error.message: ' + JSON.stringify(error.message)); - return; - } - // 执行正常业务 - console.log('startAbilityForResult succeed, result.resultCode = ' + - result.resultCode) - }); - } catch (paramError) { - // 处理入参错误异常 - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } +try { + this.context.startAbilityForResult(want, options, (err, result) => { + if (err.code) { + // 处理业务逻辑错误 + console.error(`startAbilityForResult failed, code is ${err.code}, message is ${err.message}`); + return; + } + // 执行正常业务 + console.info('startAbilityForResult succeed'); + }); +} catch (err) { + // 处理入参错误异常 + console.error(`startAbilityForResult failed, code is ${err.code}, message is ${err.message}`); +} ``` @@ -785,22 +782,20 @@ startServiceExtensionAbility(want: Want): Promise\; abilityName: 'MainAbility' }; - try { - this.context.startServiceExtensionAbility(want) - .then((data) => { - // 执行正常业务 - console.log('startServiceExtensionAbility succeed'); - }) - .catch((error) => { - // 处理业务逻辑错误 - console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) + - ' error.message: ' + JSON.stringify(error.message)); - }); - } catch (paramError) { - // 处理入参错误异常 - console.log('error.code: ' + JSON.stringify(paramError.code) + - ' error.message: ' + JSON.stringify(paramError.message)); - } +try { + this.context.startServiceExtensionAbility(want) + .then(() => { + // 执行正常业务 + console.info('startServiceExtensionAbility succeed'); + }) + .catch((err) => { + // 处理业务逻辑错误 + console.error(`startServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`); + }); +} catch (err) { + // 处理入参错误异常 + console.error(`startServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`); +} ``` ## UIAbilityContext.startServiceExtensionAbilityWithAccount @@ -1410,15 +1405,22 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; **示例：** ```ts - let want = { - deviceId: '', - bundleName: 'com.extreme.test', - abilityName: 'MainAbility' - }; - let options = { - onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, - onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, - onFailed(code) { console.log('----------- onFailed -----------') } +let want = { + deviceId: '', + bundleName: 'com.example.myapplication', + abilityName: 'ServiceExtensionAbility' +}; +let commRemote; +let options = { + onConnect(elementName, remote) { + commRemote = remote; + console.info('onConnect...') + }, + onDisconnect(elementName) { + console.info('onDisconnect...') + }, + onFailed(code) { + console.info('onFailed...') } let connection = null; @@ -1472,16 +1474,23 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options **示例：** ```ts - let want = { - deviceId: '', - bundleName: 'com.extreme.test', - abilityName: 'MainAbility' - }; - let accountId = 100; - let options = { - onConnect(elementName, remote) { console.log('----------- onConnect -----------') }, - onDisconnect(elementName) { console.log('----------- onDisconnect -----------') }, - onFailed(code) { console.log('----------- onFailed -----------') } +let want = { + deviceId: '', + bundleName: 'com.example.myapplication', + abilityName: 'ServiceExtensionAbility' +}; +let accountId = 100; +let commRemote; +let options = { + onConnect(elementName, remote) { + commRemote = remote; + console.info('onConnect...') + }, + onDisconnect(elementName) { + console.info('onDisconnect...') + }, + onFailed(code) { + console.info('onFailed...') } let connection = null; @@ -1526,8 +1535,8 @@ disconnectServiceExtensionAbility(connection: number): Promise\; **示例：** ```ts - // connection为connectServiceExtensionAbility中的返回值 - let connection = 1; +// connection为connectServiceExtensionAbility中的返回值 +let connection = 1; try { this.context.disconnectServiceExtensionAbility(connection) @@ -1574,8 +1583,26 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\ { + commRemote = null; + if (err.code) { + // 处理业务逻辑错误 + console.error(`disconnectServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`); + return; + } + // 执行正常业务 + console.info('disconnectServiceExtensionAbility succeed'); + }); +} catch (err) { + commRemote = null; + // 处理入参错误异常 + console.error(`disconnectServiceExtensionAbility failed, code is ${err.code}, message is ${err.message}`); +} try { this.context.disconnectServiceExtensionAbility(connection, (error) => { @@ -1931,7 +1958,7 @@ requestPermissionsFromUser(permissions: Array<string>, requestCallback: As | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | permissions | Array<string> | 是 | 权限列表。 | -| callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionRequestResult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | +| callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 是 | 回调函数，返回接口调用是否成功的结果。 | **示例：** @@ -1962,7 +1989,7 @@ requestPermissionsFromUser(permissions: Array<string>) : Promise<Permis | 类型 | 说明 | | -------- | -------- | -| Promise<[PermissionRequestResult](js-apis-permissionRequestResult.md)> | 返回一个Promise，包含接口的结果。 | +| Promise<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | 返回一个Promise，包含接口的结果。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md index 8a32144ecf..e641ed3d1c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md @@ -2,6 +2,10 @@ 作为[trigger](js-apis-app-ability-wantAgent.md#wantagenttrigger)的入参定义触发WantAgent所需要的信息。 +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md index df7c43d3cc..6adfe0d53e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md @@ -2,6 +2,10 @@ 定义触发WantAgent所需要的信息，可以作为[getWantAgent](js-apis-app-ability-wantAgent.md#wantagentgetwantagent)的入参创建指定的WantAgent对象。 +> **说明：** +> +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 导入模块 ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md index 26b5437c73..5f33db0ad4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md @@ -20,6 +20,8 @@ getWant(agent: WantAgent, callback: AsyncCallback\): void **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**：该接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -91,6 +93,8 @@ getWant(agent: WantAgent): Promise\ **系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统API**：该接口为系统接口，三方应用不支持调用。 + **参数：** | 参数名 | 类型 | 必填 | 说明 | -- GitLab