diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md index 8701519dfa429e90b52fed68a3afef915a01fbab..c8bea07c956706ab0546173aad3078f12efb2e1e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -46,13 +46,6 @@ want操作的常数。 | ACTION_FILE_SELECT7+ | ohos.action.fileSelect | 指示选择文件的操作。 | | PARAMS_STREAM7+ | ability.params.stream | 指示发送数据时与目标关联的数据流的URI。对应的value必须是string类型的数组。 | | ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 | -| ACTION_APP_ACCOUNT_AUTH 9+ | account.appAccount.action.auth | 指示提供auth服务的操作。 | -| ACTION_MARKET_DOWNLOAD 9+ | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| ACTION_MARKET_CROWDTEST 9+ | ohos.want.action.marketCrowdTest | 指示从应用程序市场众测应用程序的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_SANDBOX9+ |ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_BUNDLE_NAME9+ |ohos.dlp.params.bundleName |指示DLP包名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_MODULE_NAME9+ |ohos.dlp.params.moduleName |指示DLP模块名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_ABILITY_NAME9+ |ohos.dlp.params.abilityName |指示DLP能力名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | | DLP_PARAMS_INDEX9+ |ohos.dlp.params.index |指示DLP索引参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | ## wantConstant.Entity 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 d6aa11ab90b056846308457efa6f4ad9da0d370a..2d20bb09725bc12dbe0d3ffefb11ce05021dfe91 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 @@ -99,7 +99,7 @@ import UIAbility from '@ohos.app.ability.UIAbility'; class MyAbility extends UIAbility { onContinue(wantParam) { - return AbilityConstant.OnConinueResult.AGREE; + return AbilityConstant.OnContinueResult.AGREE; } } ``` @@ -132,7 +132,7 @@ let option = { }; // 确保从上下文获取到context -this.context.startAbility(want, option).then(()={ +this.context.startAbility(want, option).then(()=>{ console.log('Succeed to start ability.'); }).catch((error)=>{ console.log('Failed to start ability with error: ' + JSON.stringify(error)); diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md index e10b75fc766e5c20f2bbca4695574b8992765c4a..e511535d7b85570b065b391be98ff71e8c5e11b7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md @@ -275,7 +275,7 @@ export default class MyFirstAbility extends UIAbility { // 2.通过applicationContext注册监听应用内生命周期 try { globalThis.lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback); - console.log('registerAbilityLifecycleCallback number: ' + JSON.stringify(lifecycleId)); + console.log('registerAbilityLifecycleCallback lifecycleId: ${globalThis.lifecycleId}'); } catch (paramError) { console.log('error: ' + paramError.code + ' ,' + paramError.message); } @@ -285,7 +285,7 @@ export default class MyFirstAbility extends UIAbility { MySecondAbility.ts ```ts -import UIAbility from 'ohos.app.ability.UIAbility'; +import UIAbility from '@ohos.app.ability.UIAbility'; export default class MySecondAbility extends UIAbility { onDestroy() { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md index bca1c482f54aeaaffb034aeb0ab657f4e23e318d..c9ade064e323489c370936b4e1e52279ce06b893 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md @@ -59,12 +59,13 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\): void ```ts import abilityManager from '@ohos.app.ability.abilityManager'; +import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant'; const config = { language: 'Zh-Hans', // 简体中文 - colorMode: COLOR_MODE_LIGHT, // 浅色模式 - direction: DIRECTION_VERTICAL, // 垂直方向 - screenDensity: SCREEN_DENSITY_SDPI, // 屏幕像素密度为'sdpi' + colorMode: ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT, // 浅色模式 + direction: ConfigurationConstant.Direction.DIRECTION_VERTICAL, // 垂直方向 + screenDensity: ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_SDPI, // 屏幕像素密度为'sdpi' displayId: 1, // 应用在Id为1的物理屏上显示 hasPointerDevice: true, // 指针类型设备已连接 }; @@ -117,12 +118,13 @@ updateConfiguration(config: Configuration): Promise\ ```ts import abilityManager from '@ohos.app.ability.abilityManager'; +import ConfigurationConstant from '@ohos.app.ability.ConfigurationConstant'; const config = { language: 'Zh-Hans', // 简体中文 - colorMode: COLOR_MODE_LIGHT, // 浅色模式 - direction: DIRECTION_VERTICAL, // 垂直方向 - screenDensity: SCREEN_DENSITY_SDPI, // 屏幕像素密度为'sdpi' + colorMode: ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT, // 浅色模式 + direction: ConfigurationConstant.Direction.DIRECTION_VERTICAL, // 垂直方向 + screenDensity: ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_SDPI, // 屏幕像素密度为'sdpi' displayId: 1, // 应用在Id为1的物理屏上显示 hasPointerDevice: true, // 指针类型设备已连接 }; 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 f28cef3305da8e31e4c0f2f3f3a6195dcfcf930b..1f7bf1774933e5d8c4a80598492eeb7244d30c10 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 @@ -459,7 +459,7 @@ off(type: 'applicationState', observerId: number, callback: AsyncCallback\; ```ts import appManager from '@ohos.app.ability.appManager'; -let observeId = 0; +let observerId = 0; // 1.注册应用状态监听器 let applicationStateObserver = { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md index 110cb380dae1299ccbdf4dd009d1f7a7b813f8a0..8a768f9340084a436573e5849d2ada39bd238309 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md @@ -72,9 +72,9 @@ import AbilityStage from '@ohos.app.ability.AbilityStage'; export default class MyAbilityStage extends AbilityStage { onCreate() { appRecovery.enableAppRecovery( - appRecovery.RestartFlag::ALWAYS_RESTART, - appRecovery.SaveOccasionFlag::SAVE_WHEN_ERROR, - appRecovery.SaveModeFlag::SAVE_WITH_FILE + appRecovery.RestartFlag.ALWAYS_RESTART, + appRecovery.SaveOccasionFlag.SAVE_WHEN_ERROR, + appRecovery.SaveModeFlag.SAVE_WITH_FILE ); } } diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md index a051e73d34fac74b9b8a40a3ae2ec06bf6cb3275..4c49b588f2ec64569323eda71fcc02520bfa7d4f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md @@ -24,7 +24,6 @@ import common from '@ohos.app.ability.common'; | Context | [Context](js-apis-inner-application-context.md) | 否 | Context二级模块。 | | ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | 否 | ExtensionContext二级模块。 | | FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 否 | FormExtensionContext二级模块。 | -| AreaMode | [AreaMode](#areamode) | 否 | AreaMode枚举值。 | | EventHub | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 | | PermissionRequestResult | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 | | PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | 否 | PacMap二级模块。 | @@ -42,7 +41,6 @@ let baseContext: common.BaseContext; let context: common.Context; let extensionContext: common.ExtensionContext; let formExtensionContext: common.FormExtensionContext; -let areaMode: common.AreaMode; let eventHub: common.EventHub; let permissionRequestResult: common.PermissionRequestResult; let pacMap: common.PacMap; 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 new file mode 100644 index 0000000000000000000000000000000000000000..74b37b9ae47045c7278ecb661aa8bc6be176ed65 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md @@ -0,0 +1,150 @@ +# @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 new file mode 100644 index 0000000000000000000000000000000000000000..ebdcfaa9f82decdf3a8b69b402a7280e35e63531 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md @@ -0,0 +1,262 @@ +# @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`); + } + } + ``` \ 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 966d68466c737df532edd8d6fd96468e4638c396..a2cdfc3ff1838c2f3478f31506f728817e05c7e8 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 @@ -35,7 +35,7 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; 注册系统环境变化的监听后，在系统内存变化时触发回调。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **参数：** @@ -47,11 +47,11 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; ```ts -import Ability from '@ohos.application.Ability'; +import UIAbility from '@ohos.app.ability.UIAbility'; let callbackId; -export default class MyAbility extends Ability { +export default class MyAbility extends UIAbility { onCreate() { console.log('MyAbility onCreate'); globalThis.applicationContext = this.context.getApplicationContext(); diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md index 9bc6061aaa3ac79a159bc7d09587d2c191e554c0..5970ff7e44d17a4c18e751e0df5c87c9d28e3170 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md @@ -43,20 +43,63 @@ on(type:'mission', listener: MissionListener): number; **示例：** ```ts - let listener = { - onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');}, - onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');}, - onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');}, - onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');}, - onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');}, - onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');} - }; - console.log('registerMissionListener'); - try { - let listenerid = missionManager.on('mission', listener); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } +import missionManager from '@ohos.app.ability.missionManager'; +import UIAbility from '@ohos.app.ability.UIAbility'; + +let listener = { + onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');}, + onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');}, + onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');}, + onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');}, + onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');}, + onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');}, + onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');} +}; + +let listenerId = -1; + +export default class EntryAbility extends UIAbility { + onCreate(want, launchParam) { + console.log('[Demo] EntryAbility onCreate'); + globalThis.abilityWant = want; + globalThis.context = this.context; + } + + onDestroy() { + try { + if (listenerId !== -1) { + missionManager.off('mission', listenerId).catch(function (err) { + console.log(err); + }); + } + } catch (paramError) { + console.error('error: ${paramError.code}, ${paramError.message}'); + } + console.log('[Demo] EntryAbility onDestroy'); + } + + onWindowStageCreate(windowStage) { + // Main window is created, set main page for this ability + console.log('[Demo] EntryAbility onWindowStageCreate'); + try { + listenerId = missionManager.on('mission', listener); + } catch (paramError) { + console.error('error: ${paramError.code}, ${paramError.message}'); + } + + windowStage.loadContent('pages/index', (err, data) => { + if (err.code) { + console.error('Failed to load the content. Cause: ${JSON.stringify(err)}'); + return; + } + console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}'); + }); + + if (globalThis.flag) { + return; + } + } +}; ``` @@ -82,24 +125,63 @@ off(type: 'mission', listenerId: number, callback: AsyncCallback<void>): v **示例：** ```ts - let listener = { - onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');}, - onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');}, - onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');}, - onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');}, - onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');}, - onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');} - }; - console.log('registerMissionListener'); - try { - let listenerid = missionManager.registerMissionListener(listener); - - missionManager.unregisterMissionListener(listenerid, (error) => { - console.log('unregisterMissionListener'); - }); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } +import missionManager from '@ohos.app.ability.missionManager'; +import UIAbility from '@ohos.app.ability.UIAbility'; + +let listener = { + onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');}, + onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');}, + onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');}, + onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');}, + onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');}, + onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');}, + onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');} +}; + +let listenerId = -1; + +export default class EntryAbility extends UIAbility { + onCreate(want, launchParam) { + console.log('[Demo] EntryAbility onCreate'); + globalThis.abilityWant = want; + globalThis.context = this.context; + } + + onDestroy() { + try { + if (listenerId !== -1) { + missionManager.off('mission', listenerId, (err) => { + console.log(err); + }); + } + } catch (paramError) { + console.error('error: ${paramError.code}, ${paramError.message}'); + } + console.log('[Demo] EntryAbility onDestroy'); + } + + onWindowStageCreate(windowStage) { + // Main window is created, set main page for this ability + console.log('[Demo] EntryAbility onWindowStageCreate'); + try { + listenerId = missionManager.on('mission', listener); + } catch (paramError) { + console.error('error: ${paramError.code}, ${paramError.message}'); + } + + windowStage.loadContent('pages/index', (err, data) => { + if (err.code) { + console.error('Failed to load the content. Cause: ${JSON.stringify(err)}'); + return; + } + console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}'); + }); + + if (globalThis.flag) { + return; + } + } +}; ``` @@ -130,24 +212,63 @@ off(type: 'mission', listenerId: number): Promise<void>; **示例：** ```ts - let listener = { - onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');}, - onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');}, - onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');}, - onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');}, - onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');}, - onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');} - }; - console.log('registerMissionListener'); - try { - let listenerid = missionManager.registerMissionListener(listener); - - missionManager.unregisterMissionListener(listenerid).catch(function (err) { - console.log(err); - }); - } catch (paramError) { - console.log('error: ' + paramError.code + ', ' + paramError.message); - } +import missionManager from '@ohos.app.ability.missionManager'; +import UIAbility from '@ohos.app.ability.UIAbility'; + +let listener = { + onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');}, + onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');}, + onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');}, + onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');}, + onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');}, + onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');}, + onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');} +}; + +let listenerId = -1; + +export default class EntryAbility extends UIAbility { + onCreate(want, launchParam) { + console.log('[Demo] EntryAbility onCreate'); + globalThis.abilityWant = want; + globalThis.context = this.context; + } + + onDestroy() { + try { + if (listenerId !== -1) { + missionManager.off('mission', listenerId).catch(function (err) { + console.log(err); + }); + } + } catch (paramError) { + console.error('error: ${paramError.code}, ${paramError.message}'); + } + console.log('[Demo] EntryAbility onDestroy'); + } + + onWindowStageCreate(windowStage) { + // Main window is created, set main page for this ability + console.log('[Demo] EntryAbility onWindowStageCreate'); + try { + listenerId = missionManager.on('mission', listener); + } catch (paramError) { + console.error('error: ${paramError.code}, ${paramError.message}'); + } + + windowStage.loadContent('pages/index', (err, data) => { + if (err.code) { + console.error('Failed to load the content. Cause: ${JSON.stringify(err)}'); + return; + } + console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}'); + }); + + if (globalThis.flag) { + return; + } + } +}; ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md index ddda0b602d0f544c5c43047cfa4da9cefe01d161..6e293f30d4b68adfe449b868d1fe784759394fd8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md @@ -106,7 +106,7 @@ Extension生命周期回调，如果是startAbility或者startServiceExtensionAb ## ServiceExtensionAbility.onConnect -onConnect(want: Want): rpc.RemoteObject; +onConnect(want: Want): rpc.RemoteObject | Promise; Extension生命周期回调，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于和客户端进行通信。 @@ -148,7 +148,7 @@ Extension生命周期回调，如果是connectAbility拉起的服务，会在onC ## ServiceExtensionAbility.onDisconnect -onDisconnect(want: Want): void; +onDisconnect(want: Want): void | Promise; Extension的生命周期，断开服务连接时回调。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md index 367e94498822e7665b0bc583372475d581ce7077..099cbe477d98666b33febbbac1d36824ce2a79c9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md @@ -126,7 +126,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void ## Ability.onDestroy -onDestroy(): void; +onDestroy(): void | Promise<void>; Ability生命周期回调，在销毁时回调，执行资源清理等操作。 @@ -183,7 +183,7 @@ Ability生命周期回调，当应用从前台转到后台时触发。 ## Ability.onContinue -onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; +onContinue(wantParam: { [key: string]: Object }): AbilityConstant.OnContinueResult; 当ability迁移准备迁移时触发，保存数据。 @@ -205,7 +205,7 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; ```ts import AbilityConstant from '@ohos.app.ability.AbilityConstant'; - class MyUIAbility extends UIAbility { + class MyUIAbility extends Ability { onContinue(wantParams) { console.log('onContinue'); wantParams['myData'] = 'my1234567'; @@ -233,7 +233,7 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; **示例：** ```ts - class MyUIAbility extends UIAbility { + class MyUIAbility extends Ability { onNewWant(want, launchParams) { console.log('onNewWant, want:' + want.abilityName); console.log('onNewWant, launchParams:' + JSON.stringify(launchParams)); @@ -269,7 +269,7 @@ onDump(params: Array\): Array\; ## Ability.onSaveState -onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult; +onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: Object}): AbilityConstant.OnSaveResult; 该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存Ability状态。 @@ -293,7 +293,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}) ```ts import AbilityConstant from '@ohos.app.ability.AbilityConstant'; -class MyUIAbility extends UIAbility { +class MyUIAbility extends Ability { onSaveState(reason, wantParam) { console.log('onSaveState'); wantParam['myData'] = 'my1234567'; @@ -310,7 +310,7 @@ class MyUIAbility extends UIAbility { ## Caller.call -call(method: string, data: rpc.Sequenceable): Promise<void>; +call(method: string, data: rpc.Parcelable): Promise<void>; 向通用组件服务端发送约定序列化数据。 @@ -321,7 +321,7 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 | + | data | [rpc.Parcelable](js-apis-rpc.md#parcelabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** @@ -339,7 +339,6 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; class MyMessageAble{ // 自定义的Sequenceable数据结构 name:'' str:'' @@ -391,7 +390,7 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; ## Caller.callWithResult -callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessageParcel>; +callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageParcel>; 向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。 @@ -402,7 +401,7 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 | + | data | [rpc.Parcelable](js-apis-rpc.md#parcelabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** @@ -420,7 +419,6 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; class MyMessageAble{ name:'' str:'' @@ -492,7 +490,6 @@ release(): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; let caller; export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { @@ -518,7 +515,7 @@ release(): void; ## Caller.onRelease - onRelease(callback: OnReleaseCallBack): void; + onRelease(callback: OnReleaseCallback): void; 注册通用组件服务端Stub（桩）断开监听通知。 @@ -528,12 +525,11 @@ release(): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 | + | callback | [OnReleaseCallback](#onreleasecallback) | 是 | 返回onRelease回调结果。 | **示例：** ```ts - import Ability from '@ohos.application.Ability'; let caller; export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { @@ -572,7 +568,7 @@ release(): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 监听releaseCall事件，固定为'release'。 | - | callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 | + | callback | [OnReleaseCallback](#onreleasecallback) | 是 | 返回onRelease回调结果。 | **错误码：** @@ -584,7 +580,6 @@ release(): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; let caller; export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { @@ -623,7 +618,7 @@ off(type: 'release', callback: OnReleaseCallback): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 监听releaseCall事件，固定为'release'。 | -| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回off回调结果。 | +| callback | [OnReleaseCallback](#onreleasecallback) | 是 | 返回off回调结果。 | **错误码：** @@ -636,7 +631,7 @@ off(type: 'release', callback: OnReleaseCallback): void; ```ts let caller; - export default class MainUIAbility extends UIAbility { + export default class MainUIAbility extends Ability { onWindowStageCreate(windowStage) { this.context.startAbilityByCall({ bundleName: 'com.example.myservice', @@ -687,7 +682,7 @@ off(type: 'release'): void; ```ts let caller; - export default class MainUIAbility extends UIAbility { + export default class MainUIAbility extends Ability { onWindowStageCreate(windowStage) { this.context.startAbilityByCall({ bundleName: 'com.example.myservice', @@ -742,7 +737,6 @@ on(method: string, callback: CalleeCallback): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; class MyMessageAble{ name:'' str:'' @@ -809,7 +803,6 @@ off(method: string): void; **示例：** ```ts - import Ability from '@ohos.app.ability.UIAbility'; let method = 'call_Function'; export default class MainAbility extends Ability { onCreate(want, launchParam) { @@ -836,10 +829,10 @@ off(method: string): void; ## CalleeCallback -(indata: rpc.MessageParcel): rpc.Sequenceable; +(indata: rpc.MessageParcel): rpc.Parcelable; **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore | 名称 | 可读 | 可写 | 类型 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (indata: [rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)) | 是 | 否 | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 被调用方注册的消息侦听器函数接口的原型。 | +| (indata: [rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)) | 是 | 否 | [rpc.Parcelable](js-apis-rpc.md#parcelabledeprecated) | 被调用方注册的消息侦听器函数接口的原型。 | 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 61e93ef54ea01f4c7cc4f3cd2d18506c290d9513..9ca76cf932e991e28451e43ee08069e97683f29f 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 @@ -12,7 +12,7 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。 import wantConstant from '@ohos.app.ability.wantConstant'; ``` -## wantConstant.Action +## wantConstant.Params want操作的常数。 @@ -20,54 +20,12 @@ want操作的常数。 | 名称 | 值 | 说明 | | ------------ | ------------------ | ---------------------- | -| ACTION_HOME | ohos.want.action.home | 指示返回原点的操作。 | -| ACTION_DIAL | ohos.want.action.dial | 指示启动显示小键盘的页面功能的操作 | -| ACTION_SEARCH | ohos.want.action.search | 指示启动页面搜索功能的操作。 | -| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 指示启动提供无线网络设置的页面功能的操作，例如，Wi-Fi选项。 | -| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 指示启动管理已安装应用程序的页面功能的操作。 | -| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 指示启动显示指定应用程序详细信息的页面功能的操作。 | -| ACTION_SET_ALARM | ohos.want.action.setAlarm | 指示启动页面功能以设置闹钟的操作。 | -| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 指示启动显示所有警报的页面功能的操作时钟。 | -| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 指示启动用于使闹钟睡眠的页面功能的操作。 | -| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 指示启动删除闹钟的页面功能的操作。 | -| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 指示启动页面功能以关闭计时器的操作。 | -| ACTION_SEND_SMS | ohos.want.action.sendSms | 指示启动发送sms的页面功能的操作。 | -| ACTION_CHOOSE | ohos.want.action.choose | 指示启动页面功能以打开联系人或图片的操作。 | -| ACTION_IMAGE_CAPTURE | ohos.want.action.imageCapture | 指示启动页面拍照功能的操作。 | -| ACTION_VIDEO_CAPTURE | ohos.want.action.videoCapture | 指示启动页面功能以拍摄视频的操作。 | -| ACTION_SELECT | ohos.want.action.select | 指示显示应用程序选择对话框的操作。 | -| ACTION_SEND_DATA | ohos.want.action.sendData | 指示发送单个数据记录的操作。 | -| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 指示发送多个数据记录的操作。 | -| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | 指示请求媒体扫描仪扫描文件并将文件添加到媒体库的操作。 | -| ACTION_VIEW_DATA | ohos.want.action.viewData | 指示查看数据的操作。 | -| ACTION_EDIT_DATA | ohos.want.action.editData | 指示编辑数据的操作。 | -| INTENT_PARAMS_INTENT | ability.want.params.INTENT | 指示用行为选择器来展示选择的操作。 | -| INTENT_PARAMS_TITLE | ability.want.params.TITLE | 指示与行为选择器一起使用时的字符序列对话框标题。 | -| ACTION_FILE_SELECT | ohos.action.fileSelect | 指示选择文件的操作。 | -| PARAMS_STREAM | ability.params.stream | 指示发送数据时与目标关联的数据流的URI | | -| ACTION_APP_ACCOUNT_AUTH | account.appAccount.action.auth | 指示提供auth服务的操作。 | -| ACTION_MARKET_DOWNLOAD | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| ACTION_MARKET_CROWDTEST | ohos.want.action.marketCrowdTest | 指示从应用程序市场众测应用程序的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | | 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**：该接口为系统接口，三方应用不支持调用。 | - -## wantConstant.Entity - -want实体的常数。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| ------------ | ------------------ | ---------------------- | -| ENTITY_DEFAULT | entity.system.default | 指示默认实体，如果未指定该实体，则使用该实体。 | -| ENTITY_HOME | entity.system.home | 指示主屏幕实体。 | -| ENTITY_VOICE | entity.system.voice | 表示语音交互实体。 | -| ENTITY_BROWSABLE | entity.system.browsable | 指示浏览器类别。 | -| ENTITY_VIDEO | entity.system.video | 指示视频类别。 | - +| ABILITY_BACK_TO_OTHER_MISSION_STACK |ability.params.backToOtherMissionStack |表示该Ability能返回到其它任务栈中。 | ## wantConstant.Flags diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md index 7cc5a26b23c12e0f5143981d4862ba5ba1650e12..0ce7ae017d36acd9b7a18268178aa16a5c8e3983 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md @@ -45,6 +45,8 @@ onAddForm(want: Want): formBindingData.FormBindingData ```ts import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; +import formBindingData from'@ohos.app.form.formBindingData'; + export default class MyFormExtensionAbility extends FormExtensionAbility { onAddForm(want) { console.log('FormExtensionAbility onAddForm, want:' + want.abilityName); @@ -247,7 +249,7 @@ class MyFormExtensionAbility extends FormExtensionAbility { ## onShareForm -onShareForm?(formId: string): { [key: string]: any } +onShareForm?(formId: string): { [key: string]: Object } 卡片提供方接收卡片分享的通知接口。 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 40a7493130806351bd0ff2c242e4b1a5687eaae1..cc71359aaebbbb065bead3ff291a2955bd20be17 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 @@ -31,7 +31,6 @@ import formInfo from '@ohos.app.form.formInfo'; | isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 | | updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 | | formVisibleNotify | string | 是 | 否 | 卡片是否使能可见通知。 | -| relatedBundleName | string | 是 | 否 | 卡片所属的相关联包名。 | | scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 | | formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 | | updateDuration | string | 是 | 否 | 卡片更新周期。 | 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 81b5b8fa9c541ea575842f552b7ff2d35161e451..0a1265070b5bdebcb07d3a4c4f525d932c74265c 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 @@ -243,7 +243,8 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array&l **示例：** ```ts -import formInfo from '@ohos.application.formInfo'; +import formInfo from '@ohos.app.form.formInfo'; + const filter : formInfo.FormInfoFilter = { // get info of forms belong to module entry. moduleName : 'entry' @@ -291,7 +292,8 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.For **示例：** ```ts -import formInfo from '@ohos.application.formInfo'; +import formInfo from '@ohos.app.form.formInfo'; + const filter : formInfo.FormInfoFilter = { // get info of forms belong to module entry. moduleName : 'entry' diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md deleted file mode 100644 index 5d203e65258053d5df1822f037899289d4aab808..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ /dev/null @@ -1,117 +0,0 @@ -# @ohos.application.AbilityConstant (AbilityConstant) - -AbilityConstant是启动参数的接口。 - -AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.AbilityConstant](js-apis-app-ability-abilityConstant.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import AbilityConstant from '@ohos.application.AbilityConstant'; -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 指示启动原因。 | -| lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 表示最后退出原因。 | - -## AbilityConstant.LaunchReason - -初次开始原因的类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| ----------------------------- | ---- | ------------------------------------------------------------ | -| UNKNOWN | 0 | 未知的状态。 | -| START_ABILITY | 1 | 启动能力。 | -| CALL | 2 | 呼叫。 | -| CONTINUATION | 3 | 继续。 | -| APP_RECOVERY | 4 | 状态恢复。 | - - -## AbilityConstant.LastExitReason - -上次退出原因的类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| ----------------------------- | ---- | ------------------------------------------------------------ | -| UNKNOWN | 0 | 未知的状态。 | -| ABILITY_NOT_RESPONDING | 1 | 能力没有反应 | -| NORMAL | 2 | 正常的状态。 | - - -## AbilityConstant.OnContinueResult - -继续结果的类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| ----------------------------- | ---- | ------------------------------------------------------------ | -| AGREE | 0 | 同意。 | -| REJECT | 1 | 拒绝。 | -| MISMATCH | 2 | 不匹配。| - -## AbilityConstant.WindowMode - -启动Ability时的窗口模式。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| --- | --- | --- | -| WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 | -| WINDOW_MODE_FULLSCREEN | 1 | 全屏模式。 | -| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏多窗口主要模式。 | -| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏多窗口次要模式。 | -| WINDOW_MODE_FLOATING | 102 | 自由悬浮形式窗口模式。 | - -## AbilityConstant.MemoryLevel - -内存级别的类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| --- | --- | --- | -| MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 | -| MEMORY_LEVEL_LOW | 1 | 内存占用低。 | -| MEMORY_LEVEL_CRITICAL | 2 | 内存占用高。 | - -## AbilityConstant.OnSaveResult - -保存应用数据的结果类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| ----------------------------- | ---- | ------------------------------------------------------------ | -| ALL_AGREE | 0 | 同意保存状态。 | -| CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 | -| CONTINUATION_MISMATCH | 2 | 迁移不匹配。| -| RECOVERY_AGREE | 3 | 同意恢复保存状态。 | -| RECOVERY_REJECT | 4 | 拒绝恢复保存状态。| -| ALL_REJECT | 5 | 拒绝保存状态。| - -## AbilityConstant.StateType - -保存应用数据场景原因类型。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| ----------------------------- | ---- | ------------------------------------------------------------ | -| CONTINUATION | 0 | 迁移保存状态。 | -| APP_RECOVERY | 1 | 应用恢复保存状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md deleted file mode 100644 index 131e0a6e9b226b9d888fac49b16633c693b513f6..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md +++ /dev/null @@ -1,50 +0,0 @@ -# AbilityMonitor - -AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方法的能力，最近匹配的ability对象将保存在AbilityMonitor对象中。 - -> **说明：** -> -> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[abilityMonitor (AbilityMonitor)](js-apis-inner-application-abilityMonitor.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -## 使用说明 - -通过abilityDelegator中的addAbilityMonitor来设置。 - -```js -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; -let abilityDelegator; - -function onAbilityCreateCallback(data) { - console.info("onAbilityCreateCallback"); -} - -let monitor = { - abilityName: "abilityname", - onAbilityCreate: onAbilityCreateCallback -}; - -abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityMonitor(monitor, (err : any) => { - console.info("addAbilityMonitor callback"); -}); -``` - -## AbilityMonitor - -Ability监听器 - -系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | -| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称 | -| moduleName? | string | 是 | 是 | 当前AbilityMonitor绑定的module名称 | -| onAbilityCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability被启动初始化时的回调函数
不设置该属性则不能收到该生命周期回调 | -| onAbilityForeground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability状态变成前台时的回调函数
不设置该属性则不能收到该生命周期回调 | -| onAbilityBackground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability状态变成后台时的回调函数
不设置该属性则不能收到该生命周期回调 | -| onAbilityDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
| -| onWindowStageCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被创建时的回调函数
不设置该属性则不能收到该生命周期回调
| -| onWindowStageRestore?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被重载时的回调函数
不设置该属性则不能收到该生命周期回调
| -| onWindowStageDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
| - - diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md deleted file mode 100644 index 432ffcc0d526a861e616846d94551a71f5a99d1f..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityStage.md +++ /dev/null @@ -1,127 +0,0 @@ -# @ohos.application.AbilityStage (AbilityStage) - -AbilityStage是HAP包的运行时类。 - -AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。 - -> **说明：** -> -> 本模块首批接口从API version 9 开始支持, 从API version 9废弃，替换模块为[@ohos.app.ability.AbilityStage](js-apis-app-ability-abilityStage.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import AbilityStage from '@ohos.application.AbilityStage'; -``` - -## AbilityStage.onCreate - -onCreate(): void - -当应用创建时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**示例：** - - ```ts - class MyAbilityStage extends AbilityStage { - onCreate() { - console.log("MyAbilityStage.onCreate is called") - } - } - ``` - - -## AbilityStage.onAcceptWant - -onAcceptWant(want: Want): string; - -启动一个specified ability时触发的事件。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | string | 用户返回一个ability标识，如果之前启动过标识的ability，不创建新的实例并拉回栈顶，否则创建新的实例并启动。 | - -**示例：** - - ```ts - class MyAbilityStage extends AbilityStage { - onAcceptWant(want) { - console.log("MyAbilityStage.onAcceptWant called"); - return "com.example.test"; - } - } - ``` - - -## AbilityStage.onConfigurationUpdated - -onConfigurationUpdated(config: Configuration): void; - -环境变化通知接口，发生全局配置变更时回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-application-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 | - -**示例：** - - ```ts - class MyAbilityStage extends AbilityStage { - onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, language:' + config.language); - } - } - ``` - -## AbilityStage.onMemoryLevel - -onMemoryLevel(level: AbilityConstant.MemoryLevel): void; - -当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| - -**示例：** - - ```ts - class MyAbilityStage extends AbilityStage { - onMemoryLevel(level) { - console.log('onMemoryLevel, level:' + JSON.stringify(level)); - } - } - ``` - -## AbilityStage.context - -context: AbilityStageContext; - -指示有关上下文的配置信息。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -| 属性名 | 类型 | 说明 | -| ----------- | --------------------------- | ------------------------------------------------------------ | -| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.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 6adedd0564201fe8876bb935176b2be3b9944f72..84ae31e59cba0c6443fc039acecaac5cd85b7217 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 @@ -252,49 +252,6 @@ registerApplicationStateObserver(observer: ApplicationStateObserver): number; console.log('-------- observerCode: ---------', observerCode); ``` -## appManager.registerApplicationStateObserver9+ - -registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\): number; - -注册指定应用程序状态观测器。 - -**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**：该接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 | -| bundleNameList | Array | 是 | 表示需要注册监听的bundleName数组。最大值128。 | - -**示例：** - - ```ts - let applicationStateObserver = { - onForegroundApplicationChanged(appStateData) { - console.log('------------ onForegroundApplicationChanged -----------', appStateData); - }, - onAbilityStateChanged(abilityStateData) { - console.log('------------ onAbilityStateChanged -----------', abilityStateData); - }, - onProcessCreated(processData) { - console.log('------------ onProcessCreated -----------', processData); - }, - onProcessDied(processData) { - console.log('------------ onProcessDied -----------', processData); - }, - onProcessStateChanged(processData) { - console.log('------------ onProcessStateChanged -----------', processData); - } - }; - let bundleNameList = ['bundleName1', 'bundleName2']; - const observerCode = app.registerApplicationStateObserver(applicationStateObserver, bundleNameList); - console.log('-------- observerCode: ---------', observerCode); - ``` ## appManager.unregisterApplicationStateObserver8+ unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\): void; 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 1cd9e6c9823db39b394c78f436f29908d2f3a154..e499403a305dbf3cd82f24a7364ca0d3bcc7cc91 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 @@ -18,7 +18,7 @@ **示例：** ```ts -import Ability from '@ohos.application.Ability' +import Ability from '@ohos.app.ability.UIAbility'; import Window from '@ohos.window' export default class MainAbility extends Ability { @@ -34,11 +34,14 @@ export default class MainAbility extends Ability { console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`); let language = config.language; let colorMode = config.colorMode; + }, + onMemoryLevel(level){ + console.log('onMemoryLevel level: ${JSON.stringify(level)}'); } }; let applicationContext = this.context.getApplicationContext(); - applicationContext.registerEnvironmentCallback(envCallback); + applicationContext.on('environment',envCallback); windowStage.loadContent('pages/index', (err, data) => { if (err.code) { diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md deleted file mode 100755 index fabdcdd3cbc450530ff8bd5e01790354781e7cf2..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md +++ /dev/null @@ -1,62 +0,0 @@ -# @ohos.application.EnvironmentCallback (EnvironmentCallback) - -EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境变化监听回调的能力，包括onConfigurationUpdated方法。 - -> **说明：** -> -> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-environmentCallback.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - - -## 导入模块 - -```ts -import EnvironmentCallback from '@ohos.application.EnvironmentCallback'; -``` - - -## EnvironmentCallback.onConfigurationUpdated - -onConfigurationUpdated(config: Configuration): void; - -注册系统环境变化的监听后，在系统环境变化时触发回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-application-configuration.md) | 是 | 变化后的Configuration对象。 | - -**示例：** - - - ```ts -import Ability from '@ohos.application.Ability'; - -let callbackId; - -export default class MyAbility extends Ability { - onCreate() { - console.log('MyAbility onCreate'); - globalThis.applicationContext = this.context.getApplicationContext(); - let EnvironmentCallback = { - onConfigurationUpdated(config){ - console.log('onConfigurationUpdated config:' + JSON.stringify(config)); - }, - }; - // 1.获取applicationContext - let applicationContext = globalThis.applicationContext; - // 2.通过applicationContext注册监听应用内生命周期 - callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); - console.log('registerEnvironmentCallback number: ' + JSON.stringify(callbackId)); - } - onDestroy() { - let applicationContext = globalThis.applicationContext; - applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { - console.log('unregisterEnvironmentCallback success, err: ' + JSON.stringify(error)); - }); - } -} - ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md b/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md deleted file mode 100644 index 7ddbd2070327bb2db1786f6186b1e17b2645863a..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md +++ /dev/null @@ -1,284 +0,0 @@ -# @ohos.application.FormExtension (FormExtension) - -FormExtension模块提供了FormExtension卡片扩展相关接口。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 从API version 9 开始不再维护，建议使用[FormExtensionAbility](js-apis-app-form-formExtensionAbility.md)替代。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import FormExtension from '@ohos.application.FormExtension'; -``` - -## 属性 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | -| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 | - -## onCreate - -onCreate(want: Want): formBindingData.FormBindingData - -卡片提供方接收创建卡片的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ----------------------------------------------------------- | -| [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 | - -**示例：** - -```ts -import formBindingData from '@ohos.application.formBindingData' -export default class MyFormExtension extends FormExtension { - onCreate(want) { - console.log('FormExtension onCreate, want:' + want.abilityName); - let dataObj1 = { - temperature:"11c", - "time":"11:00" - }; - let obj1 = formBindingData.createFormBindingData(dataObj1); - return obj1; - } -} -``` - -## FormExtension.onCastToNormal - -onCastToNormal(formId: string): void - -卡片提供方接收临时卡片转常态卡片的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------ | -| formId | string | 是 | 请求转换为常态的卡片标识。 | - -**示例：** - -```ts -export default class MyFormExtension extends FormExtension { - onCastToNormal(formId) { - console.log('FormExtension onCastToNormal, formId:' + formId); - } -} -``` - -## FormExtension.onUpdate - -onUpdate(formId: string): void - -卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------ | -| formId | string | 是 | 请求更新的卡片ID。 | - -**示例：** - -```ts -import formBindingData from '@ohos.application.formBindingData' -export default class MyFormExtension extends FormExtension { - onUpdate(formId) { - console.log('FormExtension onUpdate, formId:' + formId); - 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);}); - } -} -``` - -## FormExtension.onVisibilityChange - -onVisibilityChange(newStatus: { [key: string]: number }): void - -卡片提供方接收修改可见性的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------------------------- | ---- | ---------------------------- | -| newStatus | { [key: string]: number } | 是 | 请求修改的卡片ID和可见状态。 | - -**示例：** - -```ts -import formBindingData from '@ohos.application.formBindingData' -export default class MyFormExtension extends FormExtension { - onVisibilityChange(newStatus) { - console.log('FormExtension onVisibilityChange, newStatus:' + newStatus); - let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); - - for (let key in newStatus) { - console.log('FormExtension onVisibilityChange, key:' + key + ", value=" + newStatus[key]); - this.context.updateForm(key, obj2).then((data)=>{ - console.log('FormExtension context updateForm, data:' + data); - }).catch((error) => { - console.error('Operation updateForm failed. Cause: ' + error);}); - } - } -} -``` - -## FormExtension.onEvent - -onEvent(formId: string, message: string): void - -卡片提供方接收处理卡片事件的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------ | ---- | ---------------------- | -| formId | string | 是 | 请求触发事件的卡片标识。 | -| message | string | 是 | 事件消息。 | - -**示例：** - -```ts -export default class MyFormExtension extends FormExtension { - onEvent(formId, message) { - console.log('FormExtension onEvent, formId:' + formId + ", message:" + message); - } -} -``` - -## FormExtension.onDestroy - -onDestroy(formId: string): void - -卡片提供方接收销毁卡片的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------ | -| formId | string | 是 | 请求销毁的卡片标识。 | - -**示例：** - -```ts -export default class MyFormExtension extends FormExtension { - onDestroy(formId) { - console.log('FormExtension onDestroy, formId:' + formId); - } -} -``` - -## FormExtension.onConfigurationUpdated - -onConfigurationUpdated(config: Configuration): void; - -当系统配置更新时调用。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | - -**示例：** - -```ts -class MyFormExtension extends FormExtension { - onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); - } -} -``` - -## FormExtension.onAcquireFormState - -onAcquireFormState?(want: Want): formInfo.FormState; - -卡片提供方接收查询卡片状态通知接口。默认返回卡片初始状态。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-want.md) | 是 | want表示获取卡片状态的描述。描述包括包名称、能力名称、模块名称、卡片名和卡片维度。 | - -**示例：** - -```ts -import formInfo from '@ohos.application.formInfo' -class MyFormExtension extends FormExtension { - onAcquireFormState(want) { - console.log('FormExtension onAcquireFormState, want:' + want); - return formInfo.FormState.UNKNOWN; - } -} -``` - -## FormExtension.onShare - -onShare?(formId: string): {[key: string]: any}; - -卡片提供方接收卡片分享的通知接口。 - -**系统接口**: 此接口为系统接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| formId | string | 是 | 卡片标识。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ----------------------------------------------------------- | -| {[key: string]: any} | 卡片要分享的数据，由开发者自行决定传入的键值对。 | - -**示例：** - -```ts -class MyFormExtension extends FormExtension { - onShare(formId) { - console.log('FormExtension onShare, formId:' + formId); - let wantParams = { - "temperature":"20", - "time":"2022-8-8 09:59", - }; - return wantParams; - } -} -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md index 6e7ff6562281915e78ce7aa4158a8f6d002d99d1..f2429446c8e891864546eea13b82b95f6f166210 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md @@ -1045,91 +1045,3 @@ formHost.notifyFormsEnableUpdate(formIds, true).then(() => { console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); }); ``` -## shareForm9+ - -shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>): void - -指定formId和远程设备Id进行卡片分享。使用callback异步回调。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识。 | -| deviceId | string | 是 | 远程设备标识。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当指定formId和远程设备Id进行卡片分享成功，err为undefined，否则为错误对象。 | - -**示例：** - -```ts -let formId = '12400633174999288'; -let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2'; -formHost.shareForm(formId, deviceId, (error, data) => { - if (error.code) { - console.log('formHost shareForm, error:' + JSON.stringify(error)); - } -}); -``` - -## shareForm9+ - -shareForm(formId: string, deviceId: string): Promise<void> - -指定formId和远程设备Id进行卡片分享。使用Promise异步回调。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识。 | -| deviceId | string | 是 | 远程设备标识。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<void> | 无返回结果的Promise对象。 | - -**参数：** - -```ts -let formId = '12400633174999288'; -let deviceId = 'EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2'; -formHost.shareForm(formId, deviceId).then(() => { - console.log('formHost shareForm success'); -}).catch((error) => { - console.log('formHost shareForm, error:' + JSON.stringify(error)); -}); -``` - -## notifyFormsPrivacyProtected9+ - -notifyFormsPrivacyProtected(formIds: Array\, isProtected: boolean, callback: AsyncCallback\): void - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识。 | -| deviceId | string | 是 | 远程设备标识。 | - -```ts -let formIds = new Array('12400633174999288', '12400633174999289'); -formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { - console.log('formHost shareForm success'); -}).catch((error) => { - console.log('formHost shareForm, error:' + JSON.stringify(error)); -}); -``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md index c48ccb0e1412e5781f69e0aca377994271df050a..7e2dc469345d4d7fecd6eb219aa615ccdc59b790 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md @@ -49,7 +49,6 @@ import formInfo from '@ohos.application.formInfo'; | 名称 | 值 | 说明 | | ----------- | ---- | ------------ | | JS | 1 | 卡片类型为JS。 | -| eTS9+ | 2 | 卡片类型为eTS。 | ## ColorMode @@ -100,35 +99,7 @@ import formInfo from '@ohos.application.formInfo'; | MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称。 | | WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 | | HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 | -| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 | -| ABILITY_NAME_KEY9+ | "ohos.extra.param.key.ability_name" | ability名称 | -| DEVICE_ID_KEY9+ | "ohos.extra.param.key.device_id" | 设备标识。
**系统接口**: 此接口为系统接口。 | -| BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。| - -## FormDimension9+ - -定义卡片尺寸枚举。 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 值 | 说明 | -| ----------- | ---- | ------------ | -| Dimension_1_2 9+ | 1 | 1 x 2 form。 | -| Dimension_2_2 9+ | 2 | 2 x 2 form。 | -| Dimension_2_4 9+ | 3 | 2 x 4 form。 | -| Dimension_4_4 9+ | 4 | 4 x 4 form。 | -| Dimension_2_1 9+ | 5 | 2 x 1 form。 | - -## VisibilityType - -卡片可见性。 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 值 | 说明 | -| ----------- | ---- | ------------ | -| FORM_VISIBLE9+ | 1 | 卡片状态为可见。 | -| FORM_INVISIBLE9+ | 2 | 卡片状态为不可见。 | +| TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 | ## FormInfoFilter9+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md index c54edf9cbeac9dd5c60f9a24b46bfcfc4725341f..edb886cd6932900e0b83be7983d31c891510d912 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md @@ -132,298 +132,4 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr }).catch((error) => { console.log('formProvider updateForm, error:' + JSON.stringify(error)); }); - ``` - -## getFormsInfo9+ - -getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void - -获取设备上当前应用程序的卡片信息，使用callback异步回调。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到的卡片信息。 | - -**示例：** - -```ts -formProvider.getFormsInfo((error, data) => { - if (error.code) { - console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); - } -}); -``` -## getFormsInfo9+ - -getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void - -获取设备上当前应用程序的卡片信息，并筛选符合条件的信息，使用callback异步回调。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | -| callback | AsyncCallback<Array<[FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | - -**示例：** - -```ts -import formInfo from '@ohos.application.formInfo'; -const filter : formInfo.FormInfoFilter = { - // get info of forms belong to module entry. - moduleName : 'entry' -}; -formProvider.getFormsInfo(filter, (error, data) => { - if (error.code) { - console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); - } -}); -``` - -## getFormsInfo9+ - -getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>> - -获取设备上当前应用程序的卡片信息，使用Promise异步回调。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md) | 否 | 卡片信息过滤器。 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<Array<[FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | Promise对象。返回查询到符合条件的卡片信息。 | - -**示例：** - -```ts -import formInfo from '@ohos.application.formInfo'; -const filter : formInfo.FormInfoFilter = { - // get info of forms belong to module entry. - moduleName : 'entry' -}; -formProvider.getFormsInfo(filter).then((data) => { - console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); -}).catch((error) => { - console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); -}); -``` - -## requestPublishForm9+ - -requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\): void - -请求发布一张卡片到使用方。使用方通常为桌面。 - -**系统能力：** SystemCapability.Ability.Form - -**系统接口**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | -| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
'ohos.extra.param.key.form_dimension'
'ohos.extra.param.key.form_name'
'ohos.extra.param.key.module_name' | -| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 | -| callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | - -**示例：** - - ```ts - import formBindingData from '@ohos.application.formBindingData'; - let want = { - abilityName: 'FormAbility', - parameters: { - 'ohos.extra.param.key.form_dimension': 2, - 'ohos.extra.param.key.form_name': 'widget', - 'ohos.extra.param.key.module_name': 'entry' - } - }; - let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'}); - formProvider.requestPublishForm(want, obj, (error, data) => { - if (error.code) { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - } else { - console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); - } - }); - ``` - -## requestPublishForm9+ - -requestPublishForm(want: Want, callback: AsyncCallback<string>): void - -请求发布一张卡片到使用方。使用方通常为桌面。 - -**系统能力：** SystemCapability.Ability.Form - -**系统接口**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
'ohos.extra.param.key.form_dimension'
'ohos.extra.param.key.form_name'
'ohos.extra.param.key.module_name' | -| callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | - -**示例：** - - ```ts - let want = { - abilityName: 'FormAbility', - parameters: { - 'ohos.extra.param.key.form_dimension': 2, - 'ohos.extra.param.key.form_name': 'widget', - 'ohos.extra.param.key.module_name': 'entry' - } - }; - formProvider.requestPublishForm(want, (error, data) => { - if (error.code) { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - } else { - console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); - } - }); - ``` - -## requestPublishForm9+ - -requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise<string> - -请求发布一张卡片到使用方。使用方通常为桌面。 - -**系统能力：** SystemCapability.Ability.Form - -**系统接口**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
'ohos.extra.param.key.form_dimension'
'ohos.extra.param.key.form_name'
'ohos.extra.param.key.module_name' | -| formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 否 | 创建卡片的数据。 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<string> | Promise对象。返回卡片标识。 | - -**示例：** - - ```ts - let want = { - abilityName: 'FormAbility', - parameters: { - 'ohos.extra.param.key.form_dimension': 2, - 'ohos.extra.param.key.form_name': 'widget', - 'ohos.extra.param.key.module_name': 'entry' - } - }; - formProvider.requestPublishForm(want).then((data) => { - console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data)); - }).catch((error) => { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - }); - ``` - -## isRequestPublishFormSupported9+ - -isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void - -查询是否支持发布一张卡片到使用方。 - -**系统接口**: 此接口为系统接口。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<boolean> | 是 | 回调函数。返回是否支持发布一张卡片到使用方。| - -**示例：** - -```ts -formProvider.isRequestPublishFormSupported((error, isSupported) => { - if (error.code) { - console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); - } else { - if (isSupported) { - let want = { - abilityName: 'FormAbility', - parameters: { - 'ohos.extra.param.key.form_dimension': 2, - 'ohos.extra.param.key.form_name': 'widget', - 'ohos.extra.param.key.module_name': 'entry' - } - }; - formProvider.requestPublishForm(want, (error, data) => { - if (error.code) { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - } else { - console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); - } - }); - } - } -}); -``` - -## isRequestPublishFormSupported9+ - -isRequestPublishFormSupported(): Promise<boolean> - -查询是否支持发布一张卡片到使用方。 - -**系统接口**: 此接口为系统接口。 - -**系统能力：** SystemCapability.Ability.Form - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<boolean> | Promise对象。返回是否支持发布一张卡片到使用方。 | - -**示例：** - -```ts -formProvider.isRequestPublishFormSupported().then((isSupported) => { - if (isSupported) { - let want = { - abilityName: 'FormAbility', - parameters: { - 'ohos.extra.param.key.form_dimension': 2, - 'ohos.extra.param.key.form_name': 'widget', - 'ohos.extra.param.key.module_name': 'entry' - } - }; - formProvider.requestPublishForm(want).then((data) => { - console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data)); - }).catch((error) => { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - }); - } -}).catch((error) => { - console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); -}); -``` \ No newline at end of file + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md index 88a75e45c94742194f67b0642097657c75cee3e4..680cb2b19936dfe908c798fa920a0de143abfb15 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-missionManager.md @@ -367,89 +367,6 @@ getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnaps }); ``` -## missionManager.getLowResolutionMissionSnapShot9+ - -getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback\): void; - -使用给定的任务ID获取任务低分辨率快照。 - -**需要权限**：ohos.permission.MANAGE_MISSIONS - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | - | missionId | number | 是 | 任务ID。 | - | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 | - -**示例：** - - ```ts - import missionManager from '@ohos.application.missionManager'; - - missionManager.getMissionInfos('', 10, (error, missions) => { - console.log('getMissionInfos is called, error.code = ' + error.code); - console.log('size = ' + missions.length); - console.log('missions = ' + JSON.stringify(missions)); - let id = missions[0].missionId; - - missionManager.getLowResolutionMissionSnapShot('', id, (error, snapshot) => { - console.log('getLowResolutionMissionSnapShot is called, error.code = ' + error.code); - console.log('bundleName = ' + snapshot.ability.bundleName); - }); - }); - ``` - - -## missionManager.getLowResolutionMissionSnapShot9+ - -getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\; - -使用给定的任务ID获取任务低分辨率快照。 - -**需要权限**：ohos.permission.MANAGE_MISSIONS - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | deviceId | string | 是 | 设备ID，本机默认为空字符串。 | - | missionId | number | 是 | 任务ID。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 任务快照信息。 | - -**示例：** - - ```ts - import missionManager from '@ohos.application.missionManager'; - - let allMissions; - missionManager.getMissionInfos('',10).then(function(res){ - allMissions=res; - }).catch(function(err){console.log(err);}); - console.log('size = ' + allMissions.length); - console.log('missions = ' + JSON.stringify(allMissions)); - let id = allMissions[0].missionId; - - let snapshot = missionManager.getLowResolutionMissionSnapShot('', id).catch(function (err){ - console.log(err); - }); - ``` - - ## missionManager.lockMission lockMission(missionId: number, callback: AsyncCallback<void>): void; diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md deleted file mode 100644 index 903cdc6b0bbd1232ce087381390123c1d586e9b7..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-serviceExtensionAbility.md +++ /dev/null @@ -1,253 +0,0 @@ -# @ohos.application.ServiceExtensionAbility (ServiceExtensionAbility) - -ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的能力。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import ServiceExtensionAbility from '@ohos.application.ServiceExtensionAbility'; -``` - -## 权限 - -无 - -## 属性 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| context | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 | - - -## ServiceExtensionAbility.onCreate - -onCreate(want: Want): void; - -Extension生命周期回调，在创建时回调，执行初始化业务逻辑操作。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - onCreate(want) { - console.log('onCreate, want:' + want.abilityName); - } - } - ``` - - -## ServiceExtensionAbility.onDestroy - -onDestroy(): void; - -Extension生命周期回调，在销毁时回调，执行资源清理等操作。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - onDestroy() { - console.log('onDestroy'); - } - } - ``` - - -## ServiceExtensionAbility.onRequest - -onRequest(want: Want, startId: number): void; - -Extension生命周期回调，如果是startAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 | - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - onRequest(want, startId) { - console.log('onRequest, want:' + want.abilityName); - } - } - ``` - - -## ServiceExtensionAbility.onConnect - -onConnect(want: Want): rpc.RemoteObject; - -Extension生命周期回调，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于和客户端进行通信。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 | - -**示例：** - - ```ts - import rpc from '@ohos.rpc' - class StubTest extends rpc.RemoteObject{ - constructor(des) { - super(des); - } - onConnect(code, data, reply, option) { - } - } - class ServiceExt extends ServiceExtension { - onConnect(want) { - console.log('onConnect , want:' + want.abilityName); - return new StubTest("test"); - } - } - ``` - - -## ServiceExtensionAbility.onDisconnect - -onDisconnect(want: Want): void; - -Extension的生命周期，断开服务连接时回调。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - onDisconnect(want) { - console.log('onDisconnect, want:' + want.abilityName); - } - } - ``` - -## ServiceExtensionAbility.onReconnect - -onReconnect(want: Want): void; - -当新客户端在所有以前的客户端连接之后尝试连接到服务扩展时调用 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | want |[Want](js-apis-application-want.md)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - onReconnect(want) { - console.log('onReconnect, want:' + want.abilityName); - } - } - ``` - -## ServiceExtensionAbility.onConfigurationUpdated - -onConfigurationUpdated(config: Configuration): void; - -当Extension更新配置信息时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); - } - } - ``` - -## ServiceExtensionAbility.dump - -dump(params: Array\): Array\; - -转储客户端信息时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | params | Array\ | 是 | 表示命令形式的参数。| - -**示例：** - - ```ts - class ServiceExt extends ServiceExtension { - dump(params) { - console.log('dump, params:' + JSON.stringify(params)); - return ["params"] - } - } - ``` - diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md b/zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md deleted file mode 100644 index e19c577ec521d4a5f762b6a5d2ddb2f2575ad2b7..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-startOptions.md +++ /dev/null @@ -1,23 +0,0 @@ -# @ohos.application.StartOptions (StartOptions) - -StartOptions模块对系统的基本通信组件进行查询和设置的能力。 - -> **说明：** -> -> 本模块首批接口从API version 9 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.StartOptions](js-apis-app-ability-startOptions.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import StartOptions from '@ohos.application.StartOptions'; -``` - -## 属性 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 | -| displayId | number | 否 | 显示ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-want.md b/zh-cn/application-dev/reference/apis/js-apis-application-want.md index 160be5faaec320ab9a11dd7069a81c24045b3e72..305081a75536a558358d19ca48a729aef3d09f4a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-want.md @@ -27,7 +27,6 @@ import Want from '@ohos.application.Want'; | action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。 | | parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。
- component.startup.newRules：表示是否启用新的管控规则。
- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。
- ohos.dlp.params.sandbox：表示dlp文件才会有。 | | | entities | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | -| moduleName9+ | string | 否 | 表示待启动的Ability所属的模块（module）。 | **示例：** 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 ca314eff605dd2044ddc27603fad7d937747b526..d346ef568f3ba995f77b8c2b2a7adccc65ec73bb 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md @@ -368,8 +368,8 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callba | 参数名 | 类型 | 必填 | 说明 | | --------- | --------------------------------------- | ---- | ----- | -| parameter | [ContinueDeviceInfo](#continuedeviceinfo) | 是 | 迁移信息。 | -| options | [ContinueCallback](#continuecallback) | 是 | 迁移任务完成回调函数。 | +| parameter | [ContinueDeviceInfo](#js-apis-inner-application-continueDeviceInfo.md) | 是 | 迁移信息。 | +| options | [ContinueCallback](#js-apis-inner-application-continueCallback.md) | 是 | 迁移任务完成回调函数。 | | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 | **错误码：** @@ -426,8 +426,8 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi | 参数名 | 类型 | 必填 | 说明 | | --------- | --------------------------------------- | ---- | ----- | -| parameter | [ContinueDeviceInfo](#continuedeviceinfo) | 是 | 迁移信息。 | -| options | [ContinueCallback](#continuecallback) | 是 | 迁移任务完成回调函数。 | +| parameter | [ContinueDeviceInfo](#js-apis-inner-application-continueDeviceInfo.md) | 是 | 迁移信息。 | +| options | [ContinueCallback](#js-apis-inner-application-continueCallback.md) | 是 | 迁移任务完成回调函数。 | **返回值：** @@ -513,31 +513,4 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | ------ | ---- | ---- | ------- | -| deviceId | string | 是 | 是 | 表示设备ID。 | - -## ContinueDeviceInfo - -表示发起任务迁移时所需参数的枚举。 - -**需要权限**：ohos.permission.MANAGE_MISSIONS - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | ------ | ---- | ---- | ------- | -| srcDeviceId | string | 是 | 是 | 表示任务迁移源设备ID。 | -| dstDeviceId | string | 是 | 是 | 表示任务迁移目标设备ID。 | -| missionId | number | 是 | 是 | 表示任务ID。 | -| wantParam | {[key: string]: any} | 是 | 是 | 表示扩展参数。 | - -## ContinueCallback - -表示迁移完成后，返回迁移结果回调函数。 - -**需要权限**：ohos.permission.MANAGE_MISSIONS - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | -------- | ---- | ---- | ------------------ | -| onContinueDone | function | 是 | 否 | 通知迁移完成，返回迁移结果。 | \ No newline at end of file +| deviceId | string | 是 | 是 | 表示设备ID。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md index 4035c9dc2611f1d88923526274d45d94f88d8aff..e752168d3d64baa17223e12fc58b559031bd35bb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-dataAbilityResult.md @@ -25,11 +25,9 @@ try { DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri); if (DAHelper == null) { console.error('DAHelper is null'); - return; } } catch (err) { console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err)); - return; } let valueBucket = { diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md index 60f5272f0f7e373fc8f31fed95fdaf24e76f0a26..f966f4bd56335f4fffa1b043f823b303ab81f533 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-startAbilityParameter.md @@ -38,7 +38,5 @@ let startAbilityParameter = { featureAbility.startAbility(startAbilityParameter, (err, data)=>{ console.log('errCode : ' + JSON.stringify(err)); console.log('data : ' + JSON.stringify(data)); -} catch(error) { - console.log('startAbility error: ' + JSON.stringify(error)); -} +}); ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md index 9c12b9faa80b4e8e8c26075078c891679bc406dc..8c0b11cd56f2ae800cb27ffcc2803442b864205b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityDelegator.md @@ -10,9 +10,7 @@ AbilityDelegator提供添加用于监视指定ability的生命周期状态更改 通过AbilityDelegatorRegistry中[getAbilityDelegator](js-apis-app-ability-abilityDelegatorRegistry.md#abilitydelegatorregistrygetabilitydelegator)方法获取。 ```ts -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' - -let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; ``` ## AbilityDelegator 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 4a9617e5fdbfa41ff4a531845db95b7b6b51ac37..c479cf5d689f3ac78d856b92750bf1e419a97c06 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 @@ -115,7 +115,7 @@ export default class EntryAbility extends UIAbility { onDestroy() { let applicationContext = this.context.getApplicationContext(); console.log('stage applicationContext: ' + applicationContext); - applicationContext.off(type: 'abilityLifecycle', lifecycleId, (error, data) => { + applicationContext.off('abilityLifecycle', lifecycleId, (error, data) => { console.log('unregisterAbilityLifecycleCallback success, err: ' + JSON.stringify(error)); }); } @@ -148,7 +148,7 @@ export default class MyAbility extends Ability { onDestroy() { let applicationContext = this.context.getApplicationContext(); console.log('stage applicationContext: ' + applicationContext); - applicationContext.off(type: 'abilityLifecycle', lifecycleId); + applicationContext.off('abilityLifecycle', lifecycleId); } } ``` @@ -185,7 +185,7 @@ export default class EntryAbility extends UIAbility { onCreate() { console.log('MyAbility onCreate') globalThis.applicationContext = this.context.getApplicationContext(); - let EnvironmentCallback = { + let environmentCallback = { onConfigurationUpdated(config){ console.log('onConfigurationUpdated config:' + JSON.stringify(config)); }, @@ -196,8 +196,8 @@ export default class EntryAbility extends UIAbility { // 1.获取applicationContext let applicationContext = globalThis.applicationContext; // 2.通过applicationContext注册监听应用内生命周期 - callbackId = applicationContext.on('environment', EnvironmentCallback); - console.log('registerEnvironmentCallback number: ' + JSON.stringify(callbackId)); + callbackId = applicationContext.on('environment', environmentCallback); + console.log('registerEnvironmentCallback callbackId: ${callbackId}'); } } ``` 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 3ad3e560941ab59809bad02749972339b211b533..dc81035a54723f5a96f4c9a9ecd159bd87df9660 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 @@ -19,12 +19,12 @@ onUnhandledException(errMsg: string): void; **示例：** ```ts -import errorManager from '@ohos.application.errorManager'; +import errorManager from '@ohos.app.ability.errorManager'; let observer = { onUnhandledException(errorMsg) { console.log('onUnhandledException, errorMsg: ' + JSON.stringify(errorMsg)); } }; -errorManager.registerErrorObserver(observer); +errorManager.on('error',observer); ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md index e219e1ef3ef15076314cb7892fddc77bd38078c4..80aaeb929822786ea1c08c15c9f272121b3264df 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-eventHub.md @@ -12,7 +12,7 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件 在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。 ```ts -import Ability from '@ohos.application.Ability'; +import Ability from '@ohos.app.ability.UIAbility'; export default class MainAbility extends Ability { func1(){ console.log('func1 is called'); @@ -41,7 +41,7 @@ on(event: string, callback: Function): void; **示例：** ```ts - import Ability from '@ohos.application.Ability'; + import Ability from '@ohos.app.ability.UIAbility'; export default class MainAbility extends Ability { onForeground() { @@ -79,7 +79,7 @@ off(event: string, callback?: Function): void; **示例：** ```ts - import Ability from '@ohos.application.Ability'; + import Ability from '@ohos.app.ability.UIAbility'; export default class MainAbility extends Ability { onForeground() { @@ -117,7 +117,7 @@ emit(event: string, ...args: Object[]): void; **示例：** ```ts - import Ability from '@ohos.application.Ability'; + import Ability from '@ohos.app.ability.UIAbility'; export default class MainAbility extends Ability { onForeground() { 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 bbc99e90938f01686646d12b62a240d7ee2b87d3..a3b6c150d2f26d5bb141921aab646ac69fd45b72 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 @@ -31,8 +31,12 @@ let listener = { onMissionMovedToFront: function (mission) { console.log('onMissionMovedToFront mission: ' + JSON.stringify(mission)); }, + onMissionLabelUpdated: function (mission) { + console.log('onMissionLabelUpdated mission: ' + JSON.stringify(mission)); + }, onMissionIconUpdated: function (mission, icon) { console.log('onMissionIconUpdated mission: ' + JSON.stringify(mission)); + console.log('onMissionIconUpdated icon: ' + JSON.stringify(icon)); }, onMissionClosed: function (mission) { console.log('onMissionClosed mission: ' + JSON.stringify(mission)); 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 60ac715271482084f67bf13aff4e547548a419c5..0d157cb428f2449478330f287274e34eae080147 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md @@ -12,6 +12,145 @@ WantAgent模块提供了创建WantAgent实例、获取实例的用户ID、获取 import WantAgent from '@ohos.wantAgent'; ``` +## WantAgent.getWant + +getWant(agent: WantAgent, callback: AsyncCallback\): void + +获取WantAgent中的Want(callback形式)。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------- | ---- | ----------------------- | +| agent | [WantAgent](js-apis-inner-wantAgent-wantAgent.md) | 是 | WantAgent信息。 | +| callback | AsyncCallback\ | 是 | 获取WantAgent中的Want的回调方法。 | + +**示例：** + +```ts +import WantAgent from '@ohos.wantAgent'; + + +//wantAgent对象 +let wantAgent; + +//getWantAgent回调 +function getWantAgentCallback(err, data) { + console.info('==========================>getWantAgentCallback=======================>'); + if (err.code == 0) { + wantAgent = data; + } else { + console.error('getWantAgent failed, error: ' + JSON.stringify(err)); + return; + } + + //getWant回调 + function getWantCallback(err, data) { + console.info('==========================>getWantCallback=======================>'); + } + WantAgent.getWant(wantAgent, getWantCallback); +} +//WantAgentInfo对象 +let wantAgentInfo = { + wants: [ + { + deviceId: 'deviceId', + bundleName: 'com.neu.setResultOnAbilityResultTest1', + abilityName: 'com.example.test.EntryAbility', + action: 'action1', + entities: ['entity1'], + type: 'MIMETYPE', + uri: 'key={true,true,false}', + parameters: + { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', + mykey4: [false, true, false], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], + mykey6: true, + } + } + ], + operationType: WantAgent.OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] +}; + +WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); +``` + +## WantAgent.getWant + +getWant(agent: WantAgent): Promise\ + +获取WantAgent中的Want(Promise形式)。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------------- | ---- | ------------- | +| agent | [WantAgent](js-apis-inner-wantAgent-wantAgent.md) | 是 | WantAgent信息。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------------------------------------------------- | ------------------------------------------------------------ | +| Promise\ | 以Promise形式返回Want。 | + +**示例：** + +```ts +import WantAgent from '@ohos.wantAgent'; + + +//wantAgent对象 +let wantAgent; + +//WantAgentInfo对象 +let wantAgentInfo = { + wants: [ + { + deviceId: 'deviceId', + bundleName: 'com.neu.setResultOnAbilityResultTest1', + abilityName: 'com.example.test.EntryAbility', + action: 'action1', + entities: ['entity1'], + type: 'MIMETYPE', + uri: 'key={true,true,false}', + parameters: + { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', + mykey4: [false, true, false], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], + mykey6: true, + } + } + ], + operationType: WantAgent.OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] +} + +WantAgent.getWantAgent(wantAgentInfo).then((data) => { + console.info('==========================>getWantAgentCallback=======================>'); + wantAgent = data; + if (wantAgent) { + WantAgent.getWant(wantAgent).then((data) => { + console.info('==========================>getWantCallback=======================>'); + }); + } +}); +``` + ## WantAgent.getWantAgent getWantAgent(info: WantAgentInfo, callback: AsyncCallback\): void @@ -786,135 +925,6 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => { }); ``` -## WantAgent.getOperationType9+ - -getOperationType(agent: WantAgent, callback: AsyncCallback\): void; - -获取一个WantAgent的OperationType信息（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------ | ---- | --------------------------------------- | -| agent | WantAgent | 是 | WantAgent对象。 | -| callback | AsyncCallback\ | 是 | 获取一个WantAgent的OperationType信息的回调方法。 | - -**示例：** - -```ts -import WantAgent from '@ohos.wantAgent'; - -//wantAgent对象 -let wantAgent; - -//WantAgentInfo对象 -let wantAgentInfo = { - wants: [ - { - deviceId: 'deviceId', - bundleName: 'com.neu.setResultOnAbilityResultTest1', - abilityName: 'com.example.test.EntryAbility', - action: 'action1', - entities: ['entity1'], - type: 'MIMETYPE', - uri: 'key={true,true,false}', - parameters: - { - mykey0: 2222, - mykey1: [1, 2, 3], - mykey2: '[1, 2, 3]', - mykey3: 'ssssssssssssssssssssssssss', - mykey4: [false, true, false], - mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], - mykey6: true, - } - } - ], - operationType: WantAgent.OperationType.START_ABILITIES, - requestCode: 0, - wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] -} - -WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info('==========================>getWantAgentCallback=======================>'); - wantAgent = data; - if (data) { - WantAgent.getOperationType(wantAgent, (OperationType) => { - console.log('----------- getOperationType ----------, OperationType: ' + OperationType); - }) - } -}); -``` - -## WantAgent.getOperationType9+ - -getOperationType(agent: WantAgent): Promise\; - -获取一个WantAgent的OperationType信息（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | --------- | ---- | ------------- | -| agent | WantAgent | 是 | WantAgent对象。 | - -**返回值：** - -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取operationType的结果。 | - -**示例：** - -```ts -import WantAgent from '@ohos.wantAgent'; - -//wantAgent对象 -let wantAgent; - -//WantAgentInfo对象 -let wantAgentInfo = { - wants: [ - { - deviceId: 'deviceId', - bundleName: 'com.neu.setResultOnAbilityResultTest1', - abilityName: 'com.example.test.EntryAbility', - action: 'action1', - entities: ['entity1'], - type: 'MIMETYPE', - uri: 'key={true,true,false}', - parameters: - { - mykey0: 2222, - mykey1: [1, 2, 3], - mykey2: '[1, 2, 3]', - mykey3: 'ssssssssssssssssssssssssss', - mykey4: [false, true, false], - mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], - mykey6: true, - } - } - ], - operationType: WantAgent.OperationType.START_ABILITIES, - requestCode: 0, - wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] -} - -WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info('==========================>getWantAgentCallback=======================>'); - wantAgent = data; - WantAgent.getOperationType(wantAgent).then((OperationType) => { - console.log('getOperationType success, OperationType: ' + OperationType); - }).catch((err) => { - console.log('getOperationType fail, err: ' + err); - }) -}); -``` - ## WantAgentFlags **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core