Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
436330dd
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
436330dd
编写于
12月 26, 2022
作者:
O
openharmony_ci
提交者:
Gitee
12月 26, 2022
浏览文件
操作
浏览文件
下载
差异文件
!12890 资料文档描述优化
Merge pull request !12890 from mingxihua/master
上级
1fe6ca70
71871991
变更
19
展开全部
显示空白变更内容
内联
并排
Showing
19 changed file
with
241 addition
and
237 deletion
+241
-237
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
...application-dev/reference/apis/js-apis-ability-context.md
+11
-10
zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md
...cation-dev/reference/apis/js-apis-ability-dataUriUtils.md
+19
-19
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
...plication-dev/reference/apis/js-apis-ability-errorCode.md
+4
-6
zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md
...tion-dev/reference/apis/js-apis-ability-featureAbility.md
+67
-59
zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md
...ion-dev/reference/apis/js-apis-ability-particleAbility.md
+22
-32
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
...dev/reference/apis/js-apis-app-ability-abilityConstant.md
+6
-2
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
...-dev/reference/apis/js-apis-app-ability-abilityManager.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
...tion-dev/reference/apis/js-apis-app-ability-appManager.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
...n-dev/reference/apis/js-apis-app-ability-configuration.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
...on-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
+20
-20
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
...-dev/reference/apis/js-apis-app-ability-missionManager.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
...ation-dev/reference/apis/js-apis-app-ability-uiAbility.md
+47
-46
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
...ation-dev/reference/apis/js-apis-app-ability-wantAgent.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
...ication-dev/reference/apis/js-apis-application-ability.md
+5
-4
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
...dev/reference/apis/js-apis-application-abilityConstant.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md
...-dev/reference/apis/js-apis-application-abilityManager.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
...apis/js-apis-application-accessibilityExtensionAbility.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
...tion-dev/reference/apis/js-apis-application-appManager.md
+7
-7
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
...erence/apis/js-apis-inner-application-uiAbilityContext.md
+6
-5
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @
436330dd
...
...
@@ -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
...
...
@@ -198,7 +198,7 @@ startAbility(want: Want, options?: StartOptions): Promise<void>;
startAbilityForResult(want: Want, callback: AsyncCallback
<
AbilityResult
>
): void;
启动
Ability并在该Ability退出的时候返回执行结果
(callback形式)。
启动
一个Ability。Ability被启动后,正常情况下可通过调用
[
terminateSelfWithResult
](
#abilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者
(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -248,7 +248,7 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>):
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
<
AbilityResult
>
): void;
启动
Ability并在该Ability退出的时候返回执行结果
(callback形式)。
启动
一个Ability。Ability被启动后,正常情况下可通过调用
[
terminateSelfWithResult
](
#abilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者
(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -303,7 +303,7 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
startAbilityForResult(want: Want, options?: StartOptions): Promise
<
AbilityResult
>
;
启动
Ability并在该Ability退出的时候返回执行结果
(promise形式)。
启动
一个Ability。Ability被启动后,正常情况下可通过调用
[
terminateSelfWithResult
](
#abilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者
(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -375,7 +375,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
\<
AbilityResult
\>
| 是 | 启动Ability的回调函数,返回Ability结果。 |
| callback | AsyncCallback
\<
[
AbilityResult
](
js-apis-inner-ability-abilityResult.md
)
\>
| 是 | 启动Ability的回调函数,返回Ability结果。 |
**错误码:**
...
...
@@ -499,7 +499,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
AbilityResult
>
| 返回一个Promise,包含Ability结果。 |
| Promise
<
[AbilityResult](js-apis-inner-ability-abilityResult.md)
>
| 返回一个Promise,包含Ability结果。 |
**错误码:**
...
...
@@ -1034,7 +1034,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 +1090,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
...
...
@@ -1685,7 +1686,7 @@ setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon |
image.PixelMap
| 是 | 在最近的任务中显示的ability图标。 |
| icon |
[
image.PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | 在最近的任务中显示的ability图标。 |
| callback | AsyncCallback
\<
void> | 是 | 指定的回调函数的结果。 |
**示例:**
...
...
@@ -1727,7 +1728,7 @@ setMissionIcon(icon: image.PixelMap): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon |
image.PixelMap
| 是 | 在最近的任务中显示的ability图标。 |
| icon |
[
image.PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | 在最近的任务中显示的ability图标。 |
**返回值:**
...
...
zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md
浏览文件 @
436330dd
# @ohos.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理
使用DataAbilityHelper方案的对象的实用程序类的能力,包括获取,添加,更新给定uri的路径组件末尾的ID。本模块将被app.ability.dataUriUtils模块
,建议优先使用
[
@ohos.app.ability.dataUriUtils
](
js-apis-app-ability-dataUriUtils.md
)
模块。
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,13 +24,13 @@ getId(uri: string): number
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 |
指示要从中获取ID的
uri对象。 |
| uri | string | 是 |
表示
uri对象。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------------ |
| number |
附加到路径组件
末尾的ID。 |
| number |
返回uri路径
末尾的ID。 |
**示例:**
...
...
@@ -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
id
int
=
1122
;
var
id
=
1122
;
dataUriUtils
.
attachId
(
"
com.example.dataUriUtils
"
,
id
int
,
id
,
)
```
...
...
@@ -77,7 +77,7 @@ dataUriUtils.attachId(
deleteId(uri: string): string
从给定uri的路径组件的末尾删除
ID。
删除指定uri路径末尾的
ID。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -85,13 +85,13 @@ deleteId(uri: string): string
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 |
指
示要从中删除ID的uri对象。 |
| uri | string | 是 |
表
示要从中删除ID的uri对象。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------- |
| string |
ID已删除
的uri对象。 |
| string |
返回删除ID之后
的uri对象。 |
**示例:**
...
...
@@ -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
id
int
=
1122
;
var
id
=
1122
;
dataUriUtils
.
updateId
(
"
com.example.dataUriUtils
"
,
id
int
"
com.example.dataUriUtils
/1221
"
,
id
)
```
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
浏览文件 @
436330dd
# @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
zh-cn/application-dev/reference/apis/js-apis-ability-featureAbility.md
浏览文件 @
436330dd
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md
浏览文件 @
436330dd
# @ohos.ability.particleAbility (ParticleAbility模块)
particleAbility模块提供了
Service类型Ability的能力,包括启动、停止指定的particleAbility,获取dataAbilityHelper,连接、断开当前Ability与指定
ServiceAbility等。
particleAbility模块提供了
操作Service类型的Ability的能力,包括启动、停止指定的particleAbility,获取dataAbilityHelper,连接、断连指定的
ServiceAbility等。
> **说明:**
>
...
...
@@ -21,7 +21,7 @@ import particleAbility from '@ohos.ability.particleAbility'
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback
\<
void>): void
使用此方法
启动指定的particleAbility(callback形式)。
启动指定的particleAbility(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -29,8 +29,8 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>):
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter |
[
StartAbilityParameter
](
js-apis-inner-ability-startAbilityParameter.md
)
| 是 |
指
示启动的ability |
| callback | AsyncCallback
\<
void> | 是 |
被指定的回调方法
|
| parameter |
[
StartAbilityParameter
](
js-apis-inner-ability-startAbilityParameter.md
)
| 是 |
表
示启动的ability |
| callback | AsyncCallback
\<
void> | 是 |
以callback的形式返回启动Ability的结果
|
**示例:**
...
...
@@ -62,7 +62,7 @@ particleAbility.startAbility(
startAbility(parameter: StartAbilityParameter): Promise
\<
void>;
使用此方法
启动指定的particleAbility(Promise形式)。
启动指定的particleAbility(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -70,13 +70,13 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter |
[
StartAbilityParameter
](
js-apis-inner-ability-startAbilityParameter.md
)
| 是 |
指
示启动的ability |
| parameter |
[
StartAbilityParameter
](
js-apis-inner-ability-startAbilityParameter.md
)
| 是 |
表
示启动的ability |
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> |
使用Promise形式返回
结果。 |
| Promise
\<
void> |
Promise形式返回启动Ability的
结果。 |
**示例:**
...
...
@@ -107,7 +107,7 @@ particleAbility.startAbility(
terminateSelf(callback: AsyncCallback
\<
void>): void
终止
particleAbility(callback形式)。
销毁当前
particleAbility(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -115,7 +115,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback
\<
void> | 是 |
表示被指定的回调方法
|
| callback | AsyncCallback
\<
void> | 是 |
以callback的形式返回停止当前Ability结果
|
**示例:**
...
...
@@ -133,7 +133,7 @@ particleAbility.terminateSelf(
terminateSelf(): Promise
\<
void>
终止
particleAbility(Promise形式)。
销毁当前
particleAbility(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -141,7 +141,7 @@ terminateSelf(): Promise\<void>
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> | 使用Promise形式返回结果。 |
| Promise
\<
void> | 使用Promise形式返回
停止当前Ability
结果。 |
**示例:**
...
...
@@ -159,7 +159,7 @@ particleAbility.terminateSelf().then((data) => {
acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。
获取dataAbilityHelper
对象
。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -167,13 +167,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
| 参数名 | 类型 | 必填 | 说明 |
| :--- | ------ | ---- | ------------------------ |
| uri | string | 是 |
指
示要打开的文件的路径。 |
| uri | string | 是 |
表
示要打开的文件的路径。 |
**返回值:**
| 类型 | 说明 |
| ----------------- | -------------------------------------------- |
|
DataAbilityHelper
| 用来协助其他Ability访问DataAbility的工具类。 |
|
[
DataAbilityHelper
](
js-apis-inner-ability-dataAbilityHelper.md
)
| 用来协助其他Ability访问DataAbility的工具类。 |
**示例:**
...
...
@@ -270,7 +270,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise<voi
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> | 使用Promise形式返回结果。 |
| Promise
\<
void> | 使用Promise形式返回
启动长时任务的
结果。 |
**示例**
:
...
...
@@ -326,7 +326,7 @@ cancelBackgroundRunning(callback: AsyncCallback<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回
启动
长时任务的结果 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回
取消
长时任务的结果 |
**示例**
:
...
...
@@ -357,7 +357,7 @@ cancelBackgroundRunning(): Promise<void>;
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> | 使用Promise形式返回结果。 |
| Promise
\<
void> | 使用Promise形式返回
取消长时任务的
结果。 |
**示例**
:
...
...
@@ -376,7 +376,7 @@ particleAbility.cancelBackgroundRunning().then(() => {
connectAbility(request: Want, options:ConnectOptions): number
将当前ability
连接到指定ServiceAbility
(callback形式)。
将当前ability
与指定的ServiceAbility进行连接
(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -385,18 +385,8 @@ connectAbility(request: Want, options:ConnectOptions): number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ---------------------------- |
| request |
[
Want
](
js-apis-application-want.md
)
| 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
**ConnectOptions类型说明:**
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| options |
[
ConnectOptions
](
js-apis-inner-ability-connectOptions.md
)
| 是 | 连接回调方法。 |
| 名称 | 类型 | 必填 | 说明 |
| ------------ | -------- | ---- | ------------------------- |
| onConnect | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | function | 是 | 连接失败时的回调函数。 |
| onFailed | function | 是 | ConnectAbility调用失败时的回调函数。 |
**示例**
:
...
...
@@ -439,7 +429,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
disconnectAbility(connection: number, callback:AsyncCallback
\<
void>): void;
将功能与服务功能断开连接
。
断开当前ability与指定ServiceAbility的连接(callback形式)
。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -489,7 +479,7 @@ var result = particleAbility.disconnectAbility(connId).then((data) => {
disconnectAbility(connection: number): Promise
\<
void>;
将功能与服务功能断开连接
。
断开当前ability与指定ServiceAbility的连接(Promise形式)
。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
@@ -538,7 +528,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
## ErrorCode
获取错误代
码。
表示错误
码。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @
436330dd
...
...
@@ -15,12 +15,16 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
## 属性
## AbilityConstant.LaunchParam
启动参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason |
LaunchReason
| 是 | 是 | 指示启动原因。 |
| lastExitReason |
LastExitReason
| 是 | 是 | 表示最后退出原因。 |
| launchReason |
[
LaunchReason
](
#abilityconstantlaunchreason
)
| 是 | 是 | 指示启动原因。 |
| lastExitReason |
[
LastExitReason
](
#abilityconstantlastexitreason
)
| 是 | 是 | 表示最后退出原因。 |
## AbilityConstant.LaunchReason
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @
436330dd
...
...
@@ -118,7 +118,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback
\<
Array
\<
AbilityRunningInfo
>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback
\<
Array
\<
[
AbilityRunningInfo
](
js-apis-inner-application-abilityRunningInfo.md
)
>> | 是 | 被指定的回调方法。 |
**示例**
:
...
...
@@ -147,7 +147,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise
\<
Array
\<
AbilityRunningInfo
>> | 返回执行结果。 |
| Promise
\<
Array
\<
[
AbilityRunningInfo
](
js-apis-inner-application-abilityRunningInfo.md
)
>> | 返回执行结果。 |
**示例**
:
...
...
@@ -179,7 +179,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback
\<
Array
\<
AbilityRunningInfo
>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback
\<
Array
\<
[
ExtensionRunningInfo
](
js-apis-inner-application-extensionRunningInfo.md
)
>> | 是 | 被指定的回调方法。 |
**示例**
:
...
...
@@ -216,7 +216,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise
\<
Array
\<
AbilityRunningInfo
>> | 返回执行结果。 |
| Promise
\<
Array
\<
[
ExtensionRunningInfo
](
js-apis-inner-application-extensionRunningInfo.md
)
>> | 返回执行结果。 |
**示例**
:
...
...
@@ -247,7 +247,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback
\<
ElementName
> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback
\<
[
ElementName
](
js-apis-bundleManager-elementName.md
)
> | 是 | 被指定的回调方法。 |
**示例**
:
...
...
@@ -269,7 +269,7 @@ getTopAbility(): Promise\<ElementName>;
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise
\<
ElementName
>| 返回执行结果。 |
| Promise
\<
[
ElementName
](
js-apis-bundleManager-elementName.md
)
>| 返回执行结果。 |
**示例**
:
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
浏览文件 @
436330dd
...
...
@@ -391,7 +391,7 @@ off(type: "applicationState", observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback
\<
Array
\<
AppStateData>>): void;
获取
前台进程的应用程序
。
获取
所有当前处于前台的应用信息。该应用信息由
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
定义
。
**需要权限**
:ohos.permission.GET_RUNNING_INFO
...
...
@@ -403,7 +403,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
\<
Array
\<
AppStateData>> | 是 | 表示应用的状态数据
。 |
| callback | AsyncCallback
\<
Array
\<
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
>> | 是 | callback形式返回所有当前处于前台的应用信息
。 |
**示例:**
...
...
@@ -465,7 +465,7 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback
\<
Array
\<
AppStateData>>): void;
获取
前台进程的应用程序
。
获取
所有当前处于前台的应用信息。该应用信息由
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
定义
。
**需要权限**
:ohos.permission.GET_RUNNING_INFO
...
...
@@ -477,7 +477,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
\<
Array
\<
AppStateData>> | 是 | 表示应用的状态数据
。 |
| callback | AsyncCallback
\<
Array
\<
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
>> | 是 | callback形式返回所有当前处于前台的应用信息
。 |
**示例:**
...
...
@@ -500,7 +500,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
getForegroundApplications(): Promise
\<
Array
\<
AppStateData>>;
获取
前台进程的应用程序
。
获取
所有当前处于前台的应用信息。该应用信息由
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
定义
。
**需要权限**
:ohos.permission.GET_RUNNING_INFO
...
...
@@ -512,7 +512,7 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise
\<
Array
\<
ProcessRunningInfo>> | 返回进程运行信息的数组
。 |
| Promise
\<
Array
\<
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
>> | Promise形式返回所有当前处于前台的应用信息
。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
浏览文件 @
436330dd
...
...
@@ -18,8 +18,8 @@ import Configuration from '@ohos.app.ability.Configuration'
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode |
[
ColorMode
](
js-apis-app-ability-configurationConstant.md#configurationconstantcolormode
)
| 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。 |
| direction |
Direction
| 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 |
| screenDensity |
ScreenDensity
| 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 |
| 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)。 |
| displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice | boolean | 是 | 否 | 指示指针类型设备是否已连接,如键鼠、触控板等。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
浏览文件 @
436330dd
# ohos.app.ability.dataUriUtils (DataUriUtils模块)
#
@
ohos.app.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理
使用DataAbilityHelper方案的对象的实用程序类的能力,包括获取,添加,更新给定uri
的路径末尾的ID。
DataUriUtils模块提供用于处理
uri对象的能力,包括获取、绑定、删除和更新指定uri对象
的路径末尾的ID。
> **说明:**
>
...
...
@@ -16,7 +16,7 @@ import dataUriUtils from '@ohos.app.ability.dataUriUtils';
getId(uri: string): number
获取
附加到给定uri的
路径末尾的ID。
获取
指定uri
路径末尾的ID。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -24,13 +24,13 @@ getId(uri: string): number
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 |
指示要从中获取ID的
uri对象。 |
| uri | string | 是 |
表示
uri对象。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------------ |
| number |
附加到
uri路径末尾的ID。 |
| number |
返回
uri路径末尾的ID。 |
**示例:**
...
...
@@ -49,7 +49,7 @@ try {
attachId(uri: string, id: number): string
将
给定ID附加到给定uri的路径末尾。可用于生成新的uri
。
将
ID附加到uri的路径末尾
。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -57,23 +57,23 @@ 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
id
int
=
1122
;
var
id
=
1122
;
try
{
var
uri
=
dataUriUtils
.
attachId
(
"
com.example.dataUriUtils
"
,
id
int
,
id
,
)
console
.
info
(
'
attachId the uri is:
'
+
uri
)
}
catch
(
err
)
{
...
...
@@ -88,7 +88,7 @@ try {
deleteId(uri: string): string
从给定uri的路径的末尾删除
ID。
删除指定uri路径末尾的
ID。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -96,13 +96,13 @@ deleteId(uri: string): string
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 |
指
示要从中删除ID的uri对象。 |
| uri | string | 是 |
表
示要从中删除ID的uri对象。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------- |
| string |
ID已删除
的uri对象。 |
| string |
返回删除ID之后
的uri对象。 |
**示例:**
...
...
@@ -130,24 +130,24 @@ updateId(uri: string, id: number): string
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 |
指示要更新的uri对象。
|
| id | number | 是 |
指示新ID。
|
| uri | string | 是 |
表示uri对象
|
| id | number | 是 |
表示要更新的ID
|
**返回值:**
| 类型 | 说明 |
| ------ | --------------- |
| string |
更新
的uri对象。 |
| string |
返回更新ID之后
的uri对象。 |
**示例:**
```
ts
try
{
var
id
int
=
1122
;
var
id
=
1122
;
var
uri
=
dataUriUtils
.
updateId
(
"
com.example.dataUriUtils
"
,
id
int
"
com.example.dataUriUtils
/1221
"
,
id
)
}
catch
(
err
)
{
console
.
error
(
'
delete uri err, check the input uri
'
+
err
)
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
浏览文件 @
436330dd
...
...
@@ -32,7 +32,7 @@ on(type:"mission", listener: MissionListener): number;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listener |
MissionListener
| 是 | 系统任务监听器。 |
| listener |
[
MissionListener
](
js-apis-inner-application-missionListener.md
)
| 是 | 系统任务监听器。 |
**返回值:**
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @
436330dd
...
...
@@ -18,7 +18,7 @@ import UIAbility from '@ohos.app.ability.UIAbility';
## 属性
**系统能力**
:以下各项对应的系统能力均为SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:以下各项对应的系统能力均为SystemCapability.
Ability.AbilityRuntime.
AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
...
...
@@ -29,18 +29,18 @@ import UIAbility from '@ohos.app.ability.UIAbility';
## UIAbility.onCreate
onCreate(want: Want, param:
UI
AbilityConstant.LaunchParam): void;
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
UIAbility创建时回调,执行初始化业务逻辑操作。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前UIAbility的Want类型信息,包括ability名称、bundle名称等。 |
| param |
UIAbilityConstant.LaunchParam
| 是 | 创建
ability、上次异常退出的原因信息。 |
| param |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | 创建
ability、上次异常退出的原因信息。 |
**示例:**
...
...
@@ -59,13 +59,13 @@ onWindowStageCreate(windowStage: window.WindowStage): void
当WindowStage创建后调用。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage |
window.WindowStage
| 是 | WindowStage相关信息。 |
| windowStage |
[
window.WindowStage
](
js-apis-window.md#windowstage9
)
| 是 | WindowStage相关信息。 |
**示例:**
...
...
@@ -84,7 +84,7 @@ onWindowStageDestroy(): void
当WindowStage销毁后调用。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**示例:**
...
...
@@ -103,13 +103,13 @@ onWindowStageRestore(windowStage: window.WindowStage): void
当迁移多实例ability时,恢复WindowStage后调用。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage |
window.WindowStage
| 是 | WindowStage相关信息。 |
| windowStage |
[
window.WindowStage
](
js-apis-window.md#windowstage9
)
| 是 | WindowStage相关信息。 |
**示例:**
...
...
@@ -128,7 +128,7 @@ onDestroy(): void;
UIAbility生命周期回调,在销毁时回调,执行资源清理等操作。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**示例:**
...
...
@@ -147,7 +147,7 @@ onForeground(): void;
UIAbility生命周期回调,当应用从后台转到前台时触发。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**示例:**
...
...
@@ -166,7 +166,7 @@ onBackground(): void;
UIAbility生命周期回调,当应用从前台转到后台时触发。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**示例:**
...
...
@@ -181,11 +181,11 @@ UIAbility生命周期回调,当应用从前台转到后台时触发。
## UIAbility.onContinue
onContinue(wantParam : {[key: string]: any}):
UI
AbilityConstant.OnContinueResult;
onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
当ability迁移准备迁移时触发,保存数据。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
...
...
@@ -197,17 +197,17 @@ onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult
| 类型 | 说明 |
| -------- | -------- |
|
UIAbilityConstant.OnContinueResult
| 继续的结果。 |
|
[
AbilityConstant.OnContinueResult
](
js-apis-app-ability-abilityConstant.md#abilityconstantoncontinueresult
)
| 继续的结果。 |
**示例:**
```
ts
import
UIAbilityConstant
from
"
@ohos.app.ability.UI
AbilityConstant
"
import
AbilityConstant
from
"
@ohos.app.ability.
AbilityConstant
"
class
MyUIAbility
extends
UIAbility
{
onContinue
(
wantParams
)
{
console
.
log
(
'
onContinue
'
);
wantParams
[
"
myData
"
]
=
"
my1234567
"
;
return
UI
AbilityConstant
.
OnContinueResult
.
AGREE
;
return
AbilityConstant
.
OnContinueResult
.
AGREE
;
}
}
```
...
...
@@ -215,25 +215,26 @@ onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult
## UIAbility.onNewWant
onNewWant(want: Want, launchParams:
UI
AbilityConstant.LaunchParam): void;
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
当ability的启动模式设置为单例时回调会被调用
。
启动模式为单例的ability再次被拉起时会回调执行该方法
。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | Want类型参数,如
Ability名称,Bundle名称
等。 |
| launchParams |
UIAbilityConstant.LaunchParam
| 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | Want类型参数,如
ability名称,包名
等。 |
| launchParams |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
**示例:**
```
ts
class
MyUIAbility
extends
UIAbility
{
onNewWant
(
want
)
{
onNewWant
(
want
,
launchParams
)
{
console
.
log
(
'
onNewWant, want:
'
+
want
.
abilityName
);
console
.
log
(
'
onNewWant, launchParams:
'
+
JSON
.
stringify
(
launchParams
));
}
}
```
...
...
@@ -244,7 +245,7 @@ onDump(params: Array\<string>): Array\<string>;
转储客户端信息时调用。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
...
...
@@ -266,35 +267,35 @@ onDump(params: Array\<string>): Array\<string>;
## UIAbility.onSaveState
onSaveState(reason:
UIAbilityConstant.StateType, wantParam : {[key: string]: any}): UI
AbilityConstant.OnSaveResult;
onSaveState(reason:
AbilityConstant.StateType, wantParam : {[key: string]: any}):
AbilityConstant.OnSaveResult;
该API配合
[
appRecovery
](
js-apis-app-ability-appRecovery.md
)
使用。在应用故障时,如果使能了自动保存状态,框架将回调onSaveState保存UIAbility状态。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reason |
[
UI
AbilityConstant.StateType
](
js-apis-app-ability-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因。 |
| reason |
[
AbilityConstant.StateType
](
js-apis-app-ability-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因。 |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
UIAbilityConstant.OnSaveResult
| 是否同意保存当前UIAbility的状态。 |
|
[
AbilityConstant.OnSaveResult
](
js-apis-app-ability-abilityConstant.md#abilityconstantonsaveresult
)
| 是否同意保存当前UIAbility的状态。 |
**示例:**
```
ts
import
UIAbilityConstant
from
'
@ohos.app.ability.UI
AbilityConstant
'
import
AbilityConstant
from
'
@ohos.app.ability.
AbilityConstant
'
class
MyUIAbility
extends
UIAbility
{
onSaveState
(
reason
,
wantParam
)
{
console
.
log
(
'
onSaveState
'
);
wantParam
[
"
myData
"
]
=
"
my1234567
"
;
return
UI
AbilityConstant
.
OnSaveResult
.
RECOVERY_AGREE
;
return
AbilityConstant
.
OnSaveResult
.
RECOVERY_AGREE
;
}
}
```
...
...
@@ -311,14 +312,14 @@ call(method: string, data: rpc.Sequenceable): Promise<void>;
向通用组件服务端发送约定序列化数据。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data |
rpc.Sequenceable
| 是 | 由开发者实现的Sequenceable可序列化数据。 |
| data |
[
rpc.Sequenceable
](
js-apis-rpc.md#sequenceabledeprecated
)
| 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值:**
...
...
@@ -391,20 +392,20 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessagePa
向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| 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形式返回通用组件服务端应答数据。 |
**错误码:**
...
...
@@ -473,7 +474,7 @@ release(): void;
主动释放通用组件服务端的通信接口。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**错误码:**
...
...
@@ -516,13 +517,13 @@ release(): void;
注册通用组件服务端Stub(桩)断开监听通知。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback |
OnReleaseCallBack
| 是 | 返回onRelease回调结果。 |
| callback |
[
OnReleaseCallBack
](
#onreleasecallback
)
| 是 | 返回onRelease回调结果。 |
**示例:**
...
...
@@ -558,14 +559,14 @@ release(): void;
注册通用组件服务端Stub(桩)断开监听通知。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件,固定为'release'。 |
| callback |
OnReleaseCallback
| 是 | 返回onRelease回调结果。 |
| callback |
[
OnReleaseCallBack
](
#onreleasecallback
)
| 是 | 返回onRelease回调结果。 |
**错误码:**
...
...
@@ -613,14 +614,14 @@ on(method: string, callback: CalleeCallback): void;
通用组件服务端注册消息通知callback。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback |
CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数,
回调函数至少要返回一个空的rpc.Sequenceable
数据对象,
其他视为函数执行错误。 |
| callback |
[
CalleeCallback
](
#calleecallback
)
| 是 | 一个
[
rpc.MessageParcel
](
js-apis-rpc.md#messageparceldeprecated
)
类型入参的js通知同步回调函数,
回调函数至少要返回一个空的[rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated)
数据对象,
其他视为函数执行错误。 |
**错误码:**
...
...
@@ -679,7 +680,7 @@ off(method: string): void;
解除通用组件服务端注册消息通知callback。
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**参数:**
...
...
@@ -716,7 +717,7 @@ off(method: string): void;
(msg: string): void;
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
...
...
@@ -726,8 +727,8 @@ off(method: string): void;
(indata: rpc.MessageParcel): rpc.Sequenceable;
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata:
rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable
| 被调用方注册的消息侦听器函数接口的原型。 |
| (indata:
[
rpc.MessageParcel
](
js-apis-rpc.md#messageparceldeprecated
)
) | 是 | 否 |
[
rpc.Sequenceable
](
js-apis-rpc.md#sequenceabledeprecated
)
| 被调用方注册的消息侦听器函数接口的原型。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
浏览文件 @
436330dd
...
...
@@ -117,7 +117,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------------- | ---- | ------------- |
| info |
WantAgentInfo
| 是 | WantAgent信息。 |
| info |
[
WantAgentInfo
](
js-apis-inner-wantAgent-wantAgentInfo.md
)
| 是 | WantAgent信息。 |
**返回值:**
...
...
@@ -632,7 +632,7 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
| callback | AsyncCallback
\<
Want
\>
| 是 | 获取WantAgent对象want的回调方法。 |
| callback | AsyncCallback
\<
[
Want
](
js-apis-app-ability-want.md
)
\>
| 是 | 获取WantAgent对象want的回调方法。 |
**错误码:**
|错误码ID |错误信息 |
...
...
@@ -1056,7 +1056,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co
| ----------- | ----------------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
| triggerInfo |
[
TriggerInfo
](
js-apis-inner-wantAgent-triggerInfo.md
)
| 是 | TriggerInfo对象。 |
| callback | AsyncCallback
\<
CompleteData
\>
| 否 | 主动激发WantAgent实例的回调方法。 |
| callback | AsyncCallback
\<
[
CompleteData
](
#completedata
)
\>
| 否 | 主动激发WantAgent实例的回调方法。 |
**错误码:**
| 错误码ID | 错误信息 |
...
...
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @
436330dd
...
...
@@ -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的启动模式设置为单例时回调会被调用
。
启动模式为单例的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
));
}
}
```
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
浏览文件 @
436330dd
...
...
@@ -19,8 +19,8 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason |
LaunchReason
| 是 | 是 | 指示启动原因。 |
| lastExitReason |
LastExitReason
| 是 | 是 | 表示最后退出原因。 |
| launchReason |
[
LaunchReason
](
#abilityconstantlaunchreason
)
| 是 | 是 | 指示启动原因。 |
| lastExitReason |
[
LastExitReason
](
#abilityconstantlastexitreason
)
| 是 | 是 | 表示最后退出原因。 |
## AbilityConstant.LaunchReason
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md
浏览文件 @
436330dd
...
...
@@ -108,7 +108,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback
\<
Array
\<
AbilityRunningInfo
>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback
\<
Array
\<
[
AbilityRunningInfo
](
js-apis-inner-application-abilityRunningInfo.md
)
>> | 是 | 被指定的回调方法。 |
**示例**
:
...
...
@@ -132,7 +132,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise
\<
Array
\<
AbilityRunningInfo
>> | 返回执行结果。 |
| Promise
\<
Array
\<
[
AbilityRunningInfo
](
js-apis-inner-application-abilityRunningInfo.md
)
>> | 返回执行结果。 |
**示例**
:
...
...
@@ -159,7 +159,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback
\<
Array
\<
AbilityRunningInfo
>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback
\<
Array
\<
[
ExtensionRunningInfo
](
js-apis-inner-application-extensionRunningInfo.md
)
>> | 是 | 被指定的回调方法。 |
**示例**
:
...
...
@@ -191,7 +191,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise
\<
Array
\<
AbilityRunningInfo
>> | 返回执行结果。 |
| Promise
\<
Array
\<
[
ExtensionRunningInfo
](
js-apis-inner-application-extensionRunningInfo.md
)
>> | 返回执行结果。 |
**示例**
:
...
...
@@ -217,7 +217,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback
\<
ElementName
> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback
\<
[
ElementName
](
js-apis-bundleManager-elementName.md
)
> | 是 | 被指定的回调方法。 |
**示例**
:
...
...
@@ -239,7 +239,7 @@ getTopAbility(): Promise\<ElementName>;
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise
\<
ElementName
>| 返回执行结果。 |
| Promise
\<
[
ElementName
](
js-apis-bundleManager-elementName.md
)
>| 返回执行结果。 |
**示例**
:
...
...
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @
436330dd
...
...
@@ -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
...
...
zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
浏览文件 @
436330dd
...
...
@@ -170,7 +170,7 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise
\<
Array
\<
ProcessRunningInfo
>> | 获取有关运行进程的信息。 |
| Promise
\<
Array
\<
[
ProcessRunningInfo
](
js-apis-inner-application-processRunningInfo.md
)
>> | 获取有关运行进程的信息。 |
**示例:**
...
...
@@ -198,7 +198,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
\<
Array
\<
ProcessRunningInfo
>> | 是 | 获取有关运行进程的信息。 |
| callback | AsyncCallback
\<
Array
\<
[
ProcessRunningInfo
](
js-apis-inner-application-processRunningInfo.md
)
>> | 是 | 获取有关运行进程的信息。 |
**示例:**
...
...
@@ -419,7 +419,7 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback
\<
Array
\<
AppStateData>>): void;
获取
前台进程的应用程序
。
获取
所有当前处于前台的应用信息。该应用信息由
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
定义
。
**需要权限**
:ohos.permission.GET_RUNNING_INFO
...
...
@@ -431,7 +431,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
\<
Array
\<
AppStateData>> | 是 | 表示应用的状态数据
。 |
| callback | AsyncCallback
\<
Array
\<
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
>> | 是 | callback形式返回所有当前处于前台的应用信息
。 |
**示例:**
...
...
@@ -450,7 +450,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
getForegroundApplications(): Promise
\<
Array
\<
AppStateData>>;
获取
前台进程的应用程序
。
获取
所有当前处于前台的应用信息。该应用信息由
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
定义
。
**需要权限**
:ohos.permission.GET_RUNNING_INFO
...
...
@@ -462,7 +462,7 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise
\<
Array
\<
ProcessRunningInfo>> | 返回进程运行信息的数组
。 |
| Promise
\<
Array
\<
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
>> | Promise形式返回所有当前处于前台的应用信息
。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
浏览文件 @
436330dd
...
...
@@ -233,7 +233,7 @@ startAbility(want: Want, options?: StartOptions): Promise<void>;
startAbilityForResult(want: Want, callback: AsyncCallback
<
AbilityResult
>
): void;
启动
Ability并在该Ability退出的时候返回执行结果
(callback形式)。
启动
一个Ability。Ability被启动后,正常情况下可通过调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者
(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -300,7 +300,8 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>):
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
<
AbilityResult
>
): void;
启动Ability并在该Ability退出的时候返回执行结果(callback形式)。
启动一个Ability。Ability被启动后,正常情况下可通过调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -372,7 +373,7 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
startAbilityForResult(want: Want, options?: StartOptions): Promise
<
AbilityResult
>
;
启动
Ability并在该Ability退出的时候返回执行结果
(promise形式)。
启动
一个Ability。Ability被启动后,正常情况下可通过调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者
(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1264,7 +1265,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
...
...
@@ -1323,7 +1324,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
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录