提交 a5355962 编写于 作者: Y yuyaozhi 提交者: yuyaozhi

Fix document interface question of ability

Signed-off-by: Nyuyaozhi <yuyaozhi@h-partners.com>
Signed-off-by: Nyuyaozhi <yuyaozhi@huawei.com>
上级 d6114416
...@@ -6,10 +6,11 @@ ...@@ -6,10 +6,11 @@
## 导入模块 ## 导入模块
```js ```js
import featureAbility from '@ohos.ability.featureAbility' import Context from "@ohos.app.context";
import bundle from '@ohos.bundle'
``` ```
## 使用说明
Context对象是在featureAbility中创建实例,并通过featureAbility的getContext()接口返回,因此在使用Context时,必须导入@ohos.ability.featureAbility库。示例如下: Context对象是在featureAbility中创建实例,并通过featureAbility的getContext()接口返回,因此在使用Context时,必须导入@ohos.ability.featureAbility库。示例如下:
```js ```js
......
...@@ -3,17 +3,17 @@ ...@@ -3,17 +3,17 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Ability的上下文环境,继承自Context。 Ability的上下文环境,继承自Context。
## 导入模块
```js
import AbilityContext from '@ohos.application.abilityContext'
```
## 使用说明 ## 使用说明
在使用AbilityContext的功能前,需要通过Ability子类实例获取。 在使用AbilityContext的功能前,需要通过Ability子类实例获取。
```js ```js
import Ability from '@ohos.application.Ability' import Ability from '@ohos.application.Ability'
class MainAbility extends Ability { class MainAbility extends Ability {
......
...@@ -6,7 +6,11 @@ ...@@ -6,7 +6,11 @@
Ability运行相关信息。 Ability运行相关信息。
## 导入模块
```js
import AbilityRunningInfo from '@ohos.application.abilityRunningInfo';
```
## 使用说明 ## 使用说明
......
...@@ -6,6 +6,11 @@ ...@@ -6,6 +6,11 @@
AbilityStage的上下文环境,继承自[Context](js-apis-application-context.md) AbilityStage的上下文环境,继承自[Context](js-apis-application-context.md)
## 导入模块
```js
import AbilityStageContext from '@ohos.application.abilityStageContext';
```
## 使用说明 ## 使用说明
......
...@@ -10,13 +10,18 @@ ...@@ -10,13 +10,18 @@
## 导入模块 ## 导入模块
```
import MissionSnapshot from "@ohos.application.missionSnapshot";
```
## 使用说明
使用前需要提前引入对应模块。
``` ```
import { ElementName } from '../bundle/elementName'; import { ElementName } from '../bundle/elementName';
import { image } from '../@ohos.multimedia.image'; import { image } from '../@ohos.multimedia.image';
``` ```
## MissionSnapshot ## MissionSnapshot
表示任务对应的任务快照的枚举。 表示任务对应的任务快照的枚举。
......
...@@ -28,4 +28,4 @@ import Want from '@ohos.application.Want'; ...@@ -28,4 +28,4 @@ import Want from '@ohos.application.Want';
| action | 只读 | string | 否 | 表示action选项描述。 | | action | 只读 | string | 否 | 表示action选项描述。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 | | parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 | | entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
| moduleName<sup>9</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块(module)。同一应用的不同hap的组件可能重名,仅通过BundleName和AbilityName无法区分时,可以通过设置moduleName加以区分,以匹配到指定的Ability。 | | | moduleName<sup>9+</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块(module)。同一应用的不同hap的组件可能重名,仅通过BundleName和AbilityName无法区分时,可以通过设置moduleName加以区分,以匹配到指定的Ability。 | |
...@@ -259,6 +259,31 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -259,6 +259,31 @@ onConfigurationUpdated(config: Configuration): void;
} }
``` ```
## Ability.dump
dump(params: Array\<string>): Array\<string>;
指示from命令的参数。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array\<string> | 是 | 指示from命令的参数。|
**示例:**
```js
class myAbility extends Ability {
dump(params) {
console.log('dump, params:' + JSON.stringify(params));
}
}
```
## Caller ## Caller
......
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
## 导入模块 ## 导入模块
```js ```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegator from '@ohos.application.abilityDelegator'
``` ```
...@@ -747,7 +747,7 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => { ...@@ -747,7 +747,7 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
### executeShellCommand ### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs: number): Promise\<ShellCmdResult> executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>
指定超时时间,并执行指定的shell命令(promise形式) 指定超时时间,并执行指定的shell命令(promise形式)
......
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
## 导入模块 ## 导入模块
```js ```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorArgs from '@ohos.application.abilityDelegatorArgs'
``` ```
......
...@@ -6,6 +6,12 @@ ...@@ -6,6 +6,12 @@
应用上下文ApplicationContext的生命周期监听方法的回调类,里面提供了onAbilityCreate、onAbilityWindowStageCreate、onAbilityWindowStageDestroy等方法。 应用上下文ApplicationContext的生命周期监听方法的回调类,里面提供了onAbilityCreate、onAbilityWindowStageCreate、onAbilityWindowStageDestroy等方法。
## 导入模块
```js
import AbilityLifecycleCallback from "@ohos.application.abilityLifecycleCallback";
```
## AbilityLifecycleCallback.onAbilityCreate ## AbilityLifecycleCallback.onAbilityCreate
......
...@@ -6,7 +6,11 @@ ...@@ -6,7 +6,11 @@
提供开发者运行代码的上下文环境,包括应用信息、ResourceManager等信息。 提供开发者运行代码的上下文环境,包括应用信息、ResourceManager等信息。
## 导入模块
```js
import Context from "@ohos.application.context";
```
## 使用说明 ## 使用说明
......
# MissionInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从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 | 是 | 是 | 表示任务是否可以继续。 |
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
## 导入模块 ## 导入模块
```js ```js
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import ShellCmdResult from '@ohos.application.shellCmdResult'
``` ```
......
...@@ -160,7 +160,7 @@ getAppMemorySize(callback: AsyncCallback\<number>): void; ...@@ -160,7 +160,7 @@ getAppMemorySize(callback: AsyncCallback\<number>): void;
``` ```
## appManager.getProcessRunningInfos<sup>8+</sup> ## appManager.getProcessRunningInfos<sup>8+</sup>
getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>; getProcessRunningInfos(): Promise<Array\<ProcessRunningInfo>>;
获取有关运行进程的信息。 获取有关运行进程的信息。
...@@ -184,7 +184,7 @@ getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>; ...@@ -184,7 +184,7 @@ getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>;
## appManager.getProcessRunningInfos<sup>8+</sup> ## appManager.getProcessRunningInfos<sup>8+</sup>
getProcessRunningInfos(callback: AsyncCallback<Array<ProcessRunningInfo>>): void; getProcessRunningInfos(callback: AsyncCallback<Array\<ProcessRunningInfo>>): void;
获取有关运行进程的信息。 获取有关运行进程的信息。
......
...@@ -5,6 +5,13 @@ ...@@ -5,6 +5,13 @@
## 导入模块 ## 导入模块
```js
import dataAbilityHelper from "@ohos.ability.dataAbilityHelper";
```
## 使用说明
使用前根据具体情况引入如下模块
``` ```
import featureAbility from '@ohos.ability.featureAbility' import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability' import ohos_data_ability from '@ohos.data.dataability'
......
...@@ -6,6 +6,11 @@ ...@@ -6,6 +6,11 @@
事件中心,提供订阅、取消订阅、触发事件能力。 事件中心,提供订阅、取消订阅、触发事件能力。
## 导入模块
```js
import EventHub from "@ohos.application.eventHub";
```
## 使用说明 ## 使用说明
......
...@@ -6,6 +6,11 @@ ...@@ -6,6 +6,11 @@
Extension的上下文环境,继承自Context。 Extension的上下文环境,继承自Context。
## 导入模块
```js
import ExtensionContext from "@ohos.application.extensionContext";
```
## 属性 ## 属性
......
...@@ -6,6 +6,11 @@ ...@@ -6,6 +6,11 @@
Extension运行相关信息。 Extension运行相关信息。
## 导入模块
```js
import ExtensionRunningInfo from "@ohos.application.extensionRunningInfo";
```
## 使用说明 ## 使用说明
......
...@@ -218,4 +218,28 @@ onConfigurationUpdated(config: Configuration): void; ...@@ -218,4 +218,28 @@ onConfigurationUpdated(config: Configuration): void;
console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
} }
} }
```
## FormExtension.onAcquireFormState
onAcquireFormState?(want: Want): formInfo.FormState;
返回formInfo#FormState对象。
**系统能力**:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 否 | 返回formInfo#FormState对象。 |
**示例:**
```js
class MyFormExtension extends MyFormExtension {
onAcquireFormState(want) {
console.log('FormExtension onAcquireFormState, want:' + want);
}
}
``` ```
\ No newline at end of file
...@@ -5,6 +5,12 @@ ...@@ -5,6 +5,12 @@
FormExtension的上下文环境,提供FormExtension具有的能力和接口,继承自ExtensionContext。 FormExtension的上下文环境,提供FormExtension具有的能力和接口,继承自ExtensionContext。
## 导入模块
```js
import FormExtensionContext from '@ohos.application.formExtensionContext';
```
## FormExtensionContext.updateForm ## FormExtensionContext.updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\<void>): void updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\<void>): void
......
...@@ -591,7 +591,7 @@ SystemCapability.Ability.Form ...@@ -591,7 +591,7 @@ SystemCapability.Ability.Form
## getAllFormsInfo ## getAllFormsInfo
getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;FormInfo&gt;&gt;): void; getAllFormsInfo(callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void;
获取设备上所有应用提供的卡片信息。 获取设备上所有应用提供的卡片信息。
...@@ -619,7 +619,8 @@ SystemCapability.Ability.Form ...@@ -619,7 +619,8 @@ SystemCapability.Ability.Form
## getAllFormsInfo ## getAllFormsInfo
getAllFormsInfo(): Promise&lt;Array&lt;FormInfo&gt;&gt;; getAllFormsInfo(): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;;
获取设备上所有应用提供的卡片信息。 获取设备上所有应用提供的卡片信息。
...@@ -645,7 +646,8 @@ SystemCapability.Ability.Form ...@@ -645,7 +646,8 @@ SystemCapability.Ability.Form
## getFormsInfo ## getFormsInfo
getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;FormInfo&gt;&gt;): void; getFormsInfo(bundleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void;
获取设备上指定应用程序提供的卡片信息。 获取设备上指定应用程序提供的卡片信息。
...@@ -674,7 +676,8 @@ SystemCapability.Ability.Form ...@@ -674,7 +676,8 @@ SystemCapability.Ability.Form
## getFormsInfo ## getFormsInfo
getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;Array&lt;FormInfo&gt;&gt;): void; getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void;
获取设备上指定应用程序提供的卡片信息。 获取设备上指定应用程序提供的卡片信息。
...@@ -704,7 +707,8 @@ SystemCapability.Ability.Form ...@@ -704,7 +707,8 @@ SystemCapability.Ability.Form
## getFormsInfo ## getFormsInfo
getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;FormInfo&gt;&gt;; getFormsInfo(bundleName: string, moduleName?: string): Promise&lt;Array&lt;formInfo.FormInfo&gt;&gt;;
获取设备上指定应用程序提供的卡片信息。 获取设备上指定应用程序提供的卡片信息。
...@@ -767,7 +771,7 @@ SystemCapability.Ability.Form ...@@ -767,7 +771,7 @@ SystemCapability.Ability.Form
## deleteInvalidForms ## deleteInvalidForms
function deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;; deleteInvalidForms(formIds: Array&lt;string&gt;): Promise&lt;number&gt;;
根据列表删除应用程序的无效卡片。 根据列表删除应用程序的无效卡片。
...@@ -800,7 +804,7 @@ SystemCapability.Ability.Form ...@@ -800,7 +804,7 @@ SystemCapability.Ability.Form
## acquireFormState ## acquireFormState
acquireFormState(want: Want, callback: AsyncCallback&lt;FormStateInfo&gt;): void; acquireFormState(want: Want, callback: AsyncCallback&lt;formInfo.FormStateInfo&gt;): void;
获取卡片状态 获取卡片状态
...@@ -834,7 +838,7 @@ SystemCapability.Ability.Form ...@@ -834,7 +838,7 @@ SystemCapability.Ability.Form
## acquireFormState ## acquireFormState
function acquireFormState(want: Want): Promise&lt;FormStateInfo&gt;; acquireFormState(want: Want): Promise&lt;formInfo.FormStateInfo&gt;;
获取卡片状态。 获取卡片状态。
......
...@@ -80,7 +80,7 @@ SystemCapability.Ability.Form ...@@ -80,7 +80,7 @@ SystemCapability.Ability.Form
## updateForm ## updateForm
updateForm(formId: string, formBindingData: FormBindingData, callback: AsyncCallback&lt;void&gt;): void; updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback&lt;void&gt;): void;
更新指定的卡片。 更新指定的卡片。
...@@ -111,7 +111,7 @@ SystemCapability.Ability.Form ...@@ -111,7 +111,7 @@ SystemCapability.Ability.Form
## updateForm ## updateForm
updateForm(formId: string, formBindingData: FormBindingData): Promise&lt;void&gt;; updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise&lt;void&gt;;
更新指定的卡片,以promise方式返回。 更新指定的卡片,以promise方式返回。
......
...@@ -6,6 +6,11 @@ ...@@ -6,6 +6,11 @@
权限请求结果。 权限请求结果。
## 导入模块
```js
import PermissionRequestResult from '@ohos.application.permissionRequestResult'
```
## 属性 ## 属性
......
...@@ -6,6 +6,11 @@ ...@@ -6,6 +6,11 @@
进程运行信息。 进程运行信息。
## 导入模块
```js
import ProcessRunningInfo from '@ohos.application.processRunningInfo'
```
## 使用说明 ## 使用说明
......
...@@ -915,6 +915,53 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => { ...@@ -915,6 +915,53 @@ WantAgent.equal(wantAgent1, wantAgent2).then((data) => {
}); });
``` ```
## WantAgent.getOperationType
getOperationType(agent: WantAgent, callback: AsyncCallback\<number>): void;
获取WantAgent的操作类型(callback形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ---------- | --- | ---- | ------------------------ | ---- | --------------------------------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
| callback | 是 | 否 | AsyncCallback\<number> | 是 | 获取WantAgent的操作类型。 |
**示例:**
```js
```
## WantAgent.getOperationType
getOperationType(agent: WantAgent): Promise\<number>;
获取WantAgent的操作类型(Promise形式)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
| ---------- | --- | ---- | --------- | ---- | ------------- |
| agent | 是 | 否 | WantAgent | 是 | WantAgent对象。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<number> | 以Promise形式返回获取WantAgent的操作类型。 |
**示例:**
```js
```
## WantAgentInfo ## WantAgentInfo
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册