diff --git a/zh-cn/application-dev/dfx/errormanager-guidelines.md b/zh-cn/application-dev/dfx/errormanager-guidelines.md index c93a73b14c35d9cfdab8b0081d6890f6889705c3..08395a122256cab207296c4271b710e388e11863 100644 --- a/zh-cn/application-dev/dfx/errormanager-guidelines.md +++ b/zh-cn/application-dev/dfx/errormanager-guidelines.md @@ -37,10 +37,10 @@ ## 开发示例 ```ts import Ability from '@ohos.application.Ability' -import errorManager from '@ohos.application.errorManager' +import errorManager from '@ohos.app.ability.errorManager'; -var registerId = -1; -var callback = { +let registerId = -1; +let callback = { onUnhandledException: function (errMsg) { console.log(errMsg); } @@ -49,13 +49,13 @@ var callback = { export default class MainAbility extends Ability { onCreate(want, launchParam) { console.log("[Demo] MainAbility onCreate") - registerId = errorManager.registerErrorObserver(callback); + registerId = errorManager.on("error", callback); globalThis.abilityWant = want; } onDestroy() { console.log("[Demo] MainAbility onDestroy") - errorManager.unregisterErrorObserver(registerId, (result) => { + errorManager.off("error", registerId, (result) => { console.log("[Demo] result " + result.code + ";" + result.message) }); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index daa313f03ac4e5a095acf2cdc86ffc9e95d17b94..c71cc797f35cbb52acd9e232069d308c67ffc44e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -30,8 +30,8 @@ class MainAbility extends Ability { | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 | +| abilityInfo | [AbilityInfo](js-apis-bundleManager-abilityInfo.md) | 是 | 否 | Abilityinfo相关信息 | +| currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | 是 | 否 | 当前hap包的信息 | | config | [Configuration](js-apis-application-configuration.md) | 是 | 否 | 表示配置信息。 | ## AbilityContext.startAbility @@ -40,6 +40,11 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; 启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -89,6 +94,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& 启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -142,6 +152,11 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; 启动Ability（promise形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -198,7 +213,12 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void; -启动Ability并在该Ability退出的时候返回执行结果（callback形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -248,7 +268,12 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void; -启动Ability并在该Ability退出的时候返回执行结果（callback形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -303,7 +328,12 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>; -启动Ability并在该Ability退出的时候返回执行结果（promise形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（promise形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -363,6 +393,11 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC 启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 跨应用场景下，目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -375,7 +410,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 | | accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 | -| callback | AsyncCallback\ | 是 | 启动Ability的回调函数，返回Ability结果。 | +| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)\> | 是 | 启动Ability的回调函数，返回Ability结果。 | **错误码：** @@ -420,6 +455,11 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp 启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -481,6 +521,11 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO 启动一个Ability并在该Ability帐号销毁时返回执行结果（promise形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -499,7 +544,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO | 类型 | 说明 | | -------- | -------- | -| Promise<AbilityResult> | 返回一个Promise，包含Ability结果。 | +| Promise<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 返回一个Promise，包含Ability结果。 | **错误码：** @@ -1034,7 +1079,7 @@ terminateSelf(): Promise<void>; terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void; -停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（callback形式）。 +停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1090,6 +1135,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi terminateSelfWithResult(parameter: AbilityResult): Promise<void>; 停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（promise形式）。 +停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1361,6 +1407,11 @@ startAbilityByCall(want: Want): Promise<Caller>; 启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**: 此接口为系统接口，三方应用不支持调用。 @@ -1450,6 +1501,11 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< 根据account启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1506,6 +1562,11 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca 根据account启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1566,6 +1627,11 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): 根据account启动Ability（Promise形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1685,7 +1751,7 @@ setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 | +| icon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 在最近的任务中显示的ability图标。 | | callback | AsyncCallback\ | 是 | 指定的回调函数的结果。 | **示例：** @@ -1727,7 +1793,7 @@ setMissionIcon(icon: image.PixelMap): Promise\; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 | +| icon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 在最近的任务中显示的ability图标。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md b/zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md index 2a85d32b2cc1970813fa8685d34227161915e7f7..0d5aaf26a22bdc5cd384f4412131cbbd1e2dec6b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md @@ -1,6 +1,6 @@ # @ohos.ability.dataUriUtils (DataUriUtils模块) -DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力，包括获取，添加，更新给定uri的路径组件末尾的ID。 +DataUriUtils模块提供用于处理uri对象的能力，包括获取、绑定、删除和更新指定uri对象的路径末尾的ID。本模块将被app.ability.dataUriUtils模块替代，建议优先使用[@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)模块。 > **说明：** > @@ -16,7 +16,7 @@ import dataUriUtils from '@ohos.ability.dataUriUtils'; getId(uri: string): number -获取附加到给定uri的路径组件末尾的ID。 +获取指定uri路径末尾的ID。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -24,18 +24,18 @@ getId(uri: string): number | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------------------------- | -| uri | string | 是 | 指示要从中获取ID的uri对象。 | +| uri | string | 是 | 表示uri对象。 | **返回值：** | 类型 | 说明 | | ------ | ------------------------ | -| number | 附加到路径组件末尾的ID。 | +| number | 返回uri路径末尾的ID。 | **示例：** ```ts -dataUriUtils.getId("com.example.dataUriUtils/1221") +let id = dataUriUtils.getId("com.example.dataUriUtils/1221"); ``` @@ -44,7 +44,7 @@ dataUriUtils.getId("com.example.dataUriUtils/1221") attachId(uri: string, id: number): string -将给定ID附加到给定uri的路径组件的末尾。 +将ID附加到uri的路径末尾。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -52,22 +52,22 @@ attachId(uri: string, id: number): string | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------------------------- | -| uri | string | 是 | 指示要从中获取ID的uri对象。 | -| id | number | 是 | 指示要附加的ID。 | +| uri | string | 是 | 表示uri对象。 | +| id | number | 是 | 表示要附加的ID。 | **返回值：** | 类型 | 说明 | | ------ | --------------------- | -| string | 附加给定ID的uri对象。 | +| string | 返回附加ID之后的uri对象。 | **示例：** ```ts -var idint = 1122; -dataUriUtils.attachId( +let id = 1122; +let uri = dataUriUtils.attachId( "com.example.dataUriUtils", - idint, + id, ) ``` @@ -77,7 +77,7 @@ dataUriUtils.attachId( deleteId(uri: string): string -从给定uri的路径组件的末尾删除ID。 +删除指定uri路径末尾的ID。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -85,18 +85,18 @@ deleteId(uri: string): string | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------------------------- | -| uri | string | 是 | 指示要从中删除ID的uri对象。 | +| uri | string | 是 | 表示要从中删除ID的uri对象。 | **返回值：** | 类型 | 说明 | | ------ | ------------------- | -| string | ID已删除的uri对象。 | +| string | 返回删除ID之后的uri对象。 | **示例：** ```ts -dataUriUtils.deleteId("com.example.dataUriUtils/1221") +let uri = dataUriUtils.deleteId("com.example.dataUriUtils/1221") ``` @@ -113,22 +113,22 @@ updateId(uri: string, id: number): string | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------------------- | -| uri | string | 是 | 指示要更新的uri对象 | -| id | number | 是 | 指示新ID | +| uri | string | 是 | 表示uri对象 | +| id | number | 是 | 表示要更新的ID | **返回值：** | 类型 | 说明 | | ------ | --------------- | -| string | 更新的uri对象。 | +| string | 返回更新ID之后的uri对象。 | **示例：** ```ts -var idint = 1122; -dataUriUtils.updateId( - "com.example.dataUriUtils", - idint +let id = 1122; +let uri = dataUriUtils.updateId( + "com.example.dataUriUtils/1221", + id ) ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md index cc7f3cd647ad9875d302343fe152ecad4b3c47bd..b66275351ef87e69938efc7cbc1a743efe44b7b2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md @@ -1,8 +1,6 @@ # @ohos.ability.errorCode (ErrorCode) -ErrorCode是定义启动功能时使用的错误代码。 - -本模块提供使用的错误代码的能力，包括没有错误，无效的参数等。 +ErrorCode定义启动Ability时返回的错误码，包括无效的参数、权限拒绝等。 > **说明：** > @@ -16,13 +14,13 @@ import errorCode from '@ohos.ability.errorCode' ## ErrorCode -定义启动功能时使用的错误代码。 +定义启动Ability时返回的错误码。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 值 | 说明 | | ------------------------------ | ---- | ---------------------------------------- | -| NO_ERROR | 0 | 没有错误。 | +| NO_ERROR | 0 | 没有异常。 | | INVALID_PARAMETER | -1 | 无效的参数。 | | ABILITY_NOT_FOUND | -2 | 找不到ABILITY。 | -| PERMISSION_DENY | -3 | 拒绝许可。 | \ No newline at end of file +| PERMISSION_DENY | -3 | 权限拒绝。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md index 580f5f20ab040d0b779bf8843f59e8f070007ece..5f4b00d60a2e22c3ff7ffceefa2719e58399f683 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md @@ -1,6 +1,6 @@ # @ohos.ability.featureAbility (FeatureAbility模块) -FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。 +FeatureAbility模块提供与用户进行交互的Ability的能力，包括启动新的Ability、停止Ability、获取dataAbilityHelper对象、获取当前Ability对应的窗口，连接断连Service等。 > **说明：** > @@ -9,7 +9,7 @@ FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动 ## 使用限制 -FeatureAbility模块的接口只能在Page类型的Ability调用 +FeatureAbility模块的接口只能在Page类型的Ability中调用 ## 导入模块 @@ -21,7 +21,12 @@ import featureAbility from '@ohos.ability.featureAbility'; startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void -启动新的ability（callback形式）。 +启动新的Ability（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -30,13 +35,13 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\) | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | +| callback | AsyncCallback\ | 是 | 以callback的形式返回启动Ability的结果。 | **示例：** ```ts import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; +import wantConstant from '@ohos.app.ability.wantConstant'; featureAbility.startAbility( { want: @@ -48,7 +53,7 @@ featureAbility.startAbility( deviceId: "", bundleName: "com.example.myapplication", /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", + abilityName: "com.example.myapplication.secondAbility", uri: "" }, }, @@ -64,7 +69,12 @@ featureAbility.startAbility( startAbility(parameter: StartAbilityParameter): Promise\ -启动新的ability（Promise形式）。 +启动新的Ability（Promise形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -74,11 +84,17 @@ startAbility(parameter: StartAbilityParameter): Promise\ | --------- | ---------------------------------------- | ---- | -------------- | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 | +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | ------- | +| Promise\ | Promise形式返回启动Ability结果。 | + **示例：** ```ts import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; +import wantConstant from '@ohos.app.ability.wantConstant'; featureAbility.startAbility( { want: @@ -90,7 +106,7 @@ featureAbility.startAbility( deviceId: "", bundleName: "com.example.myapplication", /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", + abilityName: "com.example.myapplication.secondAbility", uri: "" }, } @@ -103,7 +119,7 @@ featureAbility.startAbility( acquireDataAbilityHelper(uri: string): DataAbilityHelper -获取dataAbilityHelper。 +获取dataAbilityHelper对象。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -111,13 +127,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------------ | -| uri | string | 是 | 指示要打开的文件的路径。 | +| uri | string | 是 | 表示要打开的文件的路径。 | **返回值：** | 类型 | 说明 | | ----------------- | ------------------------------- | -| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | +| [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 用来协助其他Ability访问DataAbility的工具类。 | **示例：** @@ -132,7 +148,12 @@ var dataAbilityHelper = featureAbility.acquireDataAbilityHelper( startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\): void -启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#featureabilityterminateselfwithresult7)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -141,13 +162,13 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\ | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | | parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 | -| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 被指定的回调方法。 | +| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 以callback的形式返回启动Ability结果。 | **示例：** ```ts import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; +import wantConstant from '@ohos.app.ability.wantConstant'; featureAbility.startAbilityForResult( { want: @@ -159,7 +180,7 @@ featureAbility.startAbilityForResult( deviceId: "", bundleName: "com.example.myapplication", /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", + abilityName: "com.example.myapplication.secondAbility", uri:"" }, }, @@ -173,7 +194,12 @@ featureAbility.startAbilityForResult( startAbilityForResult(parameter: StartAbilityParameter): Promise\ -启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#featureabilityterminateselfwithresult7)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（Promise形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -187,13 +213,13 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\ | 类型 | 说明 | | ---------------------------------------- | ------- | -| Promise\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 返回执行结果。 | +| Promise\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | Promise形式返回启动Ability结果。 | **示例：** ```ts import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; +import wantConstant from '@ohos.app.ability.wantConstant'; featureAbility.startAbilityForResult( { want: @@ -205,7 +231,7 @@ featureAbility.startAbilityForResult( deviceId: "", bundleName: "com.example.myapplication", /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", + abilityName: "com.example.myapplication.secondAbility", uri:"", parameters: { @@ -229,7 +255,7 @@ featureAbility.startAbilityForResult( terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\): void -设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。 +停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -237,14 +263,14 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\ | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------------- | ---- | -------------- | -| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability。 | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示停止Ability之后返回的结果。 | +| callback | AsyncCallback\ | 是 | 以callback的形式返回停止Ability结果。 | **示例：** ```ts import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; +import wantConstant from '@ohos.app.ability.wantConstant'; featureAbility.terminateSelfWithResult( { resultCode: 1, @@ -257,7 +283,7 @@ featureAbility.terminateSelfWithResult( deviceId: "", bundleName: "com.example.myapplication", /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", + abilityName: "com.example.myapplication.secondAbility", uri:"", parameters: { mykey0: 2222, @@ -281,7 +307,7 @@ featureAbility.terminateSelfWithResult( terminateSelfWithResult(parameter: AbilityResult): Promise\ -设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。 +停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（Promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -289,19 +315,19 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\ | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------------- | ---- | ------------- | -| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability | +| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示停止Ability之后返回的结果 | **返回值：** | 类型 | 说明 | | -------------- | --------------- | -| Promise\ | 以Promise形式返回结果。 | +| Promise\ | 以Promise形式返回停止当前Ability结果。 | **示例：** ```ts import featureAbility from '@ohos.ability.featureAbility'; -import wantConstant from '@ohos.ability.wantConstant'; +import wantConstant from '@ohos.app.ability.wantConstant'; featureAbility.terminateSelfWithResult( { resultCode: 1, @@ -314,7 +340,7 @@ featureAbility.terminateSelfWithResult( deviceId: "", bundleName: "com.example.myapplication", /* FA模型中abilityName由package + Ability name组成 */ - abilityName: "com.example.entry.secondAbility", + abilityName: "com.example.myapplication.secondAbility", uri:"", parameters: { mykey0: 2222, @@ -345,7 +371,7 @@ hasWindowFocus(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ---------------------------------------- | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。
如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | +| callback | AsyncCallback\ | 是 | 以callback的形式返回结果。
如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | **示例：** @@ -368,7 +394,7 @@ hasWindowFocus(): Promise\ | 类型 | 说明 | | ----------------- | ------------------------------------- | -| Promise\ | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | +| Promise\ | Promise形式返回结果，如果此Ability当前具有视窗焦点，则返回true；否则返回false。 | **示例：** @@ -383,7 +409,7 @@ featureAbility.hasWindowFocus().then((data) => { getWant(callback: AsyncCallback\): void -获取从Ability发送的Want（callback形式）。 +获取要拉起的Ability对应的Want（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -391,7 +417,7 @@ getWant(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | --------- | -| callback | AsyncCallback\<[Want](js-apis-application-want.md)> | 是 | 被指定的回调方法。 | +| callback | AsyncCallback\<[Want](js-apis-application-want.md)> | 是 | 以callback的形式返回want。 | **示例：** @@ -406,7 +432,7 @@ featureAbility.getWant((err, data) => { getWant(): Promise\ -获取从Ability发送的Want（Promise形式）。 +获取要拉起的Ability对应的Want（Promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -414,7 +440,7 @@ getWant(): Promise\ | 类型 | 说明 | | ----------------------- | ---------------- | -| Promise\<[Want](js-apis-application-want.md)> | 以Promise的形式返回结果。 | +| Promise\<[Want](js-apis-application-want.md)> | 以Promise的形式返回want。 | **示例：** @@ -453,7 +479,7 @@ context.getBundleName((err, data) => { terminateSelf(callback: AsyncCallback\): void -设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。 +停止当前的Ability（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -461,7 +487,7 @@ terminateSelf(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------- | -| callback | AsyncCallback\ | 是 | 被指定的回调方法 | +| callback | AsyncCallback\ | 是 | 以callback的形式返回停止当前Ability结果 | **示例：** @@ -478,7 +504,7 @@ featureAbility.terminateSelf( terminateSelf(): Promise\ -设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。 +停止当前的Ability（Promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -486,7 +512,7 @@ terminateSelf(): Promise\ | 类型 | 说明 | | -------------- | ---------------- | -| Promise\ | 以Promise的形式返回结果。 | +| Promise\ | 以Promise的形式返回停止当前Ability结果。 | **示例：** @@ -501,7 +527,7 @@ featureAbility.terminateSelf().then((data) => { connectAbility(request: Want, options:ConnectOptions): number -将当前ability连接到指定ServiceAbility（callback形式）。 +将当前Ability与指定的ServiceAbility进行连接。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -510,13 +536,13 @@ connectAbility(request: Want, options:ConnectOptions): number | 参数名 | 类型 | 必填 | 说明 | | ------- | -------------- | ---- | --------------------- | | request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 | -| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 被指定的回调方法。 | +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 表示连接回调函数。 | **返回值：** | 类型 | 说明 | | ------ | -------------------- | -| number | 连接的ServiceAbilityID。 | +| number | 连接的ServiceAbility的ID(ID从0开始自增，每连接成功一次ID加1)。 | **示例：** @@ -536,7 +562,7 @@ var connectId = featureAbility.connectAbility( { deviceId: "", bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", + abilityName: "com.ix.ServiceAbility.ServiceAbilityA", }, { onConnect: onConnectCallback, @@ -558,8 +584,8 @@ disconnectAbility(connection: number, callback:AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | ---------- | -------------------- | ---- | ----------------------- | -| connection | number | 是 | 指定断开连接的ServiceAbilityID | -| callback | AsyncCallback\ | 是 | 被指定的回调方法 | +| connection | number | 是 | 表示断开连接的ServiceAbility的ID | +| callback | AsyncCallback\ | 是 | 以callback的形式返回断开连接结果 | **示例：** @@ -578,7 +604,7 @@ function onFailedCallback(code){ var connectId = featureAbility.connectAbility( { bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", + abilityName: "com.ix.ServiceAbility.ServiceAbilityA", }, { onConnect: onConnectCallback, @@ -605,13 +631,13 @@ disconnectAbility(connection: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ----------------------- | -| connection | number | 是 | 指定断开连接的ServiceAbilityID | +| connection | number | 是 | 表示断开连接的ServiceAbility的ID | **返回值：** | 类型 | 说明 | | -------------- | --------------- | -| Promise\ | 以Promise形式返回结果。 | +| Promise\ | 以Promise形式返回断开连接结果。 | **示例：** @@ -630,7 +656,7 @@ function onFailedCallback(code){ var connectId = featureAbility.connectAbility( { bundleName: "com.ix.ServiceAbility", - abilityName: "ServiceAbilityA", + abilityName: "com.ix.ServiceAbility.ServiceAbilityA", }, { onConnect: onConnectCallback, @@ -659,7 +685,7 @@ getWindow(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | ----------------------------- | -| callback | AsyncCallback\ | 是 | 返回与当前Ability对应的窗口。 | +| callback | AsyncCallback\<[window.Window](js-apis-window.md#window)> | 是 | callback形式返回当前Ability对应的窗口。 | **示例：** @@ -681,7 +707,7 @@ getWindow(): Promise\; | 类型 | 说明 | | ----------------------- | ----------------------------- | -| Promise\ | 返回与当前Ability对应的窗口。 | +| Promise\<[window.Window](js-apis-window.md#window)> | Promise形式返回当前Ability对应的窗口。 | **示例：** @@ -693,7 +719,7 @@ featureAbility.getWindow().then((data) => { ## AbilityWindowConfiguration -使用时通过featureAbility.AbilityWindowConfiguration获取。 +表示当前Ability对应的窗口配置项，使用时通过featureAbility.AbilityWindowConfiguration获取。 **示例：** @@ -707,14 +733,14 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED | ---------------------------------------- | ---- | ---------------------------------------- | | WINDOW_MODE_UNDEFINED7+ | 0 | 未定义。 | | WINDOW_MODE_FULLSCREEN7+ | 1 | 全屏。 | -| WINDOW_MODE_SPLIT_PRIMARY7+ | 100 | 分屏主屏。 | -| WINDOW_MODE_SPLIT_SECONDARY7+ | 101 | 分屏次屏。 | +| WINDOW_MODE_SPLIT_PRIMARY7+ | 100 | 屏幕如果是水平方向表示左分屏，屏幕如果是竖直方向表示上分屏。 | +| WINDOW_MODE_SPLIT_SECONDARY7+ | 101 | 屏幕如果是水平方向表示右分屏，屏幕如果是竖直方向表示下分屏。 | | WINDOW_MODE_FLOATING7+ | 102 | 悬浮窗。 | ## AbilityStartSetting -abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。 +表示当前Ability对应的窗口属性，abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。 使用时通过featureAbility.AbilityStartSetting获取。 @@ -734,7 +760,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ## ErrorCode -获取错误代码。 +表示错误码。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel @@ -742,13 +768,13 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY | ------------------------------ | ---- | ---------------------------------------- | | NO_ERROR7+ | 0 | 没有错误。 | | INVALID_PARAMETER7+ | -1 | 无效的参数。 | -| ABILITY_NOT_FOUND7+ | -2 | 找不到能力。 | -| PERMISSION_DENY7+ | -3 | 拒绝许可。 | +| ABILITY_NOT_FOUND7+ | -2 | 找不到ABILITY。 | +| PERMISSION_DENY7+ | -3 | 权限拒绝。 | ## DataAbilityOperationType -指示数据的操作类型。 +表示数据的操作类型。DataAbility批量操作数据时可以通过该枚举值指定操作类型 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel @@ -761,24 +787,26 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY ## flags说明 +表示处理Want的方式。 + **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 值 | 说明 | | ------------------------------------ | ---------- | ---------------------------------------- | -| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 | -| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 | -| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 | -| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 | -| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 | -| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | -| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 | -| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | -| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 | -| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | -| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | +| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 表示对URI执行读取操作的授权。 | +| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 表示对URI执行写入操作的授权。 | +| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 表示将结果返回给源Ability。 | +| FLAG_ABILITY_CONTINUATION | 0x00000008 | 表示是否可以将本地设备上的Ability迁移到远端设备。 | +| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 表示组件是否不属于OHOS。 | +| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 表示某个Ability是否已经启动。 | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 表示URI上可能持久化的授权。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 表示按照前缀匹配的方式验证URI权限。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 表示支持分布式调度系统中的多设备启动。 | +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 表示无论宿主应用是否已启动，都将使用前台模式启动Ability。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是否是可反向的。 | +| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 表示如果未安装指定的Ability，将安装该Ability。 | +| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 表示如果未安装指定的Ability，将在后台安装该Ability。 | +| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 表示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 | +| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 表示在已有的任务栈上创建任务的操作。 | +| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 表示如果启动的Ability的现有实例已位于任务栈顶，则将重用该实例。否则，将创建一个新的Ability实例。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md b/zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md index e081616b4318327aa1a17930fa6b21a30e4cb48e..c6dab933e02f7dcb50eb65198611b3a64b6368c1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md @@ -1,6 +1,6 @@ # @ohos.ability.particleAbility (ParticleAbility模块) -particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。 +particleAbility模块提供了操作Service类型的Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断连指定的ServiceAbility等。 > **说明：** > @@ -21,7 +21,12 @@ import particleAbility from '@ohos.ability.particleAbility' startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): void -使用此方法启动指定的particleAbility（callback形式）。 +启动指定的particleAbility（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -29,8 +34,8 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------------------------------- | ---- | ----------------- | -| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability | -| callback | AsyncCallback\ | 是 | 被指定的回调方法 | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示启动的ability | +| callback | AsyncCallback\ | 是 | 以callback的形式返回启动Ability的结果 | **示例：** @@ -62,7 +67,12 @@ particleAbility.startAbility( startAbility(parameter: StartAbilityParameter): Promise\; -使用此方法启动指定的particleAbility（Promise形式）。 +启动指定的particleAbility（Promise形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -70,13 +80,13 @@ startAbility(parameter: StartAbilityParameter): Promise\; | 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------------------------------- | ---- | ----------------- | -| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability | +| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示启动的ability | **返回值：** | 类型 | 说明 | | -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | +| Promise\ | Promise形式返回启动Ability的结果。 | **示例：** @@ -107,7 +117,7 @@ particleAbility.startAbility( terminateSelf(callback: AsyncCallback\): void -终止particleAbility（callback形式）。 +销毁当前particleAbility（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -115,7 +125,7 @@ terminateSelf(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法 | +| callback | AsyncCallback\ | 是 | 以callback的形式返回停止当前Ability结果 | **示例：** @@ -133,7 +143,7 @@ particleAbility.terminateSelf( terminateSelf(): Promise\ -终止particleAbility（Promise形式）。 +销毁当前particleAbility（Promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -141,7 +151,7 @@ terminateSelf(): Promise\ | 类型 | 说明 | | -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | +| Promise\ | 使用Promise形式返回停止当前Ability结果。 | **示例：** @@ -159,7 +169,7 @@ particleAbility.terminateSelf().then((data) => { acquireDataAbilityHelper(uri: string): DataAbilityHelper -获取dataAbilityHelper。 +获取dataAbilityHelper对象。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -167,13 +177,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper | 参数名 | 类型 | 必填 | 说明 | | :--- | ------ | ---- | ------------------------ | -| uri | string | 是 | 指示要打开的文件的路径。 | +| uri | string | 是 | 表示要打开的文件的路径。 | **返回值：** | 类型 | 说明 | | ----------------- | -------------------------------------------- | -| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 | +| [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 用来协助其他Ability访问DataAbility的工具类。 | **示例：** @@ -270,7 +280,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise<voi | 类型 | 说明 | | -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | +| Promise\ | 使用Promise形式返回启动长时任务的结果。 | **示例**： @@ -326,7 +336,7 @@ cancelBackgroundRunning(callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果 | + | callback | AsyncCallback<void> | 是 | callback形式返回取消长时任务的结果 | **示例**： @@ -357,7 +367,7 @@ cancelBackgroundRunning(): Promise<void>; | 类型 | 说明 | | -------------- | ------------------------- | -| Promise\ | 使用Promise形式返回结果。 | +| Promise\ | 使用Promise形式返回取消长时任务的结果。 | **示例**： @@ -376,7 +386,7 @@ particleAbility.cancelBackgroundRunning().then(() => { connectAbility(request: Want, options:ConnectOptions): number -将当前ability连接到指定ServiceAbility（callback形式）。 +将当前ability与指定的ServiceAbility进行连接（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -385,22 +395,13 @@ connectAbility(request: Want, options:ConnectOptions): number | 参数名 | 类型 | 必填 | 说明 | | ------- | -------------- | ---- | ---------------------------- | | request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 | -| options | ConnectOptions | 是 | 被指定的回调方法。 | - +| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 连接回调方法。 | -**ConnectOptions类型说明：** - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 类型 | 必填 | 说明 | -| ------------ | -------- | ---- | ------------------------- | -| onConnect | function | 是 | 连接成功时的回调函数。 | -| onDisconnect | function | 是 | 连接失败时的回调函数。 | -| onFailed | function | 是 | ConnectAbility调用失败时的回调函数。 | **示例**： ```ts +import particleAbility from '@ohos.ability.particleAbility' import rpc from '@ohos.rpc' function onConnectCallback(element, remote) { @@ -438,7 +439,7 @@ particleAbility.disconnectAbility(connId).then((data) => { disconnectAbility(connection: number, callback:AsyncCallback\): void; -将功能与服务功能断开连接。 +断开当前ability与指定ServiceAbility的连接（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -451,7 +452,8 @@ disconnectAbility(connection: number, callback:AsyncCallback\): void; **示例**： ```ts -import rpc from '@ohos.rpc' +import particleAbility from '@ohos.ability.particleAbility'; +import rpc from '@ohos.rpc'; function onConnectCallback(element, remote) { console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); @@ -488,7 +490,7 @@ particleAbility.disconnectAbility(connId, (err) => { disconnectAbility(connection: number): Promise\; -将功能与服务功能断开连接。 +断开当前ability与指定ServiceAbility的连接（Promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel @@ -501,7 +503,8 @@ disconnectAbility(connection: number): Promise\; **示例**： ```ts -import rpc from '@ohos.rpc' +import particleAbility from '@ohos.ability.particleAbility'; +import rpc from '@ohos.rpc'; function onConnectCallback(element, remote) { console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy)); @@ -537,7 +540,7 @@ particleAbility.disconnectAbility(connId).then((data) => { ## ErrorCode -获取错误代码。 +表示错误码。 **系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel 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 a32e9767651e5819fd88ef07e2f8da056a904a08..c07b6c469d6b32f365ac9e5e65a420489e328862 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 @@ -23,8 +23,8 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 枚举类型，表示启动原因。 | -| lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 枚举类型，表示最后退出原因。 | +| launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 指示启动原因。 | +| lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 表示最后退出原因。 | ## AbilityConstant.LaunchReason @@ -114,8 +114,8 @@ class MyAbility extends UIAbility { | --- | --- | --- | | WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 | | WINDOW_MODE_FULLSCREEN | 1 | 全屏模式。 | -| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏多窗口主要模式。 | -| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏多窗口次要模式。 | +| WINDOW_MODE_SPLIT_PRIMARY | 100 | 屏幕如果是水平方向表示左分屏，屏幕如果是竖直方向表示上分屏。 | +| WINDOW_MODE_SPLIT_SECONDARY | 101 | 屏幕如果是水平方向表示右分屏，屏幕如果是竖直方向表示下分屏。 | | WINDOW_MODE_FLOATING | 102 | 自由悬浮形式窗口模式。 | **示例：** 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 34cec4de8bedaf1001810412b0c4430df8f065f0..d150ed4402ef238f551a135cfcc3740f5c4f09ae 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 @@ -588,7 +588,7 @@ try { getForegroundApplications(callback: AsyncCallback\>): void; -获取当前所有前台应用的信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。 +获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。 **需要权限**：ohos.permission.GET_RUNNING_INFO @@ -608,7 +608,7 @@ getForegroundApplications(callback: AsyncCallback\>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | 是 | 以Promise方式返回接口运行结果及应用状态数据数组，可进行错误处理或其他自定义处理。 | +| callback | AsyncCallback\> | 是 | 以Callback方式返回接口运行结果及应用状态数据数组，可进行错误处理或其他自定义处理。 | **示例：** @@ -633,7 +633,7 @@ try { getForegroundApplications(): Promise\>; -获取当前所有前台应用的信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。 +获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。 **需要权限**：ohos.permission.GET_RUNNING_INFO @@ -645,7 +645,7 @@ getForegroundApplications(): Promise\>; | 类型 | 说明 | | -------- | -------- | -| Promise\> | 返回前台进程应用程序的数组。 | +| Promise\> | 以Promise形式返回所有当前处于前台的应用信息。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md index 449367a1b7cffda3e77125db26e6fc3cac69ee3e..240d075b5cc339c0ef242b3a8401fadcf167f797 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md @@ -1,25 +1,19 @@ # @ohos.app.ability.Configuration (Configuration) -定义环境变化信息。 +定义环境变化信息。Configuration是接口定义，仅做字段声明。 > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 - -```ts -import Configuration from '@ohos.app.ability.Configuration' -``` - **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | language | string | 是 | 是 | 表示应用程序的当前语言。例如：zh。 | -| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | -| direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | -| screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | +| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：未设置(COLOR_MODE_NOT_SET)，浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | +| direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | 是 | 否 | 表示屏幕方向，取值范围：未设置(DIRECTION_NOT_SET)，水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | +| screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | 是 | 否 | 表示屏幕分辨率，取值范围：未设置(SCREEN_DENSITY_NOT_SET)，SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | | displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 | | hasPointerDevice | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 | 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 80adf4b8d887a5e2694d7d6986321e94bf4b17c5..5ffbebe7a63d4b4ac1b51dd1bcb81cbe66931696 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 @@ -32,7 +32,7 @@ on(type:"mission", listener: MissionListener): number; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | listener | MissionListener | 是 | 系统任务监听方法。 | + | listener | [MissionListener](js-apis-inner-application-missionListener.md) | 是 | 系统任务监听方法。 | **返回值：** 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 a4b2d9d4f71ac20736d3435061a1bef2e6953e9c..2f5ef57a128cf21539b5d4c18a3e78fc85ea155f 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 @@ -80,7 +80,7 @@ Extension生命周期回调，在销毁时回调，执行资源清理等操作 onRequest(want: Want, startId: number): void; -Extension生命周期回调，如果是startAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。 +Extension生命周期回调，如果是startAbility或者startServiceExtensionAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md index c27facb973d1b854c26e8921bc0f4ec549529d43..75be4ed54cd66d8704a3e904c616994c0803e778 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md @@ -20,5 +20,34 @@ import StartOptions from '@ohos.app.ability.StartOptions'; | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| [windowMode](js-apis-application-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 | +| [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 | | displayId | number | 否 | 显示ID。 | + +**示例：** + + ```ts + import missionManager from '@ohos.app.ability.missionManager'; + + try { + missionManager.getMissionInfos("", 10, (error, missions) => { + if (error.code) { + console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) + + "error.message:" + JSON.stringify(error.message)); + return; + } + console.log("size = " + missions.length); + console.log("missions = " + JSON.stringify(missions)); + let id = missions[0].missionId; + + let startOptions = { + windowMode : 101, + displayId: 0 + }; + missionManager.moveMissionToFront(id, startOptions).then(() => { + console.log("moveMissionToFront is called "); + }); + }); + } catch (paramError) { + console.log("error: " + paramError.code + ", " + paramError.message); + } + ``` 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 6d9f7d70b72da1fa92413438a544bbd983602f95..866c3e20e18fb070c827f77598c222896294581e 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 @@ -42,7 +42,7 @@ Ability创建时回调，执行初始化业务逻辑操作。 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 | - | param | AbilityConstant.LaunchParam | 是 | 创建 ability、上次异常退出的原因信息。 | + | param | [AbilityConstant.LaunchParam](js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam) | 是 | 创建 ability、上次异常退出的原因信息。 | **示例：** @@ -67,7 +67,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | + | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 | **示例：** @@ -111,7 +111,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | + | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 | **示例：** @@ -199,13 +199,13 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; | 类型 | 说明 | | -------- | -------- | - | AbilityConstant.OnContinueResult | 继续的结果。 | + | [AbilityConstant.OnContinueResult](js-apis-app-ability-abilityConstant.md#abilityconstantoncontinueresult) | 继续的结果。 | **示例：** ```ts - import AbilityConstant from "@ohos.application.AbilityConstant" - class myAbility extends Ability { + import AbilityConstant from "@ohos.app.ability.AbilityConstant" + class MyUIAbility extends UIAbility { onContinue(wantParams) { console.log('onContinue'); wantParams["myData"] = "my1234567"; @@ -219,7 +219,7 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; -当ability的启动模式设置为单例时回调会被调用。 +当传入新的Want，ability再次被拉起时会回调执行该方法。 **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore @@ -227,17 +227,18 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | want | [Want](js-apis-application-want.md) | 是 | Want类型参数，如ability名称，包名等。 | - | launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 | + | want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 | + | launchParams | [AbilityConstant.LaunchParam](js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam) | 是 | UIAbility启动的原因、上次异常退出的原因信息。 | **示例：** ```ts - class myAbility extends Ability { - onNewWant(want) { + class MyUIAbility extends UIAbility { + onNewWant(want, launchParams) { console.log('onNewWant, want:' + want.abilityName); - } - } + console.log('onNewWant, launchParams:' + JSON.stringify(launchParams)); + } + } ``` ## Ability.onDump @@ -290,9 +291,9 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}) **示例：** ```ts -import AbilityConstant from '@ohos.application.AbilityConstant' +import AbilityConstant from '@ohos.app.ability.AbilityConstant' -class myAbility extends Ability { +class MyUIAbility extends UIAbility { onSaveState(reason, wantParam) { console.log('onSaveState'); wantParam["myData"] = "my1234567"; @@ -320,7 +321,7 @@ call(method: string, data: rpc.Sequenceable): Promise<void>; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | + | data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** @@ -401,13 +402,13 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | method | string | 是 | 约定的服务端注册事件字符串。 | - | data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 | + | data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 | **返回值：** | 类型 | 说明 | | -------- | -------- | - | Promise<rpc.MessageParcel> | Promise形式返回通用组件服务端应答数据。 | + | Promise<[rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)> | Promise形式返回通用组件服务端应答数据。 | **错误码：** @@ -527,7 +528,7 @@ release(): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 | + | callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 | **示例：** @@ -547,7 +548,7 @@ release(): void; console.log(' Caller OnRelease CallBack is called ' + str); }); } catch (error) { - console.log('Caller.on catch error, error.code: ' + JSON.stringify(error.code) + + console.log('Caller.onRelease catch error, error.code: ' + JSON.stringify(error.code) + ' error.message: ' + JSON.stringify(error.message)); } }).catch((err) => { @@ -571,7 +572,7 @@ release(): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 监听releaseCall事件，固定为'release'。 | - | callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 | + | callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 | **错误码：** @@ -609,6 +610,108 @@ release(): void; } ``` +## Caller.off + +off(type: "release", callback: OnReleaseCallback): void; + +取消注册通用组件服务端Stub（桩）断开监听通知。预留能力，当前暂未支持。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 监听releaseCall事件，固定为'release'。 | +| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回off回调结果。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + +**示例：** + + ```ts + var caller; + export default class MainUIAbility extends UIAbility { + onWindowStageCreate(windowStage) { + this.context.startAbilityByCall({ + bundleName: "com.example.myservice", + abilityName: "MainUIAbility", + deviceId: "" + }).then((obj) => { + caller = obj; + try { + let onReleaseCallBack = (str) => { + console.log(' Caller OnRelease CallBack is called ' + str); + }; + caller.on("release", onReleaseCallBack); + caller.off("release", onReleaseCallBack); + } catch (error) { + console.log('Caller.on or Caller.off catch error, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + } + }).catch((err) => { + console.log('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + + ' error.message: ' + JSON.stringify(err.message)); + }); + } + } + ``` + +## Caller.off + +off(type: "release"): void; + +取消注册通用组件服务端Stub（桩）断开监听通知。预留能力，当前暂未支持。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 监听releaseCall事件，固定为'release'。 | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------- | +| 401 | If the input parameter is not valid parameter. | +其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md) + +**示例：** + + ```ts + var caller; + export default class MainUIAbility extends UIAbility { + onWindowStageCreate(windowStage) { + this.context.startAbilityByCall({ + bundleName: "com.example.myservice", + abilityName: "MainUIAbility", + deviceId: "" + }).then((obj) => { + caller = obj; + try { + let onReleaseCallBack = (str) => { + console.log(' Caller OnRelease CallBack is called ' + str); + }; + caller.on("release", onReleaseCallBack); + caller.off("release"); + } catch (error) { + console.error('Caller.on or Caller.off catch error, error.code: ' + JSON.stringify(error.code) + + ' error.message: ' + JSON.stringify(error.message)); + } + }).catch((err) => { + console.error('Caller GetCaller error, error.code: ' + JSON.stringify(err.code) + + ' error.message: ' + JSON.stringify(err.message)); + }); + } + } + ``` ## Callee @@ -627,7 +730,7 @@ on(method: string, callback: CalleeCallback): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | method | string | 是 | 与客户端约定的通知消息字符串。 | - | callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数, 回调函数至少要返回一个空的rpc.Sequenceable数据对象, 其他视为函数执行错误。 | + | callback | [CalleeCallback](#calleecallback) | 是 | 一个[rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)类型入参的js通知同步回调函数, 回调函数至少要返回一个空的[rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated)数据对象, 其他视为函数执行错误。 | **错误码：** @@ -739,4 +842,4 @@ off(method: string): void; | 名称 | 可读 | 可写 | 类型 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 | +| (indata: [rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)) | 是 | 否 | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 被调用方注册的消息侦听器函数接口的原型。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md index 46990a60deb4414d7b9d06369cb0ef88ecd119a7..79cb1a5f4a26454cdb17b87860355a953dfb6646 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md @@ -25,7 +25,7 @@ import Want from '@ohos.app.ability.Want'; | type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | | flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | 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。 | +| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：
- ohos.aafwk.callerPid：表示拉起方的pid。
- ohos.aafwk.param.callerToken：表示拉起方的token。
- ohos.aafwk.param.callerUid：表示[BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。
- component.startup.newRules：表示是否启用新的管控规则。
- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。
- ohos.dlp.params.sandbox：表示dlp文件才会有。 | | | entities | Array\ | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | | moduleName | string | 否 | 表示待启动的Ability所属的模块（module）。 | @@ -122,7 +122,7 @@ import Want from '@ohos.app.ability.Want'; "abilityName": "MainAbility", "moduleName": "entry", // moduleName非必选 "parameters": { - "keyFd":{"type":"FD", "value":fd} + "keyFd":{"type":"FD", "value":fd} // {"type":"FD", "value":fd}是固定用法，用于表示该数据是FD } }; this.context.startAbility(want, (error) => { diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md index 20aa63ed78f52a50a1254e1dafc7dc3f0f9c59bd..5aadd796d7e3f4dbc33f9805fa100642d07e0d1b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md @@ -85,7 +85,7 @@ getWantAgent(info: WantAgentInfo): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ---- | ------------- | ---- | ------------- | -| info | WantAgentInfo | 是 | WantAgent信息。 | +| info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 | **返回值：** @@ -451,7 +451,7 @@ getWant(agent: WantAgent, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ------------------------------- | | agent | WantAgent | 是 | WantAgent对象。 | -| callback | AsyncCallback\ | 是 | 获取WantAgent对象want的回调方法。 | +| callback | AsyncCallback\<[Want](js-apis-app-ability-want.md)\> | 是 | 获取WantAgent对象want的回调方法。 | **示例：** @@ -752,7 +752,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\ | 否 | 主动激发WantAgent实例的回调方法。 | +| callback | AsyncCallback\<[CompleteData](#completedata)\> | 否 | 主动激发WantAgent实例的回调方法。 | **示例：** @@ -1152,6 +1152,6 @@ try { | info | WantAgent | 是 | 触发的wantAgent。 | | want | Want | 是 | 存在的被触发的want。 | | finalCode | number | 是 | 触发wantAgent的请求代码。| -| finalData | string | 否 | 公共事件收集的最终数据。 | +| finalData | string | 是 | 公共事件收集的最终数据。 | | extraInfo | {[key: string]: any} | 否 | 额外数据。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index 892e1d64dc7e9db9ac953f7178e8d3c0d8e41ab8..df08aed5ecb0c7e8092cf43f265c49f391d2250b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -67,7 +67,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | + | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 | **示例：** @@ -111,7 +111,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | windowStage | window.WindowStage | 是 | WindowStage相关信息。 | + | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 | **示例：** @@ -219,7 +219,7 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult; onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; -当ability的启动模式设置为单例时回调会被调用。 +当传入新的Want，ability再次被拉起时会回调执行该方法。 **系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore @@ -234,8 +234,9 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void; ```ts class myAbility extends Ability { - onNewWant(want) { + onNewWant(want, launchParams) { console.log('onNewWant, want:' + want.abilityName); + console.log('onNewWant, launchParams:' + JSON.stringify(launchParams)); } } ``` 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 index afd313ca4a34807a43e8b473ec67082cd02ac454..5d203e65258053d5df1822f037899289d4aab808 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -21,8 +21,8 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | -| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | +| launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 指示启动原因。 | +| lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 表示最后退出原因。 | ## AbilityConstant.LaunchReason diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md index 7316469ebf390dacd4684f08a3b454cff18d6491..d61c81f1e9a5f3bb9c401506830ebd55f1a706d3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorRegistry.md @@ -1,6 +1,6 @@ # @ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry) -AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 +AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。该模块中的接口只能用于测试框架中。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md index b734967666cdd2beb6e8302137135c598d34c1e8..717f2bdcb2fa2e29dea7912d42b843e971681a43 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md @@ -112,7 +112,7 @@ getAbilityRunningInfos(callback: AsyncCallback\>): vo | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------------- | -| callback | AsyncCallback\> | 是 | 被指定的回调方法。 | +| callback | AsyncCallback\> | 是 | 被指定的回调方法。 | **示例**： @@ -138,7 +138,7 @@ getAbilityRunningInfos(): Promise\> | 类型 | 说明 | | ---------------------------------------- | ------- | -| Promise\> | 返回执行结果。 | +| Promise\> | 返回执行结果。 | **示例**： @@ -150,119 +150,4 @@ abilitymanager.getAbilityRunningInfos().then((data) => { }).catch((err) => { console.log("getAbilityRunningInfos err: " + err) }); -``` - -## getExtensionRunningInfos9+ - -getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\>): void - -获取关于运行扩展能力的信息（callback形式）。 - -**需要权限**: ohos.permission.GET_RUNNING_INFO - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------------- | -| upperLimit | number | 是 | 获取消息数量的最大限制。 | -| callback | AsyncCallback\> | 是 | 被指定的回调方法。 | - -**示例**： - -```ts -import abilitymanager from '@ohos.application.abilityManager'; - -var upperLimit = 0; - -abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { - console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); -}); -``` - -## getExtensionRunningInfos9+ - -getExtensionRunningInfos(upperLimit: number): Promise\> - -获取关于运行扩展能力的信息（Promise形式）。 - -**需要权限**: ohos.permission.GET_RUNNING_INFO - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------------- | -| upperLimit | number | 是 | 获取消息数量的最大限制。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------------------------------- | ------- | -| Promise\> | 返回执行结果。 | - -**示例**： - -```ts -import abilitymanager from '@ohos.application.abilityManager'; - -var upperLimit = 0; - -abilitymanager.getExtensionRunningInfos(upperLimit).then((data) => { - console.log("getAbilityRunningInfos data: " + JSON.stringify(data)); -}).catch((err) => { - console.log("getAbilityRunningInfos err: " + err); -}) -``` - -## getTopAbility9+ - -getTopAbility(callback: AsyncCallback\): void; - -获取窗口焦点的ability接口（callback形式）。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**参数**： - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------------- | -| callback | AsyncCallback\ | 是 | 被指定的回调方法。 | - -**示例**： - -```ts -import abilitymanager from '@ohos.application.abilityManager'; - -abilitymanager.getTopAbility((err,data) => { - console.log("getTopAbility err: " + err + " data: " + JSON.stringify(data)); -}); -``` - -## getTopAbility9+ - -getTopAbility(): Promise\; - -获取窗口焦点的ability接口（Promise形式）。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -**返回值：** - -| 类型 | 说明 | -| ---------------------------------------- | ------- | -| Promise\| 返回执行结果。 | - -**示例**： - -```ts -import abilitymanager from '@ohos.application.abilityManager'; - -abilitymanager.getTopAbility().then((data) => { - console.log("getTopAbility data: " + JSON.stringify(data)); -}).catch((err) => { - console.log("getTopAbility err: " + err); -}) ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md index 2804125a07b0e6406101d314360b1ec2874aadbb..ef6a02866bd167e79d6f7bd148403401b1daaec7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md @@ -31,7 +31,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens | 名称 | 类型 | 可读 | 可写 | 说明 | | --------- | ---------------------------------------- | ---- | ---- | ---------- | | eventType | [accessibility.EventType](js-apis-accessibility.md#EventType) \| [accessibility.WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](#touchguidetype) \| [GestureType](#gesturetype) \| [PageUpdateType](#pageupdatetype) | 是 | 否 | 具体事件类型。 | -| target | AccessibilityElement | 是 | 否 | 发生事件的目标组件。 | +| target | [AccessibilityElement](js-apis-inner-application-accessibilityExtensionContext.md#accessibilityelement9) | 是 | 否 | 发生事件的目标组件。 | | timeStamp | number | 是 | 否 | 事件时间戳。 | ## GestureType 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 f3f51dfbed3ba36ea4e154b4663c28acb92294f5..bfa157e2dc581a53e783b71b32f5215206e2d61f 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 @@ -121,7 +121,7 @@ getAppMemorySize(): Promise\; | 类型 | 说明 | | -------- | -------- | - | Promise<number> | 应用程序内存大小。 | + | Promise<number> | 应用程序内存大小, 单位为M。 | **示例：** @@ -145,7 +145,7 @@ getAppMemorySize(callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<number> | 是 | 应用程序内存大小。 | + | callback | AsyncCallback<number> | 是 | 应用程序内存大小, 单位为M。 | **示例：** @@ -161,7 +161,7 @@ getProcessRunningInfos(): Promise\>; 获取有关运行进程的信息。 -> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9)替代。 +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](js-apis-app-ability-appManager.md#appmanagergetprocessrunninginformation9)替代。 **需要权限**：ohos.permission.GET_RUNNING_INFO @@ -171,7 +171,7 @@ getProcessRunningInfos(): Promise\>; | 类型 | 说明 | | -------- | -------- | -| Promise\> | 获取有关运行进程的信息。 | +| Promise\> | 获取有关运行进程的信息。 | **示例：** @@ -189,7 +189,7 @@ getProcessRunningInfos(callback: AsyncCallback\>): vo 获取有关运行进程的信息。 -> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1)替代。 +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](js-apis-app-ability-appManager.md#appmanagergetprocessrunninginformation9-1)替代。 **需要权限**：ohos.permission.GET_RUNNING_INFO @@ -199,7 +199,7 @@ getProcessRunningInfos(callback: AsyncCallback\>): vo | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | +| callback | AsyncCallback\> | 是 | 获取有关运行进程的信息。 | **示例：** @@ -420,8 +420,8 @@ unregisterApplicationStateObserver(observerId: number): Promise\; getForegroundApplications(callback: AsyncCallback\>): void; -获取前台进程的应用程序。 - +获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。 + **需要权限**：ohos.permission.GET_RUNNING_INFO **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -432,7 +432,7 @@ getForegroundApplications(callback: AsyncCallback\>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | 是 | 表示应用的状态数据。 | +| callback | AsyncCallback\> | 是 | callback形式返回所有当前处于前台的应用信息。 | **示例：** @@ -451,7 +451,7 @@ getForegroundApplications(callback: AsyncCallback\>): void; getForegroundApplications(): Promise\>; -获取前台进程的应用程序。 +获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。 **需要权限**：ohos.permission.GET_RUNNING_INFO @@ -463,7 +463,7 @@ getForegroundApplications(): Promise\>; | 类型 | 说明 | | -------- | -------- | -| Promise\> | 返回进程运行信息的数组。 | +| Promise\> | Promise形式返回所有当前处于前台的应用信息。 | **示例：** @@ -684,32 +684,4 @@ clearUpApplicationData(bundleName: string): Promise\; .catch((err) => { console.log('------------ clearUpApplicationData fail ------------', err); }) - ``` - -## ApplicationState9+ - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 值 | 说明 | -| -------------------- | --- | --------------------------------- | -| STATE_CREATE | 1 | 当应用在创建中的时候处于的状态。 | -| STATE_FOREGROUND | 2 | 当应用切换到前台的时候处于的状态。 | -| STATE_ACTIVE | 3 | 当应用在获焦的时候处于的状态。 | -| STATE_BACKGROUND | 4 | 当应用处于后台不可见时处于的状态。 | -| STATE_DESTROY | 5 | 当应用在销毁的时候处于的状态。 | - -## ProcessState9+ - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -| 名称 | 值 | 说明 | -| -------------------- | --- | --------------------------------- | -| STATE_CREATE | 1 | 当进程在创建中的时候处于的状态。 | -| STATE_FOREGROUND | 2 | 当进程切换到前台的时候处于的状态。 | -| STATE_ACTIVE | 3 | 当进程在获焦的时候处于的状态。 | -| STATE_BACKGROUND | 4 | 当进程处于后台不可见时处于的状态。 | -| STATE_DESTROY | 5 | 当进程在销毁的时候处于的状态。 | \ No newline at end of file + ``` \ No newline at end of file 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 b632f5ddd1e8703b864c507ec8376325bfc6a88f..1e4211c7b01b29f38829f231f2b9f054db71b47c 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 @@ -1,27 +1,17 @@ # @ohos.application.Configuration (Configuration) -定义环境变化信息。 +定义环境变化信息。Configuration是接口定义，仅做字段声明。 > **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块从API version 9废弃，替换模块为[@ohos.app.ability.Configuration (Configuration)](js-apis-app-ability-configuration.md) -## 导入模块 - -```ts -import Configuration from '@ohos.application.Configuration' -``` - **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | language8+ | string | 是 | 是 | 表示应用程序的当前语言。 | | colorMode8+ | [ColorMode](js-apis-application-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 | -| direction9+ | [Direction](js-apis-application-configurationConstant.md#configurationconstantdirection9) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 | -| screenDensity9+ | [ScreenDensity](js-apis-application-configurationConstant.md#configurationconstantscreendensity9) | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 | -| displayId9+ | number | 是 | 否 | 表示应用所在的物理屏幕Id。 | -| hasPointerDevice9+ | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 | 具体字段描述参考ohos.application.Configuration.d.ts文件 @@ -45,10 +35,6 @@ export default class MainAbility extends Ability { console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) let language = config.language; let colorMode = config.colorMode; - let direction = config.direction; - let screenDensity = config.screenDensity; - let displayId = config.displayId; - let hasPointerDevice = config.hasPointerDevice; } }; diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md index f7908e521cbbe805352a7c305f00340ce8e9be20..43c5dd975a8ccf19622bfae531774001f2199f0e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-configurationConstant.md @@ -24,32 +24,3 @@ import ConfigurationConstant from '@ohos.application.ConfigurationConstant'; | COLOR_MODE_DARK | 0 | 深色模式。 | | COLOR_MODE_LIGHT | 1 | 浅色模式。 | - -## ConfigurationConstant.Direction9+ - -使用时通过ConfigurationConstant.Direction获取。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| DIRECTION_NOT_SET | -1 | 未设置方向。 | -| DIRECTION_VERTICAL | 0 | 垂直方向。 | -| DIRECTION_HORIZONTAL | 1 | 水平方向。 | - - -## ConfigurationConstant.ScreenDensity9+ - -使用时通过ConfigurationConstant.ScreenDensity获取。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 | -| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 | -| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 | -| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 | -| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 | -| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 | -| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-application-context.md deleted file mode 100644 index c5253ad01b9b50bff483ae8f0ab7e7234f43dfd0..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-context.md +++ /dev/null @@ -1,41 +0,0 @@ -# @ohos.application.context (Context) - -Context模块将二级模块API组织在一起方便开发者进行导出。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用 - -## 导入模块 - -```ts -import context from '@ohos.application.context' -``` - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase - -| 名称 | 读写属性 | 类型 | 必填 | 描述 | -| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| AbilityContext | 只读 | [AbilityContext](js-apis-ability-context.md) | 否 | AbilityContext二级模块。 | -| AbilityStageContext | 只读 | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 否 | AbilityStageContext二级模块。 | -| ApplicationContext | 只读 | [ApplicationContext](js-apis-inner-application-applicationContext.md) | 否 | ApplicationContext二级模块。 | -| BaseContext | 只读 | [BaseContext](js-apis-inner-application-baseContext.md) | 否 | BaseContext二级模块。 | -| 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二级模块。 | -| EventHub | 只读 | [EventHub](js-apis-inner-application-eventHub.md) | 否 | EventHub二级模块。 | -| PermissionRequestResult | 只读 | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | 否 | PermissionRequestResult二级模块。 | - -**示例：** -```ts -let abilityContext: context.AbilityContext; -let abilityStageContext: context.AbilityStageContext; -let applicationContext: context.ApplicationContext; -let baseContext: context.BaseContext; -let context: context.Context; -let extensionContext: context.ExtensionContext; -let formExtensionContext: context.FormExtensionContext; -let eventHub: context.EventHub; -let permissionRequestResult: context.PermissionRequestResult; -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md deleted file mode 100644 index 807159d2145c83f533e8ea242820088d352f75ef..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-extensionAbility.md +++ /dev/null @@ -1,62 +0,0 @@ -# @ohos.application.ExtensionAbility (ExtensionAbility) - -ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力，包括ExtensionAbility创建、销毁、转储客户端信息等。 - -> **说明：** -> -> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import ExtensionAbility from '@ohos.application.ExtensionAbility'; -``` - -## ExtensionAbility.onConfigurationUpdated - -onConfigurationUpdated(newConfig: Configuration): void; - -当系统配置更新时调用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | newConfig | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | - -**示例：** - - ```ts - class MyExtensionAbility extends ExtensionAbility { - onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); - } - } - ``` - -## ExtensionAbility.onMemoryLevel - -onMemoryLevel(level: AbilityConstant.MemoryLevel): void; - -当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别，显示当前内存使用状态。| - -**示例：** - - ```ts - class MyExtensionAbility extends ExtensionAbility { - onMemoryLevel(level) { - console.log('onMemoryLevel, level:' + JSON.stringify(level)); - } - } - ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md index 21b6a8f94ec1289e3b51740c8b7fdea15f13d2c9..db27ea9695657671148f45f203201f4095180466 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md @@ -31,12 +31,9 @@ onReceiveEvent(event: CommonEventData): void; **示例：** ```ts - var StaticSubscriberExtensionAbility = requireNapi("application.StaticSubscriberExtensionAbility") - { - onReceiveEvent(event){ - console.log('onReceiveEvent,event:' + event.code); - } - } - export default MyStaticSubscriberExtensionAbility - + class MyStaticSubscriberExtensionAbility extends StaticSubscriberExtensionAbility { + onReceiveEvent(event) { + console.log("onReceiveEvent, event: " + JSON.stringify(event)) + } + } ``` \ No newline at end of file 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 972d7e6e118dc8c4f9ee9562d439c48bf1be0ebb..63c9523e66a7cc67b9483aef3b0a4e2a9b713a9a 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 @@ -4,7 +4,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 > **说明：** > -> 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 8 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.Want](js-apis-app-ability-want.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -25,7 +25,7 @@ import Want from '@ohos.application.Want'; | type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | | flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | 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。 | +| 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-inner-ability-connectOptions.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md index 9e6e1755b9f38d829dac7d582362568a73afa703..23c699c61844ce162f0f2cce48305b5dfe0aab35 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md @@ -10,3 +10,25 @@ | onDisconnect7+ | function | 是 | 断开连接时的回调函数。 | | onFailed7+ | function | 是 | 连接失败时的回调函数。 | +**示例：** + + ```ts + let want = { + bundleName: "com.example.myapp", + abilityName: "MyAbility" + }; + + let connectOptions = { + onConnect(elementName, remote) { + console.log('onConnect elementName: ' + elementName); + }, + onDisconnect(elementName) { + console.log('onDisconnect elementName: ' + elementName); + }, + onFailed(code) { + console.error('onFailed code: ' + code); + } + } + + let connection = this.context.connectAbility(want, connectOptions); + ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md index be9ed68779a7f88e1d9bcb7111e06587c034d791..4caa0af24ff66ef7a50d6c8c0df8a302cf51880d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md @@ -4,7 +4,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 > **说明：** > -> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 6开始支持，从API version 9废弃，使用[@ohos.app.ability.Want](js-apis-app-ability-want.md)模块替代。后续版本的新增接口，采用上角标单独标记接口的起始版本。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase @@ -17,7 +17,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 | type | string | 否 | 表示MIME type类型，打开文件的类型，主要用于文管打开文件。比如："text/xml" 、 "image/*"等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | | flags | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-ability-wantConstant.md#wantConstant.Flags)。 | | 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。 | +| 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-inner-app-processInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md index 4a70b8ec6c4296606a5a0f06525fb98a2c651e6a..c648a2e0fc59849165c02b7b2a8ea395c086cfcd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-processInfo.md @@ -19,9 +19,11 @@ import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext(); context.getProcessInfo((err, data) => { - console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); - let pid = data.pid; - let processName = data.processName; + if (err.code != 0) { + console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data)); + let pid = data.pid; + let processName = data.processName; + } }); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md index 4664de608fb2b18de7a2160e1c178ade303a1de2..1aa125e161ae0c4118e3f4f989cdb2648c291dcc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageContext.md @@ -1,6 +1,6 @@ # AbilityStageContext -AbilityStageContext是AbilityStage的上下文环境，继承自[Context](js-apis-application-context.md)。 +AbilityStageContext是AbilityStage的上下文环境，继承自[Context](js-apis-inner-application-context.md)。 AbilityStageContext提供允许访问特定于abilityStage的资源的能力，包括获取AbilityStage对应的ModuleInfo对象、环境变化对象。 @@ -28,5 +28,5 @@ class MyAbilityStage extends AbilityStage { | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。 | +| currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | 是 | 否 | AbilityStage对应的ModuleInfo对象。 | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 环境变化对象。 | 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 0b4e15087ccbd6d01561b57998b521c1cc113039..41dc3d57e5bd6782f1f8a2e32d27a6ddb41ab46e 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 @@ -15,9 +15,9 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力， let applicationContext = this.context.getApplicationContext(); ``` -## ApplicationContext.registerAbilityLifecycleCallback +## ApplicationContext.on(type: "abilityLifecycle", callback: AbilityLifecycleCallback) -registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number**; +on(type: "abilityLifecycle", callback: AbilityLifecycleCallback): **number**; 注册监听应用内生命周期 @@ -27,6 +27,7 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** | 参数名 | 类型 | 必填 | 说明 | | ------------------------ | -------- | ---- | ------------------------------ | +| type | "abilityLifecycle" | 是 | 监听事件的类型。 | | callback | [AbilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | **返回值：** @@ -38,58 +39,58 @@ registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): **number** **示例：** ```ts -import Ability from "@ohos.application.Ability"; +import UIAbility from '@ohos.app.ability.UIAbility'; var lifecycleId; -export default class MyAbility extends Ability { +export default class EntryAbility extends UIAbility { onCreate() { console.log("MyAbility onCreate") let AbilityLifecycleCallback = { onAbilityCreate(ability) { - console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onAbilityCreate ability:" + ability); }, onWindowStageCreate(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); + console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + ability); + console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + windowStage); }, onWindowStageActive(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); + console.log("AbilityLifecycleCallback onWindowStageActive ability:" + ability); + console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + windowStage); }, onWindowStageInactive(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); + console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + ability); + console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + windowStage); }, onWindowStageDestroy(ability, windowStage) { - console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); - console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); + console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + ability); + console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + windowStage); }, onAbilityDestroy(ability) { - console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + ability); }, onAbilityForeground(ability) { - console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onAbilityForeground ability:" + ability); }, onAbilityBackground(ability) { - console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onAbilityBackground ability:" + ability); }, onAbilityContinue(ability) { - console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); + console.log("AbilityLifecycleCallback onAbilityContinue ability:" + ability); } } // 1.通过context属性获取applicationContext let applicationContext = this.context.getApplicationContext(); // 2.通过applicationContext注册监听应用内生命周期 - lifecycleId = applicationContext.registerAbilityLifecycleCallback(AbilityLifecycleCallback); + lifecycleId = applicationContext.on("abilityLifecycle", AbilityLifecycleCallback); console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId)); } } ``` -## ApplicationContext.unregisterAbilityLifecycleCallback +## ApplicationContext.off(type: "abilityLifecycle", callbackId: number, callback: AsyncCallback) -unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; +off(type: "abilityLifecycle", callbackId: **number**, callback: AsyncCallback<**void**>): **void**; 取消监听应用内生命周期 @@ -99,30 +100,62 @@ unregisterAbilityLifecycleCallback(callbackId: **number**, callback: AsyncCallb | 参数名 | 类型 | 必填 | 说明 | | ------------- | -------- | ---- | -------------------------- | +| type | "abilityLifecycle" | 是 | 取消监听事件的类型。 | | callbackId | number | 是 | 注册监听应用内生命周期的ID。 | | callback | AsyncCallback\ | 是 | 回调方法。 | **示例：** ```ts -import Ability from "@ohos.application.Ability"; +import UIAbility from '@ohos.app.ability.UIAbility'; var lifecycleId; -export default class MyAbility extends Ability { +export default class EntryAbility extends UIAbility { onDestroy() { let applicationContext = this.context.getApplicationContext(); - console.log("stage applicationContext: " + JSON.stringify(applicationContext)); - applicationContext.unregisterAbilityLifecycleCallback(lifecycleId, (error, data) => { + console.log("stage applicationContext: " + applicationContext); + applicationContext.off(type: "abilityLifecycle", lifecycleId, (error, data) => { console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); }); } } ``` -## ApplicationContext.registerEnvironmentCallback +## ApplicationContext.off(type: "abilityLifecycle", callbackId: number) + +off(type: "abilityLifecycle", callbackId: **number**): **void**; + +取消监听应用内生命周期 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | -------- | ---- | -------------------------- | +| type | "abilityLifecycle" | 是 | 取消监听事件的类型。 | +| callbackId | number | 是 | 注册监听应用内生命周期的ID。 | + +**示例：** + +```ts +import Ability from "@ohos.app.ability.UIAbility"; + +var lifecycleId; + +export default class MyAbility extends Ability { + onDestroy() { + let applicationContext = this.context.getApplicationContext(); + console.log("stage applicationContext: " + applicationContext); + applicationContext.off(type: "abilityLifecycle", lifecycleId); + } +} +``` + +## ApplicationContext.on(type: "environment", callback: EnvironmentCallback) -registerEnvironmentCallback(callback: EnvironmentCallback): **number**; +on(type: "environment", callback: EnvironmentCallback): **number**; 注册对系统环境变化的监听。使用callback异步回调。 @@ -132,6 +165,7 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**; | 参数名 | 类型 | 必填 | 说明 | | ------------------------ | -------- | ---- | ------------------------------ | +| type | "environment" | 是 | 监听事件的类型。 | | callback | [EnvironmentCallback](js-apis-app-ability-environmentCallback.md) | 是 | 回调方法，返回注册监听事件的ID。 | **返回值：** @@ -143,11 +177,11 @@ registerEnvironmentCallback(callback: EnvironmentCallback): **number**; **示例：** ```ts -import Ability from "@ohos.application.Ability"; +import UIAbility from '@ohos.app.ability.UIAbility'; var callbackId; -export default class MyAbility extends Ability { +export default class EntryAbility extends UIAbility { onCreate() { console.log("MyAbility onCreate") globalThis.applicationContext = this.context.getApplicationContext(); @@ -155,19 +189,22 @@ export default class MyAbility extends Ability { onConfigurationUpdated(config){ console.log("onConfigurationUpdated config:" + JSON.stringify(config)); }, + onMemoryLevel(level){ + console.log("onMemoryLevel level:" + level); + } } // 1.获取applicationContext let applicationContext = globalThis.applicationContext; // 2.通过applicationContext注册监听应用内生命周期 - callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback); + callbackId = applicationContext.on("environment", EnvironmentCallback); console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId)); } } ``` -## ApplicationContext.unregisterEnvironmentCallback +## ApplicationContext.off(type: "environment", callbackId: number, callback: AsyncCallback) -unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<**void**>): **void**; +off(type: "environment", callbackId: **number**, callback: AsyncCallback<**void**>): **void**; 取消对系统环境变化的监听。使用callback异步回调。 @@ -177,22 +214,163 @@ unregisterEnvironmentCallback(callbackId: **number**, callback: AsyncCallback<* | 参数名 | 类型 | 必填 | 说明 | | ------------- | -------- | ---- | -------------------------- | +| type | "environment" | 是 | 取消监听事件的类型。 | | callbackId | number | 是 | 注册监听系统环境变化的ID。 | | callback | AsyncCallback\ | 是 | 回调方法。 | **示例：** ```ts -import Ability from "@ohos.application.Ability"; +import UIAbility from '@ohos.app.ability.UIAbility'; var callbackId; -export default class MyAbility extends Ability { +export default class EntryAbility extends UIAbility { onDestroy() { let applicationContext = this.context.getApplicationContext(); - applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => { + applicationContext.off("environment", callbackId, (error, data) => { console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error)); }); } } +``` + +## ApplicationContext.off(type: "environment", callbackId: number) + +off(type: "environment", callbackId: **number**, callback: AsyncCallback<**void**>): **void**; + +取消对系统环境变化的监听。使用callback异步回调。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | -------- | ---- | -------------------------- | +| type | "environment" | 是 | 取消监听事件的类型。 | +| callbackId | number | 是 | 注册监听系统环境变化的ID。 | + +**示例：** + +```ts +import Ability from "@ohos.app.ability.UIAbility"; + +var callbackId; + +export default class MyAbility extends Ability { + onDestroy() { + let applicationContext = this.context.getApplicationContext(); + applicationContext.off("environment", callbackId); + } +} +``` + +## ApplicationContext.getProcessRunningInformation9+ + +getProcessRunningInformation(): Promise\>; + +获取有关运行进程的信息。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 以Promise方式返回接口运行结果及有关运行进程的信息，可进行错误处理或其他自定义处理。 | + +**示例：** + +```ts +let applicationContext = this.context.getApplicationContext(); +applicationContext.getProcessRunningInformation().then((data) => { + console.log("The process running information is:" + JSON.stringify(data)); +}).catch((error) => { + console.log("error:" + JSON.stringify(error)); +}); +``` + +## ApplicationContext.getProcessRunningInformation9+ + +getProcessRunningInformation(callback: AsyncCallback\>): void; + +获取有关运行进程的信息。 + +**需要权限**：ohos.permission.GET_RUNNING_INFO + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +|AsyncCallback\> | 以回调方式返回接口运行结果及有关运行进程的信息，可进行错误处理或其他自定义处理。 | + +**示例：** + +```ts +let applicationContext = this.context.getApplicationContext(); +applicationContext.getProcessRunningInformation((err, data) => { + if (err.code !== 0) { + console.error("getProcessRunningInformation faile, err: " + JSON.stringify(err)); + } else { + console.log("The process running information is:" + JSON.stringify(data)); + } +}) +``` + +## ApplicationContext.killProcessesBySelf9+ + +killProcessesBySelf(): Promise; + +杀死应用所在的进程。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Promise\> | 以Promise方式返回杀死应用所在的进程结果。 | + +**示例：** + +```ts +let applicationContext = this.context.getApplicationContext(); +applicationContext.killProcessesBySelf().then((data) => { + console.log("The process running information is:" + JSON.stringify(data)); +}).catch((error) => { + console.error("error:" + JSON.stringify(error)); +}); +``` + +## ApplicationContext.killProcessesBySelf9+ + +killProcessesBySelf(callback: AsyncCallback); + +杀死应用所在的进程。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +|AsyncCallback\ | 以callback方式返回杀死应用所在的进程结果。 | + +**示例：** + +```ts +let applicationContext = this.context.getApplicationContext(); +applicationContext.killProcessesBySelf(err => { + if (err.code !== 0) { + console.error("killProcessesBySelf faile, err: " + JSON.stringify(err)); + } +}) ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md index 85861abfda9517597aba145bed6686b1c049e841..d1e4ce8fe87b619680f64bc080d6ab87d1bfc33e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md @@ -245,6 +245,11 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\< 根据account启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**: 此接口为系统接口，三方应用不支持调用。 @@ -316,6 +321,11 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca 根据account启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**: 此接口为系统接口，三方应用不支持调用。 @@ -392,6 +402,11 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): 根据account启动Ability（Promise形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**: 此接口为系统接口，三方应用不支持调用。 @@ -1199,7 +1214,7 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| connection | number | 是 | 在connectAbility中返回的number。 | +| connection | number | 是 | 在connectServiceExtensionAbility中返回的number。 | | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | **错误码：** @@ -1251,7 +1266,7 @@ disconnectServiceExtensionAbility(connection: number): Promise<void>; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| connection | number | 是 | 在connectAbility中返回的number。 | +| connection | number | 是 | 在connectServiceExtensionAbility中返回的number。 | **返回值：** @@ -1273,7 +1288,7 @@ disconnectServiceExtensionAbility(connection: number): Promise<void>; **示例：** ```ts - // connection为connectAbility中的返回值 + // connection为connectServiceExtensionAbility中的返回值 var connection = 1; try { @@ -1300,6 +1315,11 @@ startAbilityByCall(want: Want): Promise<Caller>; 启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统API**：此接口为系统接口，三方应用不支持调用。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md index 176c5601ce25fa5acb334a7cd7486bc0f534a0e8..212a2428e5e77a8de8344be9d0242e2357d69e30 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md @@ -25,6 +25,11 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; 启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -91,6 +96,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& 启动Ability（callback形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -161,6 +171,11 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; 启动Ability（promise形式）。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -234,7 +249,12 @@ startAbility(want: Want, options?: StartOptions): Promise<void>; startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void; -启动Ability并在该Ability退出的时候返回执行结果（callback形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -301,7 +321,12 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void; -启动Ability并在该Ability退出的时候返回执行结果（callback形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -373,7 +398,12 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>; -启动Ability并在该Ability退出的时候返回执行结果（promise形式）。 +启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（promise形式）。 + +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1251,7 +1281,7 @@ terminateSelf(): Promise<void>; terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void; -停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（callback形式）。 +停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1310,7 +1340,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi terminateSelfWithResult(parameter: AbilityResult): Promise<void>; -停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（promise形式）。 +停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -1607,6 +1637,11 @@ startAbilityByCall(want: Want): Promise<Caller>; 启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。 +使用规则： + - 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限 + - 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限 + - 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md) + **系统能力**：SystemCapability.Ability.AbilityRuntime.Core **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md index 4f8c88b6cef94a4cc0fbd79c90c7ccf098ae9ba7..7d51a7aa49dc04ff3f5ee2f40eff4af9f90cb51c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md @@ -1,6 +1,6 @@ # TriggerInfo -作为[trigger](js-apis-app-ability-wantAgent.md#wantagenttrigger)的入参定义触发WantAgent所需要的的信息。 +作为[trigger](js-apis-app-ability-wantAgent.md#wantagenttrigger)的入参定义触发WantAgent所需要的信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md index 7228bf96d4552040fc72de80826c082076802b14..ecfcd0cab044593a8af2bef35fb77bc404a65cea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md @@ -7,7 +7,7 @@ | 名称 | 类型 | 必填 | 说明 | | -------------- | ------------------------------- | ---- | ---------------------- | | wants | Array\ | 是 | 将被执行的动作列表。 | -| operationType | wantAgent.OperationType | 是 | 动作类型。 | +| operationType | [wantAgent.OperationType](js-apis-app-ability-wantAgent.md#operationtype) | 是 | 动作类型。 | | requestCode | number | 是 | 使用者定义的一个私有值。 | -| wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-wantAgent.md#WantAgentFlags)> | 否 | 动作执行属性。 | -| extraInfo | {[key: string]: any} | 否 | 额外数据。 | +| wantAgentFlags | Array<[wantAgent.WantAgentFlags](js-apis-app-ability-wantAgent.md#wantagentflags)> | 否 | 动作执行属性。 | +| extraInfo | {[key: string]: any} | 否 | 额外数据。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md index f41b78e15b0fa85f0e983acab1990c31f05f0a75..77b82a63795aa688fa946c9130f71615978e9795 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-configuration.md @@ -49,5 +49,4 @@ static getLocale(): LocaleResponse | ---- | ------ | ---- | ---- | ---------------------------------------- | | language | string | 是 | 否 | 语言。例如：zh。 | | countryOrRegion | string | 是 | 否 | 国家或地区。例如：CN。 | -| dir | string | 是 | 否 | 文字布局方向。取值范围：
- ltr：从左到右；
- rtl：从右到左。 | -| unicodeSetting5+ | string | 是 | 否 | 语言环境定义的Unicode语言环境键集，如果此语言环境没有特定键集，则返回空集。
例如：{"nu":"arab"}，表示当前环境下的数字采用阿拉伯语的数字。 | \ No newline at end of file +| dir | string | 是 | 否 | 文字布局方向。取值范围：
- ltr：从左到右；
- rtl：从右到左。 | \ No newline at end of file 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 c3bb4e06631f7d6874be1ccf34dad5570d78470e..deeeb5de5371e20b42983ee7f9d2ae1d26cbbffe 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md @@ -1,14 +1,14 @@ # @ohos.wantAgent (WantAgent模块) -WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle参数名的能力，包括创建WantAgent实例、获取实例的用户ID、获取want信息等。 +WantAgent模块提供了创建WantAgent实例、获取实例的用户ID、获取want信息、比较WantAgent实例和获取bundle名称等能力。 > **说明：** > -> 本模块首批接口从API version 7开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.wantAgent](js-apis-app-ability-wantAgent.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 7开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.wantAgent](js-apis-app-ability-wantAgent.md)。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -```js +```ts import WantAgent from '@ohos.wantAgent'; ``` @@ -24,37 +24,41 @@ getWantAgent(info: WantAgentInfo, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------- | ---- | ----------------------- | -| info | WantAgentInfo | 是 | WantAgent信息。 | +| info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 | | callback | AsyncCallback\ | 是 | 创建WantAgent的回调方法。 | **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //getWantAgent回调 function getWantAgentCallback(err, data) { - console.info("==========================>getWantAgentCallback=======================>"); + if (err.code) { + console.info('getWantAgent Callback err:' + JSON.stringify(err)) + } else { + console.info('getWantAgent Callback success') + } } //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -64,11 +68,9 @@ var wantAgentInfo = { wantAgentFlags:[WantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] } -WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) +WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback); ``` - - ## WantAgent.getWantAgent getWantAgent(info: WantAgentInfo): Promise\ @@ -81,7 +83,7 @@ getWantAgent(info: WantAgentInfo): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ---- | ------------- | ---- | ------------- | -| info | WantAgentInfo | 是 | WantAgent信息。 | +| info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 | **返回值：** @@ -91,29 +93,29 @@ getWantAgent(info: WantAgentInfo): Promise\ **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -124,17 +126,15 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); }); ``` - - ## WantAgent.getBundleName getBundleName(agent: WantAgent, callback: AsyncCallback\): void -获取WantAgent实例的包名（callback形式）。 +获取WantAgent实例的Bundle名称（callback形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -147,41 +147,48 @@ getBundleName(agent: WantAgent, callback: AsyncCallback\): void **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //getWantAgent回调 function getWantAgentCallback(err, data) { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); if (err.code == 0) { wantAgent = data; } else { - console.info('----getWantAgent failed!----'); + console.error('getWantAgent failed, error: ' + JSON.stringify(err)); + return; + } + + //getBundleName回调 + function getBundleNameCallback(err, data) { + console.info('==========================>getBundleNameCallback=======================>'); } + WantAgent.getBundleName(wantAgent, getBundleNameCallback); } //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -192,12 +199,6 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) - -//getBundleName回调 -function getBundleNameCallback(err, data) { - console.info("==========================>getBundleNameCallback=======================>"); -} -WantAgent.getBundleName(wantAgent, getBundleNameCallback) ``` @@ -206,7 +207,7 @@ WantAgent.getBundleName(wantAgent, getBundleNameCallback) getBundleName(agent: WantAgent): Promise\ -获取WantAgent实例的包名（Promise形式）。 +获取WantAgent实例的Bundle名称（Promise形式）。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -218,38 +219,37 @@ getBundleName(agent: WantAgent): Promise\ **返回值：** -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取WantAgent实例的包名。 | +| 类型 | 说明 | +| ----------------- | ------------------------------------------------ | +| Promise\ | 以Promise形式返回获取WantAgent实例的Bundle名称。 | **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; - //wantAgent对象 -var wantAgent; +let wantAgent; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -260,12 +260,13 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); wantAgent = data; -}); - -WantAgent.getBundleName(wantAgent).then((data) => { - console.info("==========================>getBundleNameCallback=======================>"); + if (wantAgent) { + WantAgent.getBundleName(wantAgent).then((data) => { + console.info('==========================>getBundleNameCallback=======================>'); + }); + } }); ``` @@ -288,41 +289,48 @@ getUid(agent: WantAgent, callback: AsyncCallback\): void **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //getWantAgent回调 function getWantAgentCallback(err, data) { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); if (err.code == 0) { wantAgent = data; } else { - console.info('----getWantAgent failed!----'); + console.error('getWantAgent failed, error: ' + JSON.stringify(err)); + return; + } + + //getUid回调 + function getUidCallback(err, data) { + console.info('==========================>getUidCallback=======================>'); } + WantAgent.getUid(wantAgent, getUidCallback); } //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -333,12 +341,6 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) - -//getUid回调 -function getUidCallback(err, data) { - console.info("==========================>getUidCallback=======================>"); -} -WantAgent.getUid(wantAgent, getUidCallback) ``` @@ -365,32 +367,32 @@ getUid(agent: WantAgent): Promise\ **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -401,162 +403,17 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); wantAgent = data; -}); - -WantAgent.getUid(wantAgent).then((data) => { - console.info("==========================>getUidCallback=======================>"); -}); -``` - - - -## WantAgent.getWant - -getWant(agent: WantAgent, callback: AsyncCallback\): void - -获取WantAgent对象的want（callback形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | ------------------------------- | -| agent | WantAgent | 是 | WantAgent对象。 | -| callback | AsyncCallback\ | 是 | 获取WantAgent对象want的回调方法。 | - -**示例：** - -```js -import WantAgent from '@ohos.wantAgent'; - - -//wantAgent对象 -var wantAgent; - -//getWantAgent回调 -function getWantAgentCallback(err, data) { - console.info("==========================>getWantAgentCallback=======================>"); - if (err.code == 0) { - wantAgent = data; - } else { - console.info('----getWantAgent failed!----'); + if (wantAgent) { + WantAgent.getUid(wantAgent).then((data) => { + console.info('==========================>getUidCallback=======================>'); + }); } -} -//WantAgentInfo对象 -var wantAgentInfo = { - wants: [ - { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - 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) - -//getWant回调 -function getWantCallback(err, data) { - console.info("==========================>getWantCallback=======================>"); -} -WantAgent.getWant(wantAgent, getWantCallback) -``` - - - -## WantAgent.getWant - -getWant(agent: WantAgent): Promise\ - -获取WantAgent对象的want（Promise形式）。 - -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core - -**系统API**: 此接口为系统接口，三方应用不支持调用。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | --------- | ---- | ------------- | -| agent | WantAgent | 是 | WantAgent对象。 | - -**返回值：** - -| 类型 | 说明 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | -| Promise\ | 以Promise形式返回获取WantAgent对象的want。 | - -**示例：** - -```js -import WantAgent from '@ohos.wantAgent'; - - -//wantAgent对象 -var wantAgent; - -//WantAgentInfo对象 -var wantAgentInfo = { - wants: [ - { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - 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.getWant(wantAgent).then((data) => { - console.info("==========================>getWantCallback=======================>"); }); ``` - ## WantAgent.cancel cancel(agent: WantAgent, callback: AsyncCallback\): void @@ -574,41 +431,48 @@ cancel(agent: WantAgent, callback: AsyncCallback\): void **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //getWantAgent回调 function getWantAgentCallback(err, data) { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); if (err.code == 0) { wantAgent = data; } else { - console.info('----getWantAgent failed!----'); + console.error('getWantAgent failed, error: ' + JSON.stringify(err)); + return; } + + //cancel回调 + function cancelCallback(err, data) { + console.info('==========================>cancelCallback=======================>'); + } + WantAgent.cancel(wantAgent, cancelCallback); } //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -619,12 +483,6 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) - -//cancel回调 -function cancelCallback(err, data) { - console.info("==========================>cancelCallback=======================>"); -} -WantAgent.cancel(wantAgent, cancelCallback) ``` @@ -651,32 +509,32 @@ cancel(agent: WantAgent): Promise\ **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -687,12 +545,13 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); wantAgent = data; -}); - -WantAgent.cancel(wantAgent).then((data) => { - console.info("==========================>cancelCallback=======================>"); + if (wantAgent) { + WantAgent.cancel(wantAgent).then((data) => { + console.info('==========================>cancelCallback=======================>'); + }); + } }); ``` @@ -711,46 +570,57 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback\ | 否 | 主动激发WantAgent实例的回调方法。 | **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //getWantAgent回调 function getWantAgentCallback(err, data) { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); if (err.code == 0) { wantAgent = data; } else { - console.info('----getWantAgent failed!----'); + console.error('getWantAgent failed, error: ' + JSON.stringify(err)); + return; } + + //trigger回调 + function triggerCallback(data) { + console.info('==========================>triggerCallback=======================>'); + } + + var triggerInfo = { + code:0 + } + WantAgent.trigger(wantAgent, triggerInfo, triggerCallback) } //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -761,16 +631,6 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) - -//trigger回调 -function triggerCallback(data) { - console.info("==========================>triggerCallback=======================>"); -} - -var triggerInfo = { - code:0 -} -WantAgent.trigger(wantAgent, triggerInfo, triggerCallback) ``` @@ -779,7 +639,7 @@ WantAgent.trigger(wantAgent, triggerInfo, triggerCallback) equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\): void -判断两个WantAgent实例是否相等（callback形式）。 +判断两个WantAgent实例是否相等（callback形式）,以此来判断是否是来自同一应用的相同操作。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -793,43 +653,50 @@ equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback\getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); if (err.code == 0) { wantAgent1 = data; wantAgent2 = data; } else { - console.info('----getWantAgent failed!----'); + console.error('getWantAgent failed, error: ' + JSON.stringify(err)); + return; } + + //equal回调 + function equalCallback(err, data) { + console.info('==========================>equalCallback=======================>'); + } + WantAgent.equal(wantAgent1, wantAgent2, equalCallback) } //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -840,12 +707,6 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) - -//equal回调 -function equalCallback(err, data) { - console.info("==========================>equalCallback=======================>"); -} -WantAgent.equal(wantAgent1, wantAgent2, equalCallback) ``` @@ -854,7 +715,7 @@ WantAgent.equal(wantAgent1, wantAgent2, equalCallback) equal(agent: WantAgent, otherAgent: WantAgent): Promise\ -判断两个WantAgent实例是否相等（Promise形式）。 +判断两个WantAgent实例是否相等（Promise形式）,以此来判断是否是来自同一应用的相同操作。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -873,33 +734,33 @@ equal(agent: WantAgent, otherAgent: WantAgent): Promise\ **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent1; -var wantAgent2; +let wantAgent1; +let wantAgent2; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -910,13 +771,18 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); wantAgent1 = data; wantAgent2 = data; + if (data) { + WantAgent.equal(wantAgent1, wantAgent2).then((data) => { + console.info('==========================>equalCallback=======================>'); + }); + } }); WantAgent.equal(wantAgent1, wantAgent2).then((data) => { - console.info("==========================>equalCallback=======================>"); + console.info('==========================>equalCallback=======================>'); }); ``` @@ -937,31 +803,31 @@ getOperationType(agent: WantAgent, callback: AsyncCallback\): void; **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -972,13 +838,14 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); wantAgent = data; + if (data) { + WantAgent.getOperationType(wantAgent, (OperationType) => { + console.log('----------- getOperationType ----------, OperationType: ' + OperationType); + }) + } }); - -WantAgent.getOperationType(wantAgent, (OperationType) => { - console.log('----------- getOperationType ----------, OperationType: ' + OperationType); -}) ``` ## WantAgent.getOperationType9+ @@ -1003,31 +870,31 @@ getOperationType(agent: WantAgent): Promise\; **示例：** -```js +```ts import WantAgent from '@ohos.wantAgent'; //wantAgent对象 -var wantAgent; +let wantAgent; //WantAgentInfo对象 -var wantAgentInfo = { +let wantAgentInfo = { wants: [ { - deviceId: "deviceId", - bundleName: "com.neu.setResultOnAbilityResultTest1", - abilityName: "com.example.test.MainAbility", - action: "action1", - entities: ["entity1"], - type: "MIMETYPE", - uri: "key={true,true,false}", + 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", + mykey2: '[1, 2, 3]', + mykey3: 'ssssssssssssssssssssssssss', mykey4: [false, true, false], - mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'], mykey6: true, } } @@ -1038,18 +905,16 @@ var wantAgentInfo = { } WantAgent.getWantAgent(wantAgentInfo).then((data) => { - console.info("==========================>getWantAgentCallback=======================>"); + console.info('==========================>getWantAgentCallback=======================>'); wantAgent = data; + WantAgent.getOperationType(wantAgent).then((OperationType) => { + console.log('getOperationType success, OperationType: ' + OperationType); + }).catch((err) => { + console.log('getOperationType fail, err: ' + err); + }) }); - -WantAgent.getOperationType(wantAgent).then((OperationType) => { - console.log('getOperationType success, OperationType: ' + OperationType); -}).catch((err) => { - console.log('getOperationType fail, err: ' + err); -}) ``` - ## WantAgentFlags **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core @@ -1088,5 +953,5 @@ WantAgent.getOperationType(wantAgent).then((OperationType) => { | info | WantAgent | 是 | 触发的wantAgent。 | | want | Want | 是 | 存在的被触发的want。 | | finalCode | number | 是 | 触发wantAgent的请求代码。| -| finalData | string | 否 | 公共事件收集的最终数据。 | -| extraInfo | {[key: string]: any} | 否 | 额外数据。 | +| finalData | string | 是 | 公共事件收集的最终数据。 | +| extraInfo | {[key: string]: any} | 否 | 额外数据。 | \ No newline at end of file diff --git a/zh-cn/application-dev/tools/aa-tool.md b/zh-cn/application-dev/tools/aa-tool.md index fef305b1cdfde1530a69630e8967c73dc7064fd4..3a5665c2767600fbb10d83fe4bc97ce5ba5fe5d5 100644 --- a/zh-cn/application-dev/tools/aa-tool.md +++ b/zh-cn/application-dev/tools/aa-tool.md @@ -68,7 +68,7 @@ Ability assistant（Ability助手，简称为aa），是实现应用及测试用 | -------- | -------- | -------- | | -h/--help | - | 帮助信息。 | | -a/--all | - | 打印所有mission内的应用组件信息。 | - | -l/--mission-list | type（缺省打印全部） | 打印任务栈信息。
可取值：
- NORMAL
- DEFAULT_STANDARD
- DEFAULT_SINGLE
- LAUNCHER | + | -l/--mission-list | type（缺省打印全部） | 服务侧为了方便管理任务链，内部维护了4种类型的任务链。
可取值：
- NORMAL: 正常启动的任务链(比如A拉起B拉起C, 则对应的任务链是A->B->C)
- DEFAULT_STANDARD: 已经被破坏的任务链中的任务, 启动模式为standard的任务被放到该任务链中, 这里面的任务之间没有关联关系
- DEFAULT_SINGLE: 已经被破坏的任务链中的任务, 启动模式为singleton的任务被放到该任务链中, 这里面的任务之间没有关联关系
- LAUNCHER: launcher的任务链 | | -e/--extension | elementName | 打印扩展组件信息。 | | -u/--userId | UserId | 打印指定UserId的栈信息，需要和其他参数组合使用，例如aa dump -a -u 100、aa dump -d -u 100。 | | -d/--data | - | 打印DataAbility相关信息。 |