Skip to content

D
Docs

OpenHarmony / Docs
接近 2 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 ddfff641 编写于 作者: Y yuyaozhi
浏览文件
操作

Fix missing docunment interface of ability 

Signed-off-by: Nyuyaozhi <yuyaozhi@huawei.com>
上级 c3659cde
隐藏空白更改
内联 并排
Showing with 1225 addition and 242 deletion
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ ddfff641
# Context模块
Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等并且只能通过ability获得。
Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等。
> **说明：**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在FA模型下使用。
## 导入模块
```js
import featureAbility from '@ohos.ability.featureAbility'
```
## 使用说明
Context对象是在featureAbility中创建实例，并通过featureAbility的getContext()接口返回，因此在使用Context时，必须导入@ohos.ability.featureAbility库。示例如下：
......
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @ ddfff641
......@@ -9,11 +9,6 @@ AbilityContext模块提供允许访问特定于ability的资源的能力，包
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```js
import Ability from '@ohos.application.Ability'
```
## 使用说明
在使用AbilityContext的功能前，需要通过Ability子类实例获取。
......@@ -27,7 +22,6 @@ class MainAbility extends Ability {
}
```
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......@@ -36,7 +30,7 @@ class MainAbility extends Ability {
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
| config | [Configuration](js-apis-configuration.md) | 是 | 否 | 表示配置信息。 |
## AbilityContext.startAbility
......@@ -46,6 +40,8 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -75,6 +71,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -108,6 +106,8 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -237,6 +237,128 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityRes
})
```
## AbilityContext.startAbilityForResultWithAccount
startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback<AbilityResult>): void;
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数，返回Ability结果。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
this.context.startAbilityWithAccount(want, accountId, (err, data) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
console.log('---------- startAbilityWithAccount success, data: -----------', data);
});
```
## AbilityContext.startAbilityForResultWithAccount
startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0,
};
this.context.startAbilityForResultWithAccount(want, accountId, options, (err) => {
console.log('---------- startAbilityForResultWithAccount fail, err: -----------', err);
});
```
## AbilityContext.startAbilityForResultWithAccount
startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<AbilityResult\>;
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;AbilityResult&gt; | 返回一个Promise，包含Ability结果。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0,
};
this.context.startAbilityForResultWithAccount(want, accountId, options)
.then((data) => {
console.log('---------- startAbilityForResultWithAccount success, data: -----------', data);
})
.catch((err) => {
console.log('---------- startAbilityForResultWithAccount fail, err: -----------', err);
})
```
## AbilityContext.terminateSelf
......@@ -348,6 +470,149 @@ terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
)
```
## AbilityContext.connectAbility
connectAbility(want: Want, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板将当前能力连接到一个能力。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 否 | 远端对象实例。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') }
}
const result = this.context.connectAbility(want, options);
console.log('----------- connectAbilityResult: ------------', result);
```
## AbilityContext.connectAbilityWithAccount
connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板和account将当前能力连接到一个能力。
**需要权限：** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 否 | 远端对象实例。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') }
}
const result = this.context.connectAbilityWithAccount(want, accountId, options);
console.log('----------- connectAbilityResult: ------------', result);
```
## AbilityContext.disconnectAbility
disconnectAbility(connection: number): Promise\<void>;
已成功连接接口。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 连接的能力的数字代码。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |
**示例：**
```js
var connectionNumber = 0;
this.context.disconnectAbility(connectionNumber).then((data) => {
console.log('disconnectAbility success, data: ', data);
}).catch((err) => {
console.log('disconnectAbility fail, err: ', err);
});
```
## AbilityContext.disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void;
已成功连接接口。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 连接的能力的数字代码。 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |
**示例：**
```js
var connectionNumber = 0;
this.context.disconnectAbility(connectionNumber, (err) => {
console.log('---------- disconnectAbility fail, err: -----------', err);
});
```
## AbilityContext.startAbilityByCall
......@@ -390,6 +655,120 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
}
```
## AbilityContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void\>): void;
根据account启动Ability（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
this.context.startAbilityWithAccount(want, accountId, (err) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
});
```
## AbilityContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;
根据account启动Ability（callback形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0,
};
this.context.startAbilityWithAccount(want, accountId, options, (err) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
});
```
## AbilityContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<void\>;
根据account启动Ability（Promise形式）。
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0,
};
this.context.startAbilityWithAccount(want, accountId, options)
.then((data) => {
console.log('---------- startAbilityWithAccount success, data: -----------', data);
})
.catch((err) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
})
```
## AbilityContext.requestPermissionsFromUser
......@@ -503,6 +882,117 @@ setMissionLabel(label: string): Promise&lt;void&gt;
console.log('failed:' + JSON.stringify(error));
});
```
## AbilityContext.setMissionIcon
setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;
设置当前ability的任务标签。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的能力图标。 |
| callback | AsyncCallback\<void> | 是 | 指定的回调函数的结果。 |
**示例：**
```js
import image from '@ohos.multimedia.image'
var imagePixelMap;
var color = new ArrayBuffer(0);
var initializationOptions = {
size: {
height: 100,
width: 100
}
};
image.createPixelMap(color, initializationOptions)
.then((data) => {
imagePixelMap = data;
})
.catch((err) => {
console.log('--------- createPixelMap fail, err: ---------', err)
});
this.context.setMissionIcon(imagePixelMap, (err) => {
console.log('---------- setMissionIcon fail, err: -----------', err);
})
```
## AbilityContext.setMissionIcon
setMissionIcon(icon: image.PixelMap): Promise\<void>;
设置当前ability的任务标签。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的能力图标。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise，包含接口的结果。 |
**示例：**
```js
import image from '@ohos.multimedia.image'
var imagePixelMap;
var color = new ArrayBuffer(0);
var initializationOptions = {
size: {
height: 100,
width: 100
}
};
image.createPixelMap(color, initializationOptions)
.then((data) => {
imagePixelMap = data;
})
.catch((err) => {
console.log('--------- createPixelMap fail, err: ---------', err)
});
this.context.setMissionIcon(imagePixelMap)
.then((data) => {
console.log('-------------- setMissionIcon success, data: -------------', data);
})
.catch((err) => {
console.log('-------------- setMissionIcon fail, err: -------------', err);
});
```
## AbilityContext.restoreWindowStage
restoreWindowStage(localStorage: LocalStorage) : void;
恢复ability中的window stage数据。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 |
**示例：**
```js
var storage = new LocalStorage();
this.context.restoreWindowStage(storage);
```
## AbilityContext.isTerminating
......
zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md
浏览文件 @ ddfff641
......@@ -14,61 +14,63 @@ import wantConstant from '@ohos.ability.wantConstant'
## wantConstant.Action
**系统能力**：SystemCapability.Ability.AbilityBase
want操作的常数。
权限列表。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 |
| 名称 | 值 | 描述 |
| ------------ | ------------------ | ---------------------- |
| ACTION_HOME | ohos.want.action.home | 无 |
| ACTION_DIAL | ohos.want.action.dial | 无 |
| ACTION_SEARCH | ohos.want.action.search | 无 |
| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 无 |
| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 无 |
| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 无 |
| ACTION_SET_ALARM | ohos.want.action.setAlarm | 无 |
| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 无 |
| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 无 |
| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 无 |
| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 无 |
| ACTION_SEND_SMS | ohos.want.action.sendSms | 无 |
| ACTION_CHOOSE | ohos.want.action.choose | 无 |
| ACTION_IMAGE_CAPTURE<sup>8+</sup> | ohos.want.action.imageCapture | 无 |
| ACTION_VIDEO_CAPTUR<sup>8+</sup> | ohos.want.action.videoCapture | 无 |
| ACTION_SELECT | ohos.want.action.select | 无 |
| ACTION_SEND_DATA | ohos.want.action.sendData | 无 |
| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 无 |
| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | 无 |
| ACTION_VIEW_DATA | ohos.want.action.viewData | 无 |
| ACTION_EDIT_DATA | ohos.want.action.editData | 无 |
| INTENT_PARAMS_INTENT | ability.want.params.INTENT | 无 |
| INTENT_PARAMS_TITLE | ability.want.params.TITLE | 无 |
| ACTION_FILE_SELECT<sup>7+</sup> | ohos.action.fileSelect | 无 |
| PARAMS_STREAM<sup>7+</sup> | ability.params.stream | 无 |
| ACTION_APP_ACCOUNT_OAUTH <sup>8+</sup> | ohos.account.appAccount.action.oauth | 无 |
| ACTION_HOME | ohos.want.action.home | 指示返回原点的操作。 |
| ACTION_DIAL | ohos.want.action.dial | 指示启动显示小键盘的页面功能的操作 |
| ACTION_SEARCH | ohos.want.action.search | 指示启动页面搜索功能的操作。 |
| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 指示启动提供无线网络设置的页面功能的操作，例如，Wi-Fi选项。 |
| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 指示启动管理已安装应用程序的页面功能的操作。 |
| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 指示启动显示指定应用程序详细信息的页面功能的操作。 |
| ACTION_SET_ALARM | ohos.want.action.setAlarm | 指示启动页面功能以设置闹钟的操做作。 |
| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 指示启动显示所有警报的页面功能的操作时钟。 |
| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 指示启动用于使闹钟睡眠的页面功能的操作。 |
| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 指示启动删除闹钟的页面功能的操作。 |
| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 指示启动页面功能以关闭计时器的操作。 |
| ACTION_SEND_SMS | ohos.want.action.sendSms | 指示启动发送sms的页面功能的操作。 |
| ACTION_CHOOSE | ohos.want.action.choose | 指示启动页面功能以打开联系人或图片的操作。 |
| ACTION_IMAGE_CAPTURE<sup>8+</sup> | ohos.want.action.imageCapture | 指示启动页面拍照功能的操作。 |
| ACTION_VIDEO_CAPTUR<sup>8+</sup> | ohos.want.action.videoCapture | 指示启动页面功能以拍摄视频的操作。 |
| ACTION_SELECT | ohos.want.action.select | 指示显示应用程序选择对话框的操作。 |
| ACTION_SEND_DATA | ohos.want.action.sendData | 指示发送单个数据记录的操作。 |
| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 指示发送多个数据记录的操作。 |
| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | 指示请求媒体扫描仪扫描文件并将文件添加到媒体库的操作。 |
| ACTION_VIEW_DATA | ohos.want.action.viewData | 指示查看数据的操作。 |
| ACTION_EDIT_DATA | ohos.want.action.editData | 指示编辑数据的操作。 |
| INTENT_PARAMS_INTENT | ability.want.params.INTENT | 指示将使用连接选取显示的选项的操作。 |
| INTENT_PARAMS_TITLE | ability.want.params.TITLE | 指示与连接选取显示的选项一起使用时的字符序列对话框标题。 |
| ACTION_FILE_SELECT<sup>7+</sup> | ohos.action.fileSelect | 指示选择文件的操作。 |
| PARAMS_STREAM<sup>7+</sup> | ability.params.stream | 指示与连接发送数据一起使用时，包含与意图相关联的数据流的URI。 |
| ACTION_APP_ACCOUNT_OAUTH <sup>8+</sup> | ohos.account.appAccount.action.oauth | 指示提供oauth服务的操作。 |
| ACTION_MARKER_DOWNLOAD | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的行为。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
## wantConstant.Entity
**系统能力**：SystemCapability.Ability.AbilityBase
want实体的常数。
权限列表。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 系统公共事件宏 | 系统公共事件名称 | 订阅者所需权限 |
| 名称 | 值 | 描述 |
| ------------ | ------------------ | ---------------------- |
| ENTITY_DEFAULT | entity.system.default | 无 |
| ENTITY_HOME | entity.system.homel | 无 |
| ENTITY_VOICE | ENTITY_VOICE | 无 |
| ENTITY_BROWSABLE | entity.system.browsable | 无 |
| ENTITY_VIDEO | entity.system.video | 无 |
| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 无 |
| ENTITY_DEFAULT | entity.system.default | 指示默认实体，如果未指定该实体，则使用该实体。 |
| ENTITY_HOME | entity.system.homel | 指示主屏幕实体。 |
| ENTITY_VOICE | entity.system.voice | 表示语音交互实体。 |
| ENTITY_BROWSABLE | entity.system.browsable | 指示浏览器类别。 |
| ENTITY_VIDEO | entity.system.video | 指示视频类别。 |
## wantConstant.Flags
## flags说明
Flags说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数 | 描述 |
| 名称 | 值 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
......@@ -76,10 +78,10 @@ import wantConstant from '@ohos.ability.wantConstant'
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
......
zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md
浏览文件 @ ddfff641
......@@ -26,8 +26,6 @@ Ability生命周期状态。
| BACKGROUND | 3 | 表示Ability处于后台状态。 |
| DESTROY | 4 | 表示Ability处于已销毁状态。 |
## AbilityDelegatorRegistry.getAbilityDelegator
getAbilityDelegator(): AbilityDelegator
......
zh-cn/application-dev/reference/apis/js-apis-abilityManager.md
浏览文件 @ ddfff641
......@@ -29,7 +29,6 @@ Ability的状态信息。
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 |
## updateConfiguration
updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
......
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @ ddfff641
......@@ -6,12 +6,6 @@ AbilityRunningInfo模块提供对Ability运行的相关信息和状态进行设
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import abilitymanager from '@ohos.application.abilityManager';
```
## 使用说明
通过abilityManager中getAbilityRunningInfos方法获取。
......@@ -36,21 +30,4 @@ abilitymanager.getAbilityRunningInfos((err,data) => {
| uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Ability启动时间。 |
| abilityState | [abilityManager.AbilityState](#abilitymanagerabilitystate) | 是 | 否 | Ability状态。 |
## abilityManager.AbilityState
Ability的状态信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。|
| FOREGROUND | 9 | 表示ability为foreground状态。 |
| BACKGROUND | 10 | 表示ability为background状态。 |
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 |
| abilityState | [abilityManager.AbilityState](js-apis-abilityManager.md#abilityState) | 是 | 否 | Ability状态。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
浏览文件 @ ddfff641
......@@ -9,12 +9,6 @@ AbilityStageContext提供允许访问特定于abilityStage的资源的能力，
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```js
import AbilityStage from '@ohos.application.AbilityStage';
```
## 使用说明
通过AbilityStage实例来获取。
......
zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md
浏览文件 @ ddfff641
# MissionSnapshot
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
任务对应的任务快照。
## 导入模块
MissionSnapshot模块提供设置与任务对应的任务快照的任务元素名称的能力。
```
import missionManager from '@ohos.application.missionManager'
```
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口均为系统接口，三方应用不支持调用
## 使用说明
使用前需要提前引入对应模块。
通过missionManager中的getMissionSnapShot来获取。
```
```js
import ElementName from '@ohos.bundle';
import image from '@ohos.multimedia.image';
import missionManager from '@ohos.application.missionManager'
missionManager.getMissionInfos("", 10, (error, missions) => {
console.log("getMissionInfos is called, error.code = " + error.code);
console.log("size = " + missions.length);
console.log("missions = " + JSON.stringify(missions));
var id = missions[0].missionId;
missionManager.getMissionSnapShot("", id, (error, snapshot) => {
console.log("getMissionSnapShot is called, error.code = " + error.code);
console.log("bundleName = " + snapshot.ability.bundleName);
})
})
```
## MissionSnapshot
表示任务对应的任务快照的枚举。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 是 | 表示Ability任务元素名称。 |
| snapshot | [image.PixelMap](js-apis-image.md) | 是 | 是 | 表示任务快照。 |
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ ddfff641
......@@ -29,8 +29,6 @@ import Ability from '@ohos.application.Ability';
| lastRequestWant | [Want](js-apis-application-Want.md) | 是 | 否 | Ability最后请求时的参数。|
| callee | [Callee](#callee) | 是 | 否 | 调用Stub（桩）服务对象。|
## Ability.onCreate
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md
浏览文件 @ ddfff641
......@@ -6,10 +6,16 @@ AbilityDelegator提供添加用于监视指定能力的生命周期状态更改
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
## 使用说明
通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。
```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
```
## AbilityDelegator
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md
浏览文件 @ ddfff641
......@@ -6,10 +6,14 @@ AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
## 使用说明
通过AbilityDelegatorRegistry中getArguments方法获取。
```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var args = AbilityDelegatorRegistry.getArguments();
```
## AbilityDelegatorArgs
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md
浏览文件 @ ddfff641
......@@ -6,10 +6,27 @@ AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
## 使用说明
通过abilityDelegator中的addAbilityMonitor来设置。
```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator;
function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}
var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
console.info("addAbilityMonitor callback");
});
```
## AbilityMonitor
......
zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md
浏览文件 @ ddfff641
......@@ -7,12 +7,6 @@ ApplicationContext模块提供开发者应用级别的的上下文的能力，
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
import Ability from '@ohos.application.Ability';
```
## 使用说明
在使用ApplicationContext的功能前，需要通过context的实例获取。
......
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @ ddfff641
......@@ -9,15 +9,20 @@ Context模块提供开发者运行代码的上下文环境的能力，包括查
提供开发者运行代码的上下文环境，包括应用信息、ResourceManager等信息。
## 导入模块
```
import AbilityContext from '@ohos.application.Ability';
```
## 使用说明
通过AbilityContext等继承实现。
```js
import AbilityContext from '@ohos.application.Ability'
class MainAbility extends AbilityContext {
onWindowStageCreate(windowStage) {
let test = "com.example.test";
let context = this.context.createBundleContext(test);
}
}
```
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......@@ -30,12 +35,11 @@ import AbilityContext from '@ohos.application.Ability';
| tempDir | string | 是 | 否 | 应用的临时文件路径。 |
| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。 |
| databaseDir | string | 是 | 否 | 获取本地数据存储路径。 |
| storageDir | string | 是 | 否 | 获取轻量级数据存储路径。 |
| bundleCodeDir | string | 是 | 否 | 应用安装路径。 |
| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。 |
| eventHub | [EventHub](js-apis-eventhub.md) | 是 | 否 | 事件中心信息。|
| area | [AreaMode](#areamode) | 是 | 是 | 文件分区。|
| preferencesDir | string | 是 | 是 | 指示应用程序首选项目录。|
## Context.createBundleContext
......
zh-cn/application-dev/reference/apis/js-apis-application-missionInfo.md 已删除 100644 → 0
浏览文件 @ c3659cde
# MissionInfo
MissionInfo模块提供对与Ability相对应的任务信息进行设置和查询的能力。
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import MissionInfo from '@ohos.application.missionInfo'
```
## MissionInfo
表示Ability对应任务信息的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。|
| runningState | number | 是 | 是 | 表示运行状态。 |
| lockedState | boolean | 是 | 是 | 表示锁定状态。 |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 |
| want | [Want](js-apis-application-Want.md) | 是 | 是 | 表示任务的Want信息。 |
| label | string | 是 | 是 | 表示任务的标签。 |
| iconPath | string | 是 | 是 | 表示任务的图标路径。 |
| continuable | boolean | 是 | 是 | 表示任务是否可以继续。 |
zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md
浏览文件 @ ddfff641
......@@ -6,16 +6,28 @@ ShellCmdResult模块提供Shell命令执行结果的能力。
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
## 使用说明
通过abilityDelegator中的executeShellCommand方法来获取。
```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator;
var cmd = "cmd";
var timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
console.info("executeShellCommand promise");
});
```
## ShellCmdResult
Shell命令执行结果
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | ---- | ---- | ------------------------------------------------------------ |
| stdResult | string | 是 | 是 | 标准输出内容<br/>**系统能力：** SystemCapability.Ability.AbilityRuntime.Core |
......
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
浏览文件 @ ddfff641
......@@ -6,8 +6,6 @@ appManager模块提供服务功能的能力，包括查询当前是否处于稳
>
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
App管理。
## 导入模块
```js
......@@ -208,6 +206,388 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
})
```
## appManager.registerApplicationStateObserver<sup>8+</sup>
registerApplicationStateObserver(observer: ApplicationStateObserver): number;
注册应用程序状态观测器。
**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| observer | ApplicationStateObserver | 否 | 返回观察者的数字代码。 |
**示例：**
```js
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
}
}
const observerCode = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
```
## appManager.unregisterApplicationStateObserver<sup>8+</sup>
unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\<void>): void;
取消注册应用程序状态观测器。
**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| observerId | number | 否 | 表示观察者的编号代码。 |
| callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：**
```js
var observerId = 100;
function unregisterApplicationStateObserverCallback(err) {
if (err) {
console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
}
}
app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);
```
## appManager.unregisterApplicationStateObserver<sup>8+</sup>
unregisterApplicationStateObserver(observerId: number): Promise\<void>;
取消注册应用程序状态观测器。
**需要权限**：ohos.permission.RUNNING_STATE_OBSERVER
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| observerId | number | 否 | 表示观察者的编号代码。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |
**示例：**
```js
var observerId = 100;
app.unregisterApplicationStateObserver(observerId)
.then((data) => {
console.log('----------- unregisterApplicationStateObserver success ----------', data);
})
.catch((err) => {
console.log('----------- unregisterApplicationStateObserver fail ----------', err);
})
```
## appManager.getForegroundApplications<sup>8+</sup>
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台进程的应用程序。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<AppStateData>> | 否 | 表示应用的状态数据。 |
**示例：**
```js
function getForegroundApplicationsCallback(err, data) {
if (err) {
console.log('--------- getForegroundApplicationsCallback fail ---------', err);
} else {
console.log('--------- getForegroundApplicationsCallback success ---------', data)
}
}
app.getForegroundApplications(getForegroundApplicationsCallback);
```
## appManager.getForegroundApplications<sup>8+</sup>
getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
获取前台进程的应用程序。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 返回进程运行信息的数组。 |
**示例：**
```js
app.getForegroundApplications()
.then((data) => {
console.log('--------- getForegroundApplications success -------', data);
})
.catch((err) => {
console.log('--------- getForegroundApplications fail -------', err);
})
```
## appManager.killProcessWithAccount<sup>8+</sup>
killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>
切断account进程（Promise形式）。
**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 应用包名。 |
| accountId | number | 是 | account的Id。 |
**示例：**
```js
var bundleName = 'bundleName';
var accountId = 0;
app.killProcessWithAccount(bundleName, accountId)
.then((data) => {
console.log('------------ killProcessWithAccount success ------------', data);
})
.catch((err) => {
console.log('------------ killProcessWithAccount fail ------------', err);
})
```
## appManager.killProcessWithAccount<sup>8+</sup>
killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\<void\>): void
切断account进程（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 应用包名。 |
| accountId | number | 是 | account的Id。 |
| callback | AsyncCallback\<void\> | 是 | 切断account进程的回调函数。 |
**示例：**
```js
var bundleName = 'bundleName';
var accountId = 0;
function killProcessWithAccountCallback(err, data) {
if (err) {
console.log('------------- killProcessWithAccountCallback fail, err: --------------', err);
} else {
console.log('------------- killProcessWithAccountCallback success, data: --------------', data);
}
}
app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);
```
## appManager.killProcessesByBundleName<sup>8+</sup>
killProcessesByBundleName(bundleName: string, callback: AsyncCallback\<void>);
通过包名终止进程。
**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 否 | 表示包名。 |
| callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：**
```js
var bundleName = 'bundleName';
function killProcessesByBundleNameCallback(err, data) {
if (err) {
console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
} else {
console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
}
}
app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
```
## appManager.killProcessesByBundleName<sup>8+</sup>
killProcessesByBundleName(bundleName: string): Promise\<void>;
通过包名终止进程。
**需要权限**：ohos.permission.CLEAN_BACKGROUND_PROCESSES
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 否 | 表示包名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |
**示例：**
```js
var bundleName = 'bundleName';
app.killProcessesByBundleName(bundleName)
.then((data) => {
console.log('------------ killProcessesByBundleName success ------------', data);
})
.catch((err) => {
console.log('------------ killProcessesByBundleName fail ------------', err);
})
```
## appManager.clearUpApplicationData<sup>8+</sup>
clearUpApplicationData(bundleName: string, callback: AsyncCallback<void>);
通过包名清除应用数据。
**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 否 | 表示包名。 |
| callback | AsyncCallback\<void> | 否 | 表示指定的回调方法。 |
**示例：**
```js
var bundleName = 'bundleName';
function clearUpApplicationDataCallback(err, data) {
if (err) {
console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err);
} else {
console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
}
}
app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
```
## appManager.clearUpApplicationData<sup>8+</sup>
clearUpApplicationData(bundleName: string): Promise<void>;
通过包名清除应用数据。
**需要权限**：ohos.permission.CLEAN_APPLICATION_DATA
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 否 | 表示包名。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |
**示例：**
```js
var bundleName = 'bundleName';
app.clearUpApplicationData(bundleName)
.then((data) => {
console.log('------------ clearUpApplicationData success ------------', data);
})
.catch((err) => {
console.log('------------ clearUpApplicationData fail ------------', err);
})
```
## ProcessRunningInfo
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @ ddfff641
......@@ -5,12 +5,6 @@
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在FA模型下使用。
## 导入模块
```js
import featureAbility from "@ohos.ability.featureAbility";
```
## 使用说明
使用前根据具体情况引入如下模块
......
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
浏览文件 @ ddfff641
......@@ -7,12 +7,6 @@ EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```js
import Ability from '@ohos.application.Ability'
```
## 使用说明
​在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。
......
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
浏览文件 @ ddfff641
......@@ -9,14 +9,6 @@ ExtensionContext模块提供扩展的上下文的能力，包括允许访问特
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
Extension的上下文环境，继承自Context。
## 导入模块
```js
import FormExtension from '@ohos.application.FormExtension';
```
## 属性
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md
浏览文件 @ ddfff641
......@@ -5,13 +5,7 @@ ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import abilitymanager from '@ohos.application.abilityManager';
```
> 本模块接口均为系统接口，三方应用不支持调用
## 使用说明
......@@ -25,8 +19,7 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => {
});
```
### 属性
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ ddfff641
......@@ -216,7 +216,6 @@ featureAbility.startAbilityForResult(
mykey7: true,
},
},
requestCode: 2,
},
).then((data) => {
console.info("==========================>startAbilityForResult=======================>");
......@@ -507,9 +506,11 @@ connectAbility(request: Want, options:ConnectOptions): number
| 名称 | 类型 | 必填 | 描述 |
| ------- | -------------- | ---- | --------------------- |
| request | [Want](js-apis-application-Want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
| options | [ConnectOptions](#connectoptions) | 是 | 被指定的回调方法。 |
**Want类型说明：**
## Want
want类型说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
......@@ -519,7 +520,9 @@ connectAbility(request: Want, options:ConnectOptions): number
| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名。 |
| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名。 |
**ConnectOptions类型说明：**
## ConnectOptions
ConnectOptions类型说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......@@ -937,10 +940,10 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
......
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md
浏览文件 @ ddfff641
......@@ -9,11 +9,9 @@ FormExtensionContext模块提供FormExtension具有的接口和能力。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
## 使用说明
```js
import FormExtension from '@ohos.application.FormExtension';
```
FormExtensionContext模块是FormExtension的上下文环境，继承自ExtensionContext。
## FormExtensionContext.updateForm
......
zh-cn/application-dev/reference/apis/js-apis-formhost.md
浏览文件 @ ddfff641
......@@ -857,7 +857,7 @@ acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&g
获取卡片状态
**需要权限**：ohos.permission.REQUIRE_FORM和ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**需要权限**：ohos.permission.REQUIRE_FORM and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED.
**系统能力**：SystemCapability.Ability.Form
......
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
浏览文件 @ ddfff641
......@@ -7,12 +7,6 @@ PermissionRequestResult模块提供了权限请求结果的能力。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```js
import Ability from '@ohos.application.Ability'
```
## 使用说明
通过AbilityContext实例来获取。
......
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md
浏览文件 @ ddfff641
......@@ -6,12 +6,6 @@ ProcessRunningInfo模块提供对进程运行信息进行设置和查询的能
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import appManager from '@ohos.application.appManager'
```
## 使用说明
通过appManager来获取。
......@@ -23,7 +17,6 @@ appManager.getProcessRunningInfos((error,data) => {
});
```
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
......
zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md
浏览文件 @ ddfff641
......@@ -198,11 +198,13 @@ onReconnect(want: Want): void;
}
```
## ServiceExtensionAbility.onReconnect
## ServiceExtensionAbility.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
......@@ -213,7 +215,7 @@ onConfigurationUpdated(config: Configuration): void;
**示例：**
```js
class myAbility extends Ability {
class ServiceExt extends ServiceExtension {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
......@@ -226,7 +228,9 @@ dump(params: Array\<string>): Array\<string>;
转储客户端信息时调用。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
......@@ -237,7 +241,7 @@ dump(params: Array\<string>): Array\<string>;
**示例：**
```js
class myAbility extends Ability {
class ServiceExt extends ServiceExtension {
dump(params) {
console.log('dump, params:' + JSON.stringify(params));
return ["params"]
......
zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md
浏览文件 @ ddfff641
......@@ -9,11 +9,19 @@ ServiceExtensionContext模块提供ServiceExtension具有的能力和接口，
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
## 使用说明
```
import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
```
ServiceExtensionContext模块是ServiceExtension的上下文环境，继承自ExtensionContext。
## 属性
表示访问应用程序资源的能力。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| resourceManager | resmgr.ResourceManager; | 是 | 否 | ResourceManager对象。 |
## startAbility
......@@ -49,8 +57,7 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
```
## ServiceExtensionContext.startAbility
## startAbility
startAbility(want: Want): Promise&lt;void&gt;;
......@@ -89,8 +96,149 @@ startAbility(want: Want): Promise&lt;void&gt;;
});
}
}
```
## startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void
启动Ability。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var options = {
windowMode: 0,
};
this.context.startAbility(want, options, (error) => {
console.log("error.code = " + error.code)
})
```
## ServiceExtensionContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void\>): void;
根据account启动Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
this.context.startAbilityWithAccount(want, accountId, (err) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
});
```
## ServiceExtensionContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;
根据account启动Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0,
};
this.context.startAbilityWithAccount(want, accountId, options, (err) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
});
```
## ServiceExtensionContext.startAbilityWithAccount
startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<void\>;
根据account启动Ability（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
windowMode: 0,
};
this.context.startAbilityWithAccount(want, accountId, options)
.then((data) => {
console.log('---------- startAbilityWithAccount success, data: -----------', data);
})
.catch((err) => {
console.log('---------- startAbilityWithAccount fail, err: -----------', err);
})
```
......@@ -158,7 +306,6 @@ terminateSelf(): Promise&lt;void&gt;;
```
## ServiceExtensionContext.connectAbility
connectAbility(want: Want, options: ConnectOptions): number;
......@@ -174,7 +321,7 @@ connectAbility(want: Want, options: ConnectOptions): number;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 |
| options | [ConnectOptions](#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 |
| options | [ConnectOptions](js-apis-featureAbility.md#connectoptions) | 是 | ConnectOptions类型的回调函数，返回服务连接成功、断开或连接失败后的信息。 |
**返回值：**
......@@ -197,6 +344,47 @@ connectAbility(want: Want, options: ConnectOptions): number;
let connection = this.context.connectAbility(want,options);
```
## ServiceExtensionContext.connectAbilityWithAccount
connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板和account将当前能力连接到一个能力。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 需要启动的accountId。 |
| options | ConnectOptions | 否 | 远端对象实例。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
**示例：**
```js
var want = {
"deviceId": "",
"bundleName": "com.extreme.test",
"abilityName": "MainAbility"
};
var accountId = 100;
var options = {
onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
onFailed(code) { console.log('----------- onFailed -----------') }
}
const result = this.context.connectAbilityWithAccount(want, accountId, options);
console.log('----------- connectAbilityResult: ------------', result);
```
## ServiceExtensionContext.disconnectAbility
......@@ -229,10 +417,8 @@ disconnectAbility(connection: number, callback:AsyncCallback&lt;void&gt;): void;
}
}
```
## ServiceExtensionContext.disconnectAbility
disconnectAbility(connection: number): Promise&lt;void&gt;;
......@@ -270,17 +456,4 @@ disconnectAbility(connection: number): Promise&lt;void&gt;;
}
}
```
## ConnectOptions
ConnectOptions数据结构。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 说明 |
| -------- | -------- |
| onConnect(elementName:ElementName,&nbsp;remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 |
| onFailed(code:&nbsp;number) | 连接失败时回调该接口。 |
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-testRunner.md
浏览文件 @ ddfff641
......@@ -14,8 +14,6 @@ TestRunner模块提供了框架测试的能力。包括准备单元测试环境
import TestRunner from '@ohos.application.testRunner'
```
## TestRunner.onPrepare
onPrepare(): void
......
zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md
浏览文件 @ ddfff641
......@@ -6,15 +6,12 @@ uriPermissionManager模块提供了Uri权限管理的能力。
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import UriPermissionManager from '@ohos.application.uriPermissionManager';
```
## uriPermissionManager.verifyUriPermission
verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number, callback: AsyncCallback&lt;number&gt;): void
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或