Skip to content

D
Docs

OpenHarmony / Docs
11 个月 前同步成功

通知 158
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 fe8373c5 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1921 Fix format issues of ability api 

Merge pull request !1921 from yuyaozhi/master
上级 3a7a1e45 4a654d9a
隐藏空白更改
内联 并排
Showing with 965 addition and 892 deletion
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ fe8373c5
......@@ -15,9 +15,7 @@ var context = featureAbility.getContext();
context.getOrCreateLocalDir()
```
## Context
### getOrCreateLocalDir
## Context.getOrCreateLocalDir
getOrCreateLocalDir(callback: AsyncCallback\<string>): void
......@@ -25,13 +23,10 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void
如果是第一次调用，将创建目录。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------- |
| callback | AsyncCallback\<string> | 是 | 返回应用程序的本地根目录。 |
......@@ -48,7 +43,7 @@ context.getOrCreateLocalDir((err, data)=>{
### getOrCreateLocalDir
## Context.getOrCreateLocalDir
getOrCreateLocalDir(): Promise\<string>
......@@ -56,9 +51,7 @@ getOrCreateLocalDir(): Promise\<string>
如果是第一次调用，将创建目录。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -78,19 +71,16 @@ context.getOrCreateLocalDir().then((data) => {
### verifyPermission
## Context.verifyPermission
verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>): void
验证系统中运行的特定pid和uid是否允许指定的权限（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ------------------------------------- |
| permission | string | 是 | 指定权限的名称。 |
......@@ -110,14 +100,15 @@ bundle.getBundleInfo('com.context.test', 1, (datainfo) =>{
### verifyPermission
## Context.verifyPermission
verifyPermission(permission: string, callback: AsyncCallback\<number>): void
验证系统中运行的当前pid和uid是否具有指定的权限（callback形式）。
**参数：**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------- | ---- | ------------------------------------- |
......@@ -132,19 +123,16 @@ var context = featureAbility.getContext();
context.verifyPermission("com.example.permission")
```
### verifyPermission
## Context.verifyPermission
verifyPermission(permission: string, options?: PermissionOptions): Promise\<number>
验证系统中运行的特定pid和uid是否具有指定的权限（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ---------------- |
| permission | string | 是 | 指定权限的名称。 |
......@@ -170,24 +158,22 @@ context.verifyPermission('com.context.permission',Permission).then((data) => {
### requestPermissionsFromUser
## Context.requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback<[PermissionRequestResult](#permissionrequestresult)>)
requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback<[PermissionRequestResult](#permissionrequestresult)>): void
从系统请求某些权限（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| permissions | Array\<string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是 | 返回授权结果信息。 |
**示例：**
```js
......@@ -208,15 +194,13 @@ context.requestPermissionsFromUser(
### getApplicationInfo
## Context.getApplicationInfo
getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>)
getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void
获取有关当前应用程序的信息（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -234,15 +218,13 @@ context.getApplicationInfo()
### getApplicationInfo
## Context.getApplicationInfo
getApplicationInfo(): Promise\<ApplicationInfo>
获取有关当前应用程序的信息（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -263,15 +245,13 @@ context.getApplicationInfo().then((data) => {
### getBundleName
## Context.getBundleName
getBundleName(callback: AsyncCallback\<string>): void
获取当前ability的捆绑包名称（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -289,15 +269,13 @@ context.getBundleName()
### getBundleName
## Context.getBundleName
getBundleName(): Promise\<string>
获取当前ability的捆绑包名称（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -318,15 +296,13 @@ context.getBundleName().then((data) => {
### getProcessInfo
## Context.getProcessInfo
getProcessInfo(callback: AsyncCallback\<ProcessInfo>)
getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void
获取有关当前进程的信息，包括进程ID和名称（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -344,15 +320,13 @@ context.getProcessInfo()
### getProcessInfo
## Context.getProcessInfo
getProcessInfo(): Promise\<ProcessInfo>
获取有关当前进程的信息，包括进程id和名称（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -373,7 +347,7 @@ context.getProcessInfo().then((data) => {
### getElementName
## Context.getElementName
getElementName(callback: AsyncCallback\<ElementName>): void
......@@ -381,9 +355,7 @@ getElementName(callback: AsyncCallback\<ElementName>): void
此方法仅适用于页面功能。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -401,7 +373,7 @@ context.getElementName()
### getElementName
## Context.getElementName
getElementName(): Promise\<ElementName>
......@@ -409,9 +381,7 @@ getElementName(): Promise\<ElementName>
此方法仅适用于页面功能。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -430,15 +400,15 @@ context.getElementName().then((data) => {
});
```
### getProcessName
## Context.getProcessName
getProcessName(callback: AsyncCallback\<string>): void
获取当前进程的名称（callback形式）。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------- |
......@@ -454,15 +424,13 @@ context.getProcessName()
### getProcessName
## Context.getProcessName
getProcessName(): Promise\<string>
获取当前进程的名称（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -483,15 +451,13 @@ context.getProcessName().then((data) => {
### getCallingBundle
## Context.getCallingBundle
getCallingBundle(callback: AsyncCallback\<string>): void
获取调用ability的包名称（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -509,15 +475,13 @@ context.getCallingBundle()
### getCallingBundle
## Context.getCallingBundle
getCallingBundle(): Promise\<string>
获取调用ability的包名称（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
......@@ -540,13 +504,13 @@ context.getCallingBundle().then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------ |
| pid | 只读 | number | 否 | 进程id<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core|
| uid | 只读 | number | 否 | 用户id<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| pid | 只读 | number | 否 | 进程id。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| uid | 只读 | number | 否 | 用户id。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
## PermissionRequestResult
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------- | ---- | ------------------ |
| requestCode | 只读 | number | 是 | 用户传入的请求代码<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| authResults | 只读 | Array\<number> | 是 | 求权限的结果<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| requestCode | 只读 | number | 是 | 用户传入的请求代码。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| permissions | 只读 | Array\<string> | 是 | 用户传入的权限。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| authResults | 只读 | Array\<number> | 是 | 求权限的结果。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
浏览文件 @ fe8373c5
......@@ -12,14 +12,16 @@ getId(uri: string): number
获取附加到给定uri的路径组件末尾的ID。
**参数：**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 附加到路径组件末尾的ID。 |
......@@ -38,8 +40,9 @@ attachId(uri: string, id: number): string
将给定ID附加到给定uri的路径组件的末尾。
**参数：**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
......@@ -47,6 +50,7 @@ attachId(uri: string, id: number): string
| id | number | 是 | 指示要附加的ID。 |
**返回值：**
| 类型 | 说明 |
| ------ | --------------------- |
| string | 附加给定ID的uri对象。 |
......@@ -69,6 +73,8 @@ deleteId(uri: string): string
从给定uri的路径组件的末尾删除ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
......@@ -76,6 +82,7 @@ deleteId(uri: string): string
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------- |
| string | ID已删除的uri对象。 |
......@@ -94,6 +101,8 @@ updateId(uri: string, id: number): string
更新指定uri中的ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 名称 | 类型 | 必填 | 描述 |
......@@ -102,6 +111,7 @@ updateId(uri: string, id: number): string
| id | number | 是 | 指示新ID |
**返回值：**
| 类型 | 说明 |
| ------ | --------------- |
| string | 更新的uri对象。 |
......
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @ fe8373c5
......@@ -14,7 +14,7 @@ Ability的上下文环境，继承自Context。
```
```js
import Ability from '@ohos.application.Ability'
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
......@@ -28,28 +28,28 @@ class MainAbility extends Ability {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 <br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core|
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 <br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core|
## startAbility
## AbilityContext.startAbility
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
启动Ability。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
- 示例：
```
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
......@@ -61,26 +61,25 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbility
## AbilityContext.startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void
启动Ability。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| options | StartOptions | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
- 示例：
**示例：**
```
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
......@@ -95,29 +94,30 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbility
## AbilityContext.startAbility
startAbility(want: Want, options: StartOptions): Promise&lt;void&gt;;
启动Ability。通过Promise返回结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| options | StartOptions | 是 | 启动Ability所携带的参数。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise形式返回启动结果。 |
- 示例：
```
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
......@@ -135,25 +135,25 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbilityForResult
## AbilityContext.startAbilityForResult
startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在结束的时候返回执行结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 |
- 示例：
```
**示例：**
```js
this.context.startAbilityForResult(
{bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo2"},
(error, result) => {
......@@ -163,17 +163,16 @@ SystemCapability.Ability.AbilityRuntime.Core
);
```
## startAbilityForResult
## AbilityContext.startAbilityForResult
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在结束的时候返回执行结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
......@@ -181,8 +180,9 @@ SystemCapability.Ability.AbilityRuntime.Core
| callback | AsyncCallback&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | 是 | 执行结果回调函数。 |
- 示例：
```
**示例：**
```js
var options = {
windowMode: 0,
};
......@@ -196,30 +196,31 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbilityForResult
## AbilityContext.startAbilityForResult
startAbilityForResult(want: Want, options: StartOptions): Promise&lt;AbilityResult&gt;;
启动Ability并在结束的时候返回执行结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 启动Ability的want信息。 |
| options | StartOptions | 是 | 启动Ability所携带的参数。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[AbilityResult](js-apis-featureAbility.md#abilityresult)&gt; | Promise形式返回执行结果。 |
- 示例：
```
**示例：**
```js
var options = {
windowMode: 0,
};
......@@ -231,46 +232,46 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelf
## AbilityContext.terminateSelf
terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
停止Ability自身。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
```
**示例：**
```js
this.context.terminateSelf((err) => {
console.log('terminateSelf result:' + JSON.stringfy(err));
});
```
## terminateSelf
## AbilityContext.terminateSelf
terminateSelf(): Promise&lt;void&gt;;
停止Ability自身。通过Promise返回结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
- 示例：
```
**示例：**
```js
this.context.terminateSelf(want).then((data) => {
console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
......@@ -279,24 +280,24 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelfWithResult
## AbilityContext.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void;
停止Ability，并返回给调用startAbilityForResult 接口调用方的相关信息。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回停止结果。 |
- 示例：
```
**示例：**
```js
this.context.terminateSelfWithResult(
{
want: {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo"},
......@@ -308,28 +309,29 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelfWithResult
## AbilityContext.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
停止Ability，并返回给调用startAbilityForResult 接口相关信息。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise形式返回停止结果。 |
- 示例：
```
**示例：**
```js
this.context.terminateSelfWithResult(
{
want: {bundleName: "com.extreme.myapplication", abilityName: "MainAbilityDemo"},
......@@ -341,29 +343,29 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbilityByCall
## AbilityContext.startAbilityByCall
startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
获取指定通用组件服务端的caller通信接口, 并且将指定通用组件服务端拉起并切换到后台。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 传入需要启动的ability的信息，包含ability名称、包名、设备ID，设备ID缺省或为空表示启动本地ability。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;&gt; | 获取要通讯的caller对象。 |
| Promise&lt;Caller&gt; | 获取要通讯的caller对象。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
var caller;
export default class MainAbility extends Ability {
......@@ -383,23 +385,22 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## requestPermissionsFromUser
## AbilityContext.requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array&lt;string&gt;, requestCallback: AsyncCallback&lt;PermissionRequestResult&gt;) : void;
拉起弹窗请求用户授权。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
| callback | AsyncCallback&lt;[PermissionRequestResult](js-apis-permissionrequestresult.md)&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
**示例：**
```
this.context.requestPermissionsFromUser(permissions,(result) => {
......@@ -408,27 +409,27 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## requestPermissionsFromUser
## AbilityContext.requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array&lt;string&gt;) : Promise&lt;PermissionRequestResult&gt;;
拉起弹窗请求用户授权。通过Promise返回结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
**返回值：**
- 返回值：
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[PermissionRequestResult](js-apis-permissionrequestresult.md)&gt; | 返回一个Promise，包含接口的结果。 |
- 示例：
**示例：**
```
this.context.requestPermissionsFromUser(permissions).then((data) => {
......@@ -439,54 +440,53 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## setMissionLabel
## AbilityContext.setMissionLabel
setMissionLabel(label: string, callback:AsyncCallback&lt;void&gt;): void;
设置ability在任务中显示的名称。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
**示例：**
```
```js
this.context.setMissionLabel("test",(result) => {
console.log('requestPermissionsFromUserresult:' + JSON.stringfy(result));
});
```
## setMissionLabel
## AbilityContext.setMissionLabel
setMissionLabel(label: string): Promise&lt;void&gt;
设置ability在任务中显示的名称。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
- 示例：
**示例：**
```
```js
this.context.setMissionLabel("test").then((data) => {
console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
......
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @ fe8373c5
......@@ -14,34 +14,33 @@ Ability运行相关信息。
```
```js
import abilitymanager from '@ohos.application.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data));
});
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 否 | Ability匹配信息。 |
| pid | number | 是 | 否 | 进程ID。 |
| uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Ability启动时间。 |
| abilityState | [abilityManager.AbilityState](#abilitymanager-abilitystate) | 是 | 否 | Ability状态。 |
| ability | ElementName | 是 | 否 | Ability匹配信息。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| pid | number | 是 | 否 | 进程ID。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| uid | number | 是 | 否 | 用户ID。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| processName | string | 是 | 否 | 进程名称。 <br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| startTime | number | 是 | 否 | Ability启动时间。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| abilityState | [abilityManager.AbilityState](#abilitymanager-abilitystate) | 是 | 否 | Ability状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
## abilityManager.AbilityState
Ability的状态信息。
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。 |
| FOREGROUND | 9 | 表示ability为foreground状态。 |
| BACKGROUND | 10 | 表示ability为background状态。 |
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 |
| INITIAL | 0 | 表示ability为initial状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core|
| FOREGROUND | 9 | 表示ability为foreground状态。 <br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| BACKGROUND | 10 | 表示ability为background状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
浏览文件 @ fe8373c5
......@@ -14,7 +14,7 @@ AbilityStage的上下文环境，继承自[Context](js-apis-application-context.
```
```js
import AbilityStage from '@ohos.application.AbilityStage';
class MyAbilityStage extends AbilityStage {
onCreate() {
......@@ -26,7 +26,7 @@ class MyAbilityStage extends AbilityStage {
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。 |
| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 环境变化对象。 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 环境变化对象。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-application-MissionInfo.md
浏览文件 @ fe8373c5
......@@ -21,13 +21,13 @@ import Want from "../@ohos.application.Want";
表示Ability对应任务信息的枚举。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。 |
| runningState | number | 是 | 是 | 表示运行状态。 |
| lockedState | boolean | 是 | 是 | 表示锁定状态。 |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 |
| want | [Want](js-apis-featureAbility.md#want) | 是 | 是 | 表示任务的Want信息。 |
| label | string | 是 | 是 | 表示任务的标签。 |
| iconPath | string | 是 | 是 | 表示任务的图标路径。 |
| continuable | boolean | 是 | 是 | 表示任务是否可以继续。 |
| missionId | number | 是 | 是 | 表示任务ID。<br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| runningState | number | 是 | 是 | 表示运行状态。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| lockedState | boolean | 是 | 是 | 表示锁定状态。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| want | [Want](js-apis-featureAbility.md#want) | 是 | 是 | 表示任务的Want信息。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| label | string | 是 | 是 | 表示任务的标签。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| iconPath | string | 是 | 是 | 表示任务的图标路径。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| continuable | boolean | 是 | 是 | 表示任务是否可以继续。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ fe8373c5
......@@ -17,28 +17,31 @@ import Ability from '@ohos.application.Ability';
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context | [AbilityContext](js-apis-ability-context.md) | 是 | 否 | 上下文。 |
| launchWant | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 否 | Ability启动时的参数。 |
| lastRequestWant | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 否 | 上一次请求Ability启动时的参数。 |
| context | [AbilityContext](js-apis-ability-context.md) | 是 | 否 | 上下文。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore |
| launchWant | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 否 | Ability启动时的参数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore |
| lastRequestWant | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 否 | Ability最后请求时的参数。 <br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore|
## onCreate
## Ability.onCreate
onCreate(want: Want，param：LaunchParam): void
Ability创建时回调，执行初始化业务逻辑操作。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 |
| param | LaunchParam | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
- 示例：
**示例：**
```
```js
class myAbility extends Ability {
onCreate(want, param) {
console.log('onCreate, want:' + want.abilityName);
......@@ -47,20 +50,23 @@ Ability创建时回调，执行初始化业务逻辑操作。
```
## onWindowStageCreate
## Ability.onWindowStageCreate
onWindowStageCreate(windowStage: window.WindowStage): void
当WindowStage创建后调用。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
- 示例：
**示例：**
```
```js
class myAbility extends Ability {
onWindowStageCreate(windowStage) {
console.log('onWindowStageCreate');
......@@ -69,15 +75,17 @@ onWindowStageCreate(windowStage: window.WindowStage): void
```
## onWindowStageDestroy
## Ability.onWindowStageDestroy
onWindowStageDestroy(): void
当WindowStage销毁后调用。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```
```js
class myAbility extends Ability {
onWindowStageDestroy() {
console.log('onWindowStageDestroy');
......@@ -86,20 +94,23 @@ onWindowStageDestroy(): void
```
## onWindowStageRestore
## Ability.onWindowStageRestore
onWindowStageRestore(windowStage: window.WindowStage): void
当迁移多实例ability时，恢复WindowStage后调用。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
- 示例：
**示例：**
```
```js
class myAbility extends Ability {
onWindowStageRestore(windowStage) {
console.log('onWindowStageRestore');
......@@ -108,15 +119,17 @@ onWindowStageRestore(windowStage: window.WindowStage): void
```
## onDestroy
## Ability.onDestroy
onDestroy(): void;
Ability生命周期回调，在销毁时回调，执行资源清理等操作。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```
```js
class myAbility extends Ability {
onDestroy() {
console.log('onDestroy');
......@@ -125,15 +138,17 @@ Ability生命周期回调，在销毁时回调，执行资源清理等操作。
```
## onForeground
## Ability.onForeground
onForeground(): void;
Ability生命周期回调，当应用处于前台时触发。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```
```js
class myAbility extends Ability {
onForeground() {
console.log('onForeground');
......@@ -142,15 +157,17 @@ Ability生命周期回调，当应用处于前台时触发。
```
## onBackground
## Ability.onBackground
onBackground(): void;
Ability生命周期回调，当应用处于后台时触发。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```
```js
class myAbility extends Ability {
onBackground() {
console.log('onBackground');
......@@ -159,25 +176,29 @@ Ability生命周期回调，当应用处于后台时触发。
```
## onContinue
## Ability.onContinue
onContinue(wantParam : {[key: string]: any}): boolean;
当ability迁移准备迁移时触发，保存数据。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:&nbsp;string]:&nbsp;any} | 是 | want相关参数。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示同意迁移，false表示拒绝迁移。 |
- 示例：
**示例：**
```
```js
class myAbility extends Ability {
onContinue(wantParams) {
console.log('onContinue');
......@@ -188,20 +209,23 @@ onContinue(wantParam : {[key: string]: any}): boolean;
```
## onNewWant
## Ability.onNewWant
onNewWant(want: Want): void;
当ability的启动模式设置为单例时回调会被调用。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，如ability名称，包名等。 |
- 示例：
**示例：**
```
```js
class myAbility extends Ability {
onNewWant(want) {
console.log('onNewWant, want:' + want.abilityName);
......@@ -210,20 +234,23 @@ onNewWant(want: Want): void;
```
## onConfigurationUpdated
## Ability.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
当系统配置更新时调用。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](#section188911144124715) | 是 | 表示需要更新的配置信息。 |
- 示例：
**示例：**
```
```js
class myAbility extends Ability {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
......@@ -237,26 +264,30 @@ onConfigurationUpdated(config: Configuration): void;
通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。
### call
## Caller.call
call(method, data: rpc.Sequenceable): Promise&lt;void&gt;;
call(method: string, data: rpc.Sequenceable): Promise&lt;void&gt;;
向通用组件服务端发送约定序列化数据。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise形式返回应答。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
class MyMessageAble{ // 自定义的Sequenceable数据结构
num: 0
......@@ -296,26 +327,30 @@ call(method, data: rpc.Sequenceable): Promise&lt;void&gt;;
```
### callWithResult
## Caller.callWithResult
callWithResult(method, data: rpc.Sequenceable): Promise&lt;rpc.MessageParcel&gt;;
callWithResult(method: string, data: rpc.Sequenceable): Promise&lt;rpc.MessageParcel&gt;;
向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;rpc.MessageParcel&gt; | Promise形式返回通用组件服务端应答数据。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
class MyMessageAble{
num: 0
......@@ -357,15 +392,17 @@ callWithResult(method, data: rpc.Sequenceable): Promise&lt;rpc.MessageParcel&gt;
```
### release
## Caller.release
release(): void;
主动释放通用组件服务端的通信接口。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
var caller;
export default class MainAbility extends Ability {
......@@ -385,20 +422,23 @@ release(): void;
```
### onRelease
## Caller.onRelease
onRelease(callback: function): void;
注册通用组件服务端Stub断开监听通知。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | function | 是 | 返回onRelease回调结果。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
var caller;
export default class MainAbility extends Ability {
......@@ -425,21 +465,24 @@ onRelease(callback: function): void;
通用组件服务端注册和解除客户端caller通知送信的callback接口。
### on
## Callee.on
on(method: string, callback: function): void;
通用组件服务端注册消息通知callback。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback | function | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数,&nbsp;回调函数至少要返回一个空的rpc.Sequenceable数据对象,&nbsp;其他视为函数执行错误。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
class MyMessageAble{
num: 0
......@@ -474,20 +517,23 @@ on(method: string, callback: function): void;
```
### off
## Callee.off
off(method: string): void;
解除通用组件服务端注册消息通知callback。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 已注册的通知事件字符串。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability';
var method = 'call_Function';
export default class MainAbility extends Ability {
......
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md
浏览文件 @ fe8373c5
......@@ -10,20 +10,23 @@ AbilityStage是HAP包的运行时类。在HAP加载的时候，通知开发者
## 导入模块
```
```js
import AbilityStage from '@ohos.application.AbilityStage';
```
## onCreate
## AbilityStage.onCreate
onCreate(): void
当应用创建时调用。
- 示例
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**示例：**
```
```js
class MyAbilityStage extends AbilityStage {
onCreate() {
console.log("MyAbilityStage.onCreate is called")
......@@ -32,25 +35,29 @@ onCreate(): void
```
## onAcceptWant
## AbilityStage.onAcceptWant
onAcceptWant(want: Want): string;
启动一个specified ability时触发的事件。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| string | 用户返回一个ability标识，如果之前启动过次标识的ability，不创建新的实例并拉回栈顶，否则创建新的实例并启动。 |
- 示例
**示例：**
```
```js
class MyAbilityStage extends AbilityStage {
onAcceptWant(want) {
console.log("MyAbilityStage.onAcceptWant called");
......@@ -60,20 +67,23 @@ onAcceptWant(want: Want): string;
```
## onConfigurationUpdated
## AbilityStage.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
环境变化通知接口，发生全局配置变更时回调。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](js-apis-configuration.md) | 是 | 发生全局配置变更时触发回调，当前全局配置包括系统语言、深浅色模式。 |
- 示例：
**示例：**
```
```js
class MyAbilityStage extends AbilityStage {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, language:' + config.language);
......
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @ fe8373c5
......@@ -17,56 +17,63 @@
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| resourceManager | ResourceManager | 是 | 否 | ResourceManager对象。 |
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。 |
| cacheDir | string | 是 | 否 | 应用在内部存储上的缓存路径。 |
| tempDir | string | 是 | 否 | 应用的临时文件路径。 |
| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。 |
| databaseDir | string | 是 | 否 | 获取本地数据存储路径。 |
| storageDir | string | 是 | 否 | 获取轻量级数据存储路径。 |
| bundleCodeDir | string | 是 | 否 | 应用安装路径。 |
| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。 |
| eventHub | [EventHub](js-apis-eventhub.md) | 是 | 否 | 事件中心信息。|
| resourceManager | ResourceManager | 是 | 否 | ResourceManager对象。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| cacheDir | string | 是 | 否 | 应用在内部存储上的缓存路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| tempDir | string | 是 | 否 | 应用的临时文件路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| databaseDir | string | 是 | 否 | 获取本地数据存储路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| storageDir | string | 是 | 否 | 获取轻量级数据存储路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| bundleCodeDir | string | 是 | 否 | 应用安装路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| eventHub | [EventHub](js-apis-eventhub.md) | 是 | 否 | 事件中心信息。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core|
## createBundleContext
## Context.createBundleContext
createBundleContext(bundleName: string): Context;
创建指定应用上下文。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 应用bundle名。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 对应创建应用的上下文context。 |
- 示例：
**示例：**
```
```js
let test = "com.huawei.test";
let context = this.context.createBundleContext(test);
```
## getApplicationContext
## Context.getApplicationContext
getApplicationContext(): Context;
获取当前context。
- 返回值：
| 类型 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Context | 当前Context&nbsp;信息。 |
- 示例：
**示例：**
```
```js
// 必选项。
let context = this.context.getApplicationContext();
```
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
浏览文件 @ fe8373c5
......@@ -10,50 +10,56 @@ App管理。
## 导入模块
```
```js
import app from '@ohos.application.appManager';
```
## isRunningInStabilityTest
## appManager.isRunningInStabilityTest
static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
查询当前是否处于稳定性测试场景。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 否 | 返回当前是否处于稳定性测试场景。 |
- 示例：
**示例：**
```
```js
import app from '@ohos.application.appManager';
app.isRunningInStabilityTest((err, flag) => {
console.log('startAbility result:' + JSON.stringfy(err);
}
console.log('startAbility result:' + JSON.stringfy(err));
})
```
## isRunningInStabilityTest
## appManager.isRunningInStabilityTest
static isRunningInStabilityTest(): Promise&lt;boolean&gt;
查询当前是否处于稳定性测试场景。
- 返回值：
| 类型 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回当前是否处于稳定性测试场景。 |
- 示例：
**示例：**
```
```js
import app from '@ohos.application.appManager';
app.isRunningInStabilityTest().then((flag) => {
console.log('success:' + JSON.stringfy(flag));
)).catch((error) => {
}).catch((error) => {
console.log('failed:' + JSON.stringfy(error));
});
```
zh-cn/application-dev/reference/apis/js-apis-configuration.md
浏览文件 @ fe8373c5
......@@ -10,7 +10,7 @@
## 导入模块
```
```js
import Configuration from '@ohos.application.Configuration';
```
......@@ -19,8 +19,8 @@ import Configuration from '@ohos.application.Configuration';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode | [ColorMode](js-apis-configurationconstant.md) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（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）。 |
| displayId | number | 是 | 否 | 表示应用所在的displayId。 |
| language | string | 是 | 是 | 表示应用程序的当前语言。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| colorMode | [ColorMode](js-apis-configurationconstant.md) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| direction | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| 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）。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| displayId | number | 是 | 否 | 表示应用所在的displayId。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md
浏览文件 @ fe8373c5
......@@ -10,46 +10,61 @@
## 导入模块
```
```js
import ConfigurationConstant from '@ohos.application.ConfigurationConstant';
```
## ColorMode
## ConfigurationConstant.ColorMode
使用时通过ConfigurationConstant.ColorMode获取，示例：ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT。
使用时通过ConfigurationConstant.ColorMode获取。
**示例：**
| 名称 | 值 | 说明 |
```
ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT。
```
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。 |
| COLOR_MODE_DARK | 0 | 深色模式。 |
| COLOR_MODE_LIGHT | 1 | 浅色模式。 |
| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| COLOR_MODE_DARK | 0 | 深色模式。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| COLOR_MODE_LIGHT | 1 | 浅色模式。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
## ConfigurationConstant.Direction
## Direction
使用时通过ConfigurationConstant.Direction获取。
使用时通过ConfigurationConstant.Direction获取，示例：ConfigurationConstant.Direction.DIRECTION_VERTICAL。
**示例：**
```
ConfigurationConstant.Direction.DIRECTION_VERTICAL。
```
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DIRECTION_NOT_SET | -1 | 未设置方向。 |
| DIRECTION_VERTICAL | 0 | 垂直方向。 |
| DIRECTION_HORIZONTAL | 1 | 水平方向。 |
| DIRECTION_NOT_SET | -1 | 未设置方向。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| DIRECTION_VERTICAL | 0 | 垂直方向。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| DIRECTION_HORIZONTAL | 1 | 水平方向。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
## ConfigurationConstant.ScreenDensity
## ScreenDensity
使用时通过ConfigurationConstant.ScreenDensity获取。
使用时通过ConfigurationConstant.ScreenDensity获取，示例：ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET。
**示例：**
```
ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET。
```
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| 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"。 |
| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase|
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @ fe8373c5
......@@ -8,17 +8,13 @@ import ohos_data_ability from '@ohos.data.dataability'
import ohos_data_rdb from '@ohos.data.rdb'
```
## DataAbilityHelper
### openFile
## DataAbilityHelper.openFile
openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
在指定的远程路径中打开文件（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -44,15 +40,13 @@ DAHelper.openFile(
});
```
### openFile
## DataAbilityHelper.openFile
openFile(uri: string, mode: string): Promise\<number>
在指定的远程路径中打开文件（promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -62,6 +56,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ---------------- |
| Promise\<number> | 返回文件描述符。 |
......@@ -81,15 +76,13 @@ DAHelper.openFile(
});
```
### on('dataChange')
## DataAbilityHelper.on
on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
注册观察者以观察给定uri指定的数据callback通知。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -116,15 +109,13 @@ helper.on(
)
```
### off('dataChange')
## DataAbilityHelper.off
off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
注消观察者以停止观察给定uri指定的数据callback通知。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -155,15 +146,13 @@ helper.off(
)
```
### getType
## DataAbilityHelper.getType
getType(uri: string, callback: AsyncCallback\<string>): void
获取给定URI指定数据的MIME类型（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -186,15 +175,13 @@ DAHelper.getType(
});
```
### getType
## DataAbilityHelper.getType
getType(uri: string): Promise\<string>
获取给定URI指定数据的MIME类型（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -203,6 +190,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要操作的数据的路径。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ----------------------------------- |
| Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 |
......@@ -221,15 +209,13 @@ DAHelper.getType(
});
```
### getFileTypes
## DataAbilityHelper.getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
获取支持的文件的MIME类型（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -256,15 +242,13 @@ DAHelper.getFileTypes(
### getFileTypes
## DataAbilityHelper.getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
获取支持的文件的MIME类型（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -274,6 +258,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
**返回值：**
| 类型 | 说明 |
| ------------------------ | ------------------------ |
| Promise\<Array\<string>> | 返回匹配的MIME类型数组。 |
......@@ -293,15 +278,13 @@ DAHelper.getFileTypes(
});
```
### normalizeUri
## DataAbilityHelper.normalizeUri
normalizeUri(uri: string, callback: AsyncCallback\<string>): void
将引用数据功能的给定uri转换为规范化uri（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -324,15 +307,13 @@ DAHelper.normalizeUri(
});
```
### normalizeUri
## DataAbilityHelper.normalizeUri
normalizeUri(uri: string): Promise\<string>
将引用数据功能的给定uri转换为规范化uri（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -341,6 +322,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要规范化的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------ |
| Promise\<string> | 如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 |
......@@ -359,15 +341,13 @@ DAHelper.normalizeUri(
});
```
### denormalizeUri
## DataAbilityHelper.denormalizeUri
denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -392,15 +372,13 @@ DAHelper.denormalizeUri(
### denormalizeUri
## DataAbilityHelper.denormalizeUri
denormalizeUri(uri: string): Promise\<string>
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -409,6 +387,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要规范化的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ----------------------------------------- |
| Promise\<string> | 如果反规范化成功，则返回反规范化uri对象。 |
......@@ -427,15 +406,13 @@ DAHelper.denormalizeUri(
});
```
### notifyChange
## DataAbilityHelper.notifyChange
notifyChange(uri: string, callback: AsyncCallback\<void>): void
通知已注册的观察者uri指定的数据资源的更改（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -458,15 +435,13 @@ helper.notifyChange(
});
```
### notifyChange
## DataAbilityHelper.notifyChange
notifyChange(uri: string): Promise\<void>
通知已注册的观察者uri指定的数据资源的更改（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -475,6 +450,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要操作的数据的路径。 |
**返回值：**
| 类型 | 说明 |
| -------------- | --------------------- |
| Promise\<void> | 返回值为Promise对象。 |
......@@ -493,15 +469,13 @@ DAHelper.notifyChange(
});
```
### insert
## DataAbilityHelper.insert
insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void
将单个数据记录插入数据库（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -532,15 +506,13 @@ DAHelper.insert(
});
```
### insert
## DataAbilityHelper.insert
insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
将单个数据记录插入数据库（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -550,6 +522,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ------------------------ |
| Promise\<number> | 返回插入数据记录的索引。 |
......@@ -575,15 +548,13 @@ DAHelper.insert(
});
```
### batchInsert
## DataAbilityHelper.batchInsert
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void
插入数据库（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -611,15 +582,13 @@ DAHelper.batchInsert(
});
```
### batchInsert
## DataAbilityHelper.batchInsert
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<number>
将多个数据记录插入数据库（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -629,6 +598,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ---------------------- |
| Promise\<number> | 返回插入的数据记录数。 |
......@@ -651,15 +621,13 @@ DAHelper.batchInsert(
});
```
### delete
## DataAbilityHelper.delete
delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
从数据库中删除一个或多个数据记录（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -686,15 +654,13 @@ DAHelper.delete(
});
```
### delete
## DataAbilityHelper.delete
delete(uri: string, predicates: dataAbility.DataAbilityPredicates): Promise\<number>
从数据库中删除一个或多个数据记录（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -704,6 +670,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | ------------------------ |
| Promise\<number> | 返回已删除的数据记录数。 |
......@@ -724,15 +691,13 @@ DAHelper.delete(
});
```
### update
## DataAbilityHelper.update
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
更新数据库中的数据记录（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -767,15 +732,13 @@ DAHelper.update(
});
```
### update
## DataAbilityHelper.update
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): Promise\<number>
更新数据库中的数据记录（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -786,6 +749,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
**返回值：**
| 类型 | 说明 |
| ---------------- | -------------------------------------------- |
| Promise\<number> | Promise中包含更新的数据记录数。 。 |
......@@ -814,15 +778,13 @@ DAHelper.update(
});
```
### query
## DataAbilityHelper.query
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void
查询数据库中的数据（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -854,15 +816,13 @@ DAHelper.query(
### query
## DataAbilityHelper.query
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates): Promise\<ResultSet>
查询数据库中的数据（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -873,6 +833,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------- |
| Promise\<ResultSet> | 返回查询结果。 |
......
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
浏览文件 @ fe8373c5
......@@ -14,7 +14,7 @@
```
```js
import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability {
onForeground() {
......@@ -24,25 +24,24 @@ export default class MainAbility extends Ability {
```
## on
## EventHub.on
on(event: string, callback: Function): void;
订阅指定事件。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 事件名称。 |
| callback | Function | 是 | 事件回调，事件触发后运行。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability {
......@@ -63,25 +62,24 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## off
## EventHub.off
off(event: string, callback?: Function): void;
取消订阅指定事件。当callback传值时，取消订阅指定的callback；未传值时，取消订阅该事件下所有callback。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 事件名称。 |
| callback | Function | 否 | 事件回调。如果不传callback，则取消订阅该事件下所有callback。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability {
......@@ -102,25 +100,24 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## emit
## EventHub.emit
emit(event: string, ...args: Object[]): void;
触发指定事件。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 事件名称。 |
| ...args | Object[] | 是 | 可变参数，事件触发时，传递给回调函数的参数。 |
- 示例：
**示例：**
```
```js
import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability {
......
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
浏览文件 @ fe8373c5
......@@ -11,4 +11,4 @@ Extension的上下文环境，继承自Context。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ fe8373c5
......@@ -16,9 +16,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
启动新的ability（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -57,9 +55,7 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
启动新的ability（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -97,9 +93,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -128,9 +122,7 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -167,9 +159,7 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -178,6 +168,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 表示被启动的Ability |
**返回值：**
| 类型 | 说明 |
| ----------------------------------------- | -------------- |
| Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 |
......@@ -224,9 +215,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -274,9 +263,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -285,6 +272,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| parameter | [AbilityResult](#abilityresult) | 是 | 表示被启动的Ability |
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------- |
| Promise\<void> | 以Promise形式返回结果。 |
......@@ -332,9 +320,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
检查Ability的主窗口是否具有窗口焦点（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -357,9 +343,7 @@ hasWindowFocus(): Promise\<boolean>
检查Ability的主窗口是否具有窗口焦点（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：**
......@@ -384,9 +368,7 @@ getWant(callback: AsyncCallback\<Want>): void
获取从Ability发送的Want（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -409,11 +391,10 @@ getWant(): Promise\<Want>
获取从Ability发送的Want（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：**
| 类型 | 说明 |
| ----------------------- | ------------------------- |
| Promise\<[Want](#want)> | 以Promise的形式返回结果。 |
......@@ -433,11 +414,10 @@ getContext(): Context
获取应用上下文。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：**
| 类型 | 说明 |
| ------- | -------------------- |
| Context | 返回应用程序上下文。 |
......@@ -458,9 +438,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -483,11 +461,10 @@ terminateSelf(): Promise\<void>
设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 以Promise的形式返回结果。 |
......@@ -506,9 +483,7 @@ connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -521,19 +496,20 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
| deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
**ConnectOptions类型说明：**
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------ | -------- | -------- | ---- | ---------------------------------- |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| onConnect | 只读 | function | 是 | 连接成功时的回调函数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 连接的ServiceAbilityID。 |
......@@ -572,9 +548,7 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
断开与指定ServiceAbility的连接（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -621,9 +595,7 @@ disconnectAbility(connection: number): Promise\<void>
断开与指定ServiceAbility的连接（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -632,6 +604,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
**返回值：**
| 类型 | 说明 |
| -------------- | ----------------------- |
| Promise\<void> | 以Promise形式返回结果。 |
......@@ -668,48 +641,48 @@ var result = await featureAbility.disconnectAbility(connId);
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| want | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| want | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
## StartAbilityParameter
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## Want
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| action | 只读 | string | 否 | 表示action选项描述。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| action | 只读 | string | 否 | 表示action选项描述。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
## flags说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 <br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给**ohos.app.Context#startAbility**的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。<<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给**ohos.app.Context#startAbility**的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md
浏览文件 @ fe8373c5
......@@ -19,33 +19,37 @@ createFormBindingData(obj?: Object | string): FormBindingData
创建一个FormBindingData对象。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| ----------------------------------- | --------------------------------------- |
| [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 |
**示例：**
- 示例：
```
```js
let obj = {"temperature": "21°"};
let formBindingDataObj = formBindingData.createFormBindingData(obj);
```
## FormBindingData
## formBindingData.FormBindingData
FormBindingData相关描述。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 名称 | 类型 | 说明 |
| ---- | -------------- | ------------------------------------------------------------ |
| obj | Object或string | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-formextension.md
浏览文件 @ fe8373c5
......@@ -19,7 +19,7 @@ import FormExtension from '@ohos.application.FormExtension';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- |
| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 |
| context | [FormExtensionContext](js-apis-formextensioncontext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。<br/>**系统能力**：SystemCapability.Ability.Form |
## onCreate
......@@ -27,21 +27,23 @@ onCreate(want: Want): formBindingData.FormBindingData
卡片提供方接收创建卡片的通知接口。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want | [Want](js-apis-featureAbility.md#want) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 一个formBindingData.FormBindingData对象，卡片要显示的数据。 |
- 示例：
**示例：**
```
```js
export default class MyFormExtension extends FormExtension {
onCreate(want) {
console.log('FormExtension onCreate, want:' + want.abilityName);
......@@ -55,19 +57,21 @@ onCreate(want: Want): formBindingData.FormBindingData
}
```
## onCastToNormal
## FormExtension.onCastToNormal
onCastToNormal(formId: string): void
卡片提供方接收临时卡片转常态卡片的通知接口。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------ |
| formId | string | 是 | 请求转换为常态的卡片ID。 |
- 示例：
**示例：**
```
export default class MyFormExtension extends FormExtension {
......@@ -77,21 +81,23 @@ onCastToNormal(formId: string): void
}
```
## onUpdate
## FormExtension.onUpdate
onUpdate(formId: string): void
卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-formextensioncontext.md)的updateForm接口刷新卡片数据。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| formId | string | 是 | 请求更新的卡片ID。 |
- 示例：
**示例：**
```
```js
export default class MyFormExtension extends FormExtension {
onUpdate(formId) {
console.log('FormExtension onUpdate, formId:' + formId);
......@@ -105,21 +111,23 @@ onUpdate(formId: string): void
}
```
## onVisibilityChange
## FormExtension.onVisibilityChange
onVisibilityChange(newStatus: { [key: string]: number }): void
卡片提供方接收修改可见性的通知接口。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------- |
| newStatus | { [key: string]: number } | 是 | 请求修改的卡片ID和可见状态。 |
- 示例：
**示例：**
```
```js
export default class MyFormExtension extends FormExtension {
onVisibilityChange(newStatus) {
console.log('FormExtension onVisibilityChange, newStatus:' + newStatus);
......@@ -137,22 +145,24 @@ onVisibilityChange(newStatus: { [key: string]: number }): void
}
```
## onEvent
## FormExtension.onEvent
onEvent(formId: string, message: string): void
卡片提供方接收处理卡片事件的通知接口。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------- |
| formId | string | 是 | 请求触发事件的卡片ID。 |
| message | string | 是 | 事件消息。 |
- 示例：
**示例：**
```
```js
export default class MyFormExtension extends FormExtension {
onEvent(formId, message) {
console.log('FormExtension onEvent, formId:' + formId + ", message:" + message);
......@@ -160,21 +170,23 @@ onEvent(formId: string, message: string): void
}
```
## onDestroy
## FormExtension.onDestroy
onDestroy(formId: string): void
卡片提供方接收销毁卡片的通知接口。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| formId | string | 是 | 请求销毁的卡片ID。 |
- 示例：
**示例：**
```
```js
export default class MyFormExtension extends FormExtension {
onDestroy(formId) {
console.log('FormExtension onDestroy, formId:' + formId);
......
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md
浏览文件 @ fe8373c5
......@@ -5,13 +5,15 @@
FormExtension的上下文环境，提供FormExtension具有的能力和接口，继承自ExtensionContext。
## updateForm
## FormExtensionContext.updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\<void>): void
主动更新卡片。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
......@@ -19,35 +21,37 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData, cal
| formBindingData | [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 卡片新的数据。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
**示例：**
```
```js
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
this.context.updateForm(formId, obj2, (data)=>{
console.log('FormExtension context updateForm, data:' + data);
});
```
## updateForm
## FormExtensionContext.updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise\<void>
更新卡片。
- 参数：
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------ |
| formId | string | 是 | 请求更新的卡片ID。 |
| formBindingData | [formBindingData.FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是 | 卡片新的数据。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------------- | --------------------------------- |
| Promise\<void> | 返回一个Promise，包含接口的结果。 |
- 示例：
**示例：**
```
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
......
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
浏览文件 @ fe8373c5
......@@ -16,25 +16,29 @@ import missionManager from '@ohos.application.missionManager'
```
## registerMissionListener
## missionManager.registerMissionListener
function registerMissionListener(listener: MissionListener): number;
注册系统任务状态监听。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listener | MissionListener | 是 | 系统任务监听方法。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 监听方法的index值，由系统创建，在注册系统任务状态监听时分配，和监听方法一一对应&nbsp;。 |
- 示例：
**示例：**
```
```js
var listener = {
onMissionCreated: this.onMissionCreatedCallback,
onMissionDestroyed: this.onMissionDestroyedCallback,
......@@ -47,21 +51,24 @@ function registerMissionListener(listener: MissionListener): number;
```
## unregisterMissionListener
## missionManager.unregisterMissionListener
function unregisterMissionListener(listenerId: number, callback: AsyncCallback&lt;void&gt;): void;
取消任务状态监听。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
- 示例：
**示例：**
```
```js
var listener = {
onMissionCreated: this.onMissionCreatedCallback,
onMissionDestroyed: this.onMissionDestroyedCallback,
......@@ -77,20 +84,23 @@ function unregisterMissionListener(listenerId: number, callback: AsyncCallback&l
```
## unregisterMissionListener
## missionManager.unregisterMissionListener
function unregisterMissionListener(listenerId: number): Promise&lt;void&gt;;
取消任务状态监听，以promise方式返回执行结果。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |
- 示例：
**示例：**
```
```js
var listener = {
onMissionCreated: this.onMissionCreatedCallback,
onMissionDestroyed: this.onMissionDestroyedCallback,
......@@ -106,22 +116,25 @@ function unregisterMissionListener(listenerId: number): Promise&lt;void&gt;;
```
## getMissionInfo
## missionManager.getMissionInfo
function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback&lt;MissionInfo&gt;): void;
获取任务信息，以异步回调的方式返回任务信息。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;MissionInfo&gt; | 是 | 执行结果回调函数，返回任务信息。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfo("", allMissions[0].missionId, (error, mission) => {
......@@ -136,26 +149,30 @@ function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCall
```
## getMissionInfo
## missionManager.getMissionInfo
function getMissionInfo(deviceId: string, missionId: number): Promise&lt;MissionInfo&gt;;
获取任务信息，以promise方式返回任务信息。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| [MissionInfo](js-apis-application-MissionInfo.md) | 任务信息。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var mission = await missionManager.getMissionInfo("", id).catch(function (err){
......@@ -164,22 +181,25 @@ function getMissionInfo(deviceId: string, missionId: number): Promise&lt;Mission
```
## getMissionInfos
## missionManager.getMissionInfos
function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback&lt;Array&lt;MissionInfo&gt;&gt;): void;
获取所有任务信息，以回调函数的方式返回任务信息数组。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| numMax | number | 是 | 任务信息数量上限。 |
| callback | AsyncCallback&lt;Array&lt;[MissionInfo](js-apis-application-MissionInfo.md)&gt;&gt; | 是 | 执行结果回调函数，返回任务信息数组。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -190,26 +210,30 @@ function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallba
```
## getMissionInfos
## missionManager.getMissionInfos
function getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;MissionInfo&gt;&gt;;
获取所有任务信息，以promise的方式返回任务信息数组。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| numMax | number | 是 | 任务信息数量上限。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Array&lt;MissionInfo&gt; | 任务信息数组。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
......@@ -218,22 +242,25 @@ function getMissionInfos(deviceId: string, numMax: number): Promise&lt;Array&lt;
```
## getMissionSnapShot
## missionManager.getMissionSnapShot
function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback&lt;MissionSnapshot&gt;): void;
获取任务快照，以回调函数的方式返回快照内容。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;[MissionSnapshot](js-apis-application-MissionSnapshot.md)&gt; | 是 | 执行结果回调函数，返回任务快照信息。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -250,26 +277,30 @@ function getMissionSnapShot(deviceId: string, missionId: number, callback: Async
```
## getMissionSnapShot
## missionManager.getMissionSnapShot
function getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;MissionSnapshot&gt;;
获取任务快照，以promise的方式返回快照内容。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
- 返回值：
| 类型 | 说明 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| MissionSnapshot | 任务快照信息。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
......@@ -284,21 +315,24 @@ function getMissionSnapShot(deviceId: string, missionId: number): Promise&lt;Mis
```
## lockMission
## missionManager.lockMission
function lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
锁定指定任务id的任务，以回调函数的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -314,20 +348,23 @@ function lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): vo
```
## lockMission
## missionManager.lockMission
function lockMission(missionId: number): Promise&lt;void&gt;;
锁定指定任务id的任务，以promise方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
......@@ -343,20 +380,23 @@ function lockMission(missionId: number): Promise&lt;void&gt;;
```
## unlockMission
## missionManager.unlockMission
function unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
解锁指定任务id的任务，以回调函数的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -372,20 +412,23 @@ function unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;):
```
## unlockMission
## missionManager.unlockMission
function unlockMission(missionId: number): Promise&lt;void&gt;;
解锁指定任务id的任务，以promise的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
......@@ -404,21 +447,24 @@ function unlockMission(missionId: number): Promise&lt;void&gt;;
```
## clearMission
## missionManager.clearMission
function clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
清理指定任务id的任务，无论该任务是否被锁定，以回调函数的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -434,20 +480,23 @@ function clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): v
```
## clearMission
## missionManager.clearMission
function clearMission(missionId: number): Promise&lt;void&gt;;
清理指定任务id的任务，无论该任务是否被锁定，以promise的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
......@@ -463,15 +512,17 @@ function clearMission(missionId: number): Promise&lt;void&gt;;
```
## clearAllMissions
## missionManager.clearAllMissions
function clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;
清理所有未锁定的任务，以回调函数的方式返回。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
```
**示例：**
```js
import missionManager from '@ohos.application.missionManager'
missionManager.clearAllMissions().then(() => {
......@@ -480,15 +531,17 @@ function clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;
```
## clearAllMissions
## missionManager.clearAllMissions
function clearAllMissions(): Promise&lt;void&gt;;
清理所有未锁定的任务，以promise的方式返回。
- 示例：
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
```
**示例：**
```js
import missionManager from '@ohos.application.missionManager'
await missionManager.clearAllMissions().catch(function (err){
console.log(err);
......@@ -496,21 +549,24 @@ function clearAllMissions(): Promise&lt;void&gt;;
```
## moveMissionToFront
## missionManager.moveMissionToFront
function moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
把指定任务id的任务切到前台，以回调函数的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -526,22 +582,25 @@ function moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&g
```
## moveMissionToFront
## missionManager.moveMissionToFront
function moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void;
把指定任务id的任务切到前台，同时指定任务切换到前台时的启动参数，例如窗口模式、设备ID等，以回调函数的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| options | StartOptions | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
......@@ -557,21 +616,24 @@ function moveMissionToFront(missionId: number, options: StartOptions, callback:
```
## moveMissionToFront
## missionManager.moveMissionToFront
function moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&gt;;
把指定任务id的任务切到前台，以promise的方式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| options | StartOptions | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
- 示例：
**示例：**
```
```js
import missionManager from '@ohos.application.missionManager'
var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
......
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @ fe8373c5
......@@ -16,9 +16,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>: v
使用此方法启动指定的particleAbility（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -57,16 +55,11 @@ particleAbility.startAbility(
## particleAbility.startAbility
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
startAbility(parameter: StartAbilityParameter): Promise\<number>
使用此方法启动指定的particleAbility（Promise形式）。
**系统能力:**
使用此方法启动指定的particleAbility（Promise形式）。
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -74,7 +67,9 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 类型 | 必填 | 描述 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是 | 指示启动的ability |
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
......@@ -111,9 +106,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
终止particleAbility（callback形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -140,11 +133,10 @@ terminateSelf(): Promise\<void>
终止particleAbility（Promise形式）。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
......@@ -166,9 +158,7 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
......@@ -194,67 +184,79 @@ particleAbility.acquireDataAbilityHelper(uri)
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## Want
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| action | 只读 | string | 否 | 表示action选项描述。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| action | 只读 | string | 否 | 表示action选项描述。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
## flags说明
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 <br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。<br><b>系统能力：</b>SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 <br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。<br/>**系统能力**：SystemCapability.Ability.AbilityBase |
## AbilityStartSetting
abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
使用时通过featureAbility.AbilityStartSetting获取，示例：featureAbility.AbilityStartSetting.BOUNDS_KEY。
使用时通过featureAbility.AbilityStartSetting获取。
**示例：**
```
featureAbility.AbilityStartSetting.BOUNDS_KEY。
```
| 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- |
| BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取，示例：featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
使用时通过featureAbility.AbilityWindowConfiguration获取。
**示例：**
```
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
```
| 名称 | 参数 | 描述 |
| --------------------------- | ---- | ---------- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FULLSCREEN | 1 | 全屏。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FLOATING | 102 | 悬浮窗。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_UNDEFINED | 0 | 未定义。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FULLSCREEN | 1 | 全屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FLOATING | 102 | 悬浮窗。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## particleAbility.startBackgroundRunning
......@@ -263,18 +265,18 @@ startBackgroundRunning(id: number, request: NotificationRequest, callback: Async
向系统申请长时任务，使用callback形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口）
**系统能力:**
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数：**
- **参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| id | number | 是 | 长时任务通知id号 |
| request | NotificationRequest | 是 | 通知参数，用于显示通知栏的信息 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
- **示例**：
**示例**：
```js
import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility';
......@@ -323,24 +325,25 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;void&gt;
**系统能力:**
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
向系统申请长时任务，使用promise形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口）
**参数**：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| id | number | 是 | 长时任务通知id号 |
| request | NotificationRequest | 是 | 通知参数，用于显示通知栏的信息 |
**返回值**
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
- **示例**：
**示例**：
```js
import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility';
......@@ -387,16 +390,16 @@ cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void;
向系统申请取消长时任务，使用callback形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口）
**系统能力:**
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数：**
- **参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
- **示例**：
**示例**：
```js
import particleAbility from '@ohos.ability.particleAbility';
......@@ -418,16 +421,16 @@ cancelBackgroundRunning(): Promise&lt;void&gt;;
向系统申请取消长时任务，使用promise形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口）
**系统能力:**
**系统能力**：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**返回值：**
**返回值**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
- **示例**：
**示例**：
```js
import particleAbility from '@ohos.ability.particleAbility';
......
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
浏览文件 @ fe8373c5
......@@ -11,5 +11,5 @@
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 否 | 用户传入的权限。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core|
| authResults | Array&lt;number&gt; | 是 | 否 | 相应请求权限的结果。0表示授权成功，-1表示失败。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| permissions | Array&lt;string&gt; | 是 | 否 | 用户传入的权限。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core|
| authResults | Array&lt;number&gt; | 是 | 否 | 相应请求权限的结果。0表示授权成功，-1表示失败。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md
浏览文件 @ fe8373c5
......@@ -14,7 +14,7 @@
```
```js
import appManager from '@ohos.application.appManager';
appManager.getProcessRunningInfos((error,data) => {
console.log("getProcessRunningInfos error: " + error.code + " data: " + JSON.stringify(data));
......@@ -26,7 +26,7 @@ appManager.getProcessRunningInfos((error,data) => {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| pid | number | 是 | 否 | 进程ID。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| uid | number | 是 | 否 | 用户ID。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| processName | string | 是 | 否 | 进程名称。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| bundleNames | Array&lt;string&gt; | 是 | 否 | 进程中所有运行的包名称。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| pid | number | 是 | 否 | 进程ID。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| uid | number | 是 | 否 | 用户ID。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| processName | string | 是 | 否 | 进程名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| bundleNames | Array&lt;string&gt; | 是 | 否 | 进程中所有运行的包名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md
浏览文件 @ fe8373c5
......@@ -9,25 +9,22 @@ ServiceExtension的上下文环境，提供ServiceExtension具有的能力和接
## startAbility
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
启动Ability。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
```
**示例：**
```js
let want = {
"bundleName": "com.example.myapp",
"abilityName": "com.example.myapp.MyAbility"
......@@ -38,28 +35,29 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbility
## ServiceExtensionContext.startAbility
startAbility(want: Want): Promise&lt;void&gt;;
启动Ability。通过Promise返回结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
- 示例：
```
**示例：**
```js
let want = {
"bundleName": "com.example.myapp",
"abilityName": "com.example.myapp.MyAbility"
......@@ -72,46 +70,46 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelf
## ServiceExtensionContext.terminateSelf
terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
停止Ability自身。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
```
**示例：**
```js
this.context.terminateSelf((err) => {
console.log('terminateSelf result:' + JSON.stringfy(err));
});
```
## terminateSelf
## ServiceExtensionContext.terminateSelf
terminateSelf(): Promise&lt;void&gt;;
停止自身。通过Promise返回结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
- 示例：
```
**示例：**
```js
this.context.terminateSelf(want).then((data) => {
console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
......@@ -120,29 +118,30 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## connectAbility
## ServiceExtensionContext.connectAbility
connectAbility(want: Want, options: ConnectOptions): number;
将一个Ability与服务类型的Ability绑定。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回一个number，后续根据这个number去断开连接。 |
- 示例：
```
**示例：**
```js
let want = {
"bundleName": "com.example.myapp",
"abilityName": "com.example.myapp.MyAbility"
......@@ -156,52 +155,53 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## disconnectAbility
## ServiceExtensionContext.disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void;
将一个Ability与绑定的服务类型的Ability解绑。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数，返回接口调用是否成功的结果。 |
- 示例：
```
**示例：**
```js
this.context.disconnectAbility(connection, (err) => { // connection为connectAbility中的返回值
console.log('terminateSelf result:' + JSON.stringfy(err));
});
```
## disconnectAbility
## ServiceExtensionContext.disconnectAbility
disconnectAbility(connection: number): Promise&lt;void&gt;;
将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
- 示例：
```
**示例：**
```js
this.context.disconnectAbility(connection).then((data) => { // connection为connectAbility中的返回值
console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
......@@ -216,6 +216,6 @@ ConnectOptions数据结构。
| 名称 | 说明 |
| -------- | -------- |
| onConnect(elementName:ElementName,&nbsp;remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| onFailed(code:&nbsp;number) | 连接失败时回调该接口。<br><b>系统能力：</b>SystemCapability.Ability.AbilityRuntime.Core |
| onConnect(elementName:ElementName,&nbsp;remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| onFailed(code:&nbsp;number) | 连接失败时回调该接口。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-service-extension.md
浏览文件 @ fe8373c5
......@@ -23,7 +23,7 @@ import ServiceExtension from '@ohos.application.ServiceExtension';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 |
| context | [ServiceExtensionContext](js-apis-service-extension-context.md) | 是 | 否 | ServiceExtension的上下文环境，继承自ExtensionContext。 <br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core|
## onCreate
......@@ -32,17 +32,17 @@ onCreate(want: Want): void;
Extension生命周期回调，在创建时回调，执行初始化业务逻辑操作。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
- 示例：
```
**示例：**
```js
class ServiceExt extends ServiceExtension {
onCreate(want) {
console.log('onCreate, want:' + want.abilityName);
......@@ -57,12 +57,11 @@ onDestroy(): void;
Extension生命周期回调，在销毁时回调，执行资源清理等操作。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**示例：**
- 示例：
```
```js
class ServiceExt extends ServiceExtension {
onDestroy() {
console.log('onDestroy');
......@@ -77,18 +76,18 @@ onRequest(want: Want, startId: number): void;
Extension生命周期回调，如果是startAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1，多次之后自动递增。 |
- 示例：
```
**示例：**
```js
class ServiceExt extends ServiceExtension {
onRequest(want, startId) {
console.log('onRequest, want:' + want.abilityName);
......@@ -103,22 +102,23 @@ onConnect(want: Want): rpc.RemoteObject;
Extension生命周期回调，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于和客户端进行通信。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| rpc.RemoteObject | 一个RemoteObject对象，用于和客户端进行通信。 |
- 示例：
```
**示例：**
```js
import rpc from '@ohos.rpc'
class StubTest extends rpc.RemoteObject{
constructor(des) {
......@@ -142,17 +142,17 @@ onDisconnect(want: Want): void;
Extension的生命周期，断开服务连接时回调。
**系统能力:**
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数：**
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 |
- 示例：
```
**示例：**
```js
class ServiceExt extends ServiceExtension {
onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName);
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或