Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
175cc45a
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
175cc45a
编写于
5月 24, 2022
作者:
O
openharmony_ci
提交者:
Gitee
5月 24, 2022
浏览文件
操作
浏览文件
下载
差异文件
!4296 Fix document interface question of ability
Merge pull request !4296 from yuyaozhi/master
上级
b8940740
a5355962
变更
25
隐藏空白更改
内联
并排
Showing
25 changed file
with
215 addition
and
24 deletion
+215
-24
zh-cn/application-dev/reference/apis/js-apis-Context.md
zh-cn/application-dev/reference/apis/js-apis-Context.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
...application-dev/reference/apis/js-apis-ability-context.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
...lication-dev/reference/apis/js-apis-abilityrunninginfo.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
...ication-dev/reference/apis/js-apis-abilitystagecontext.md
+5
-0
zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md
...dev/reference/apis/js-apis-application-MissionSnapshot.md
+6
-1
zh-cn/application-dev/reference/apis/js-apis-application-Want.md
...pplication-dev/reference/apis/js-apis-application-Want.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
...ication-dev/reference/apis/js-apis-application-ability.md
+25
-0
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md
...ev/reference/apis/js-apis-application-abilityDelegator.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md
...eference/apis/js-apis-application-abilityDelegatorArgs.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
...ence/apis/js-apis-application-abilityLifecycleCallback.md
+6
-0
zh-cn/application-dev/reference/apis/js-apis-application-context.md
...ication-dev/reference/apis/js-apis-application-context.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-application-missionInfo.md
...ion-dev/reference/apis/js-apis-application-missionInfo.md
+28
-0
zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md
...-dev/reference/apis/js-apis-application-shellCmdResult.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
...plication-dev/reference/apis/js-apis-dataAbilityHelper.md
+7
-0
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
+5
-0
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
...plication-dev/reference/apis/js-apis-extension-context.md
+5
-0
zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md
...cation-dev/reference/apis/js-apis-extensionrunninginfo.md
+5
-0
zh-cn/application-dev/reference/apis/js-apis-formextension.md
...n/application-dev/reference/apis/js-apis-formextension.md
+24
-0
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md
...cation-dev/reference/apis/js-apis-formextensioncontext.md
+6
-0
zh-cn/application-dev/reference/apis/js-apis-formhost.md
zh-cn/application-dev/reference/apis/js-apis-formhost.md
+12
-8
zh-cn/application-dev/reference/apis/js-apis-formprovider.md
zh-cn/application-dev/reference/apis/js-apis-formprovider.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
...ion-dev/reference/apis/js-apis-permissionrequestresult.md
+5
-0
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md
...lication-dev/reference/apis/js-apis-processrunninginfo.md
+5
-0
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
+47
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @
175cc45a
...
...
@@ -6,10 +6,11 @@
## 导入模块
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
import
bundle
from
'
@ohos.bundle
'
import
Context
from
"
@ohos.app.context
"
;
```
## 使用说明
Context对象是在featureAbility中创建实例,并通过featureAbility的getContext()接口返回,因此在使用Context时,必须导入@ohos.ability.featureAbility库。示例如下:
```
js
...
...
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @
175cc45a
...
...
@@ -3,17 +3,17 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Ability的上下文环境,继承自Context。
## 导入模块
```
js
import
AbilityContext
from
'
@ohos.application.abilityContext
'
```
## 使用说明
在使用AbilityContext的功能前,需要通过Ability子类实例获取。
```
js
import
Ability
from
'
@ohos.application.Ability
'
class
MainAbility
extends
Ability
{
...
...
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @
175cc45a
...
...
@@ -6,7 +6,11 @@
Ability运行相关信息。
## 导入模块
```
js
import
AbilityRunningInfo
from
'
@ohos.application.abilityRunningInfo
'
;
```
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,11 @@
AbilityStage的上下文环境,继承自
[
Context
](
js-apis-application-context.md
)
。
## 导入模块
```
js
import
AbilityStageContext
from
'
@ohos.application.abilityStageContext
'
;
```
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-application-MissionSnapshot.md
浏览文件 @
175cc45a
...
...
@@ -10,13 +10,18 @@
## 导入模块
```
import MissionSnapshot from "@ohos.application.missionSnapshot";
```
## 使用说明
使用前需要提前引入对应模块。
```
import { ElementName } from '../bundle/elementName';
import { image } from '../@ohos.multimedia.image';
```
## MissionSnapshot
表示任务对应的任务快照的枚举。
...
...
zh-cn/application-dev/reference/apis/js-apis-application-Want.md
浏览文件 @
175cc45a
...
...
@@ -28,4 +28,4 @@ import Want from '@ohos.application.Want';
| action | 只读 | string | 否 | 表示action选项描述。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
| 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。 | |
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @
175cc45a
...
...
@@ -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
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md
浏览文件 @
175cc45a
...
...
@@ -7,7 +7,7 @@
## 导入模块
```
js
import
AbilityDelegator
Registry
from
'
@ohos.application.abilityDelegatorRegistry
'
import
AbilityDelegator
from
'
@ohos.application.abilityDelegator
'
```
...
...
@@ -747,7 +747,7 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs: number): Promise
\<
ShellCmdResult>
executeShellCommand(cmd: string, timeoutSecs
?
: number): Promise
\<
ShellCmdResult>
指定超时时间,并执行指定的shell命令(promise形式)
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md
浏览文件 @
175cc45a
...
...
@@ -7,7 +7,7 @@
## 导入模块
```
js
import
AbilityDelegator
Registry
from
'
@ohos.application.abilityDelegatorRegistry
'
import
AbilityDelegator
Args
from
'
@ohos.application.abilityDelegatorArgs
'
```
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,12 @@
应用上下文ApplicationContext的生命周期监听方法的回调类,里面提供了onAbilityCreate、onAbilityWindowStageCreate、onAbilityWindowStageDestroy等方法。
## 导入模块
```
js
import
AbilityLifecycleCallback
from
"
@ohos.application.abilityLifecycleCallback
"
;
```
## AbilityLifecycleCallback.onAbilityCreate
...
...
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @
175cc45a
...
...
@@ -6,7 +6,11 @@
提供开发者运行代码的上下文环境,包括应用信息、ResourceManager等信息。
## 导入模块
```
js
import
Context
from
"
@ohos.application.context
"
;
```
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-application-missionInfo.md
0 → 100644
浏览文件 @
175cc45a
# 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 | 是 | 是 | 表示任务是否可以继续。 |
zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md
浏览文件 @
175cc45a
...
...
@@ -7,7 +7,7 @@
## 导入模块
```
js
import
AbilityDelegatorRegistry
from
'
@ohos.application.abilityDelegatorRegistry
'
import
ShellCmdResult
from
'
@ohos.application.shellCmdResult
'
```
...
...
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
浏览文件 @
175cc45a
...
...
@@ -160,7 +160,7 @@ getAppMemorySize(callback: AsyncCallback\<number>): void;
```
## appManager.getProcessRunningInfos<sup>8+</sup>
getProcessRunningInfos(): Promise
<Array
<
ProcessRunningInfo
>
>;
getProcessRunningInfos(): Promise
<Array
\
<
ProcessRunningInfo
>
>;
获取有关运行进程的信息。
...
...
@@ -184,7 +184,7 @@ getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>;
## appManager.getProcessRunningInfos<sup>8+</sup>
getProcessRunningInfos(callback: AsyncCallback
<Array
<
ProcessRunningInfo
>
>): void;
getProcessRunningInfos(callback: AsyncCallback
<Array
\
<
ProcessRunningInfo
>
>): void;
获取有关运行进程的信息。
...
...
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @
175cc45a
...
...
@@ -5,6 +5,13 @@
## 导入模块
```
js
import
dataAbilityHelper
from
"
@ohos.ability.dataAbilityHelper
"
;
```
## 使用说明
使用前根据具体情况引入如下模块
```
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
...
...
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,11 @@
事件中心,提供订阅、取消订阅、触发事件能力。
## 导入模块
```
js
import
EventHub
from
"
@ohos.application.eventHub
"
;
```
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,11 @@
Extension的上下文环境,继承自Context。
## 导入模块
```
js
import
ExtensionContext
from
"
@ohos.application.extensionContext
"
;
```
## 属性
...
...
zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,11 @@
Extension运行相关信息。
## 导入模块
```
js
import
ExtensionRunningInfo
from
"
@ohos.application.extensionRunningInfo
"
;
```
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-formextension.md
浏览文件 @
175cc45a
...
...
@@ -218,4 +218,28 @@ onConfigurationUpdated(config: Configuration): void;
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
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md
浏览文件 @
175cc45a
...
...
@@ -5,6 +5,12 @@
FormExtension的上下文环境,提供FormExtension具有的能力和接口,继承自ExtensionContext。
## 导入模块
```
js
import
FormExtensionContext
from
'
@ohos.application.formExtensionContext
'
;
```
## FormExtensionContext.updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback
\<
void>): void
...
...
zh-cn/application-dev/reference/apis/js-apis-formhost.md
浏览文件 @
175cc45a
...
...
@@ -591,7 +591,7 @@ SystemCapability.Ability.Form
## getAllFormsInfo
getAllFormsInfo(callback: AsyncCallback
<
Array
<
FormInfo
>>
): void;
getAllFormsInfo(callback: AsyncCallback
<
Array
<
formInfo.
FormInfo
>>
): void;
获取设备上所有应用提供的卡片信息。
...
...
@@ -619,7 +619,8 @@ SystemCapability.Ability.Form
## getAllFormsInfo
getAllFormsInfo(): Promise
<
Array
<
FormInfo
>>
;
getAllFormsInfo(): Promise
<
Array
<
formInfo.FormInfo
>>
;
获取设备上所有应用提供的卡片信息。
...
...
@@ -645,7 +646,8 @@ SystemCapability.Ability.Form
## getFormsInfo
getFormsInfo(bundleName: string, callback: AsyncCallback
<
Array
<
FormInfo
>>
): void;
getFormsInfo(bundleName: string, callback: AsyncCallback
<
Array
<
formInfo.FormInfo
>>
): void;
获取设备上指定应用程序提供的卡片信息。
...
...
@@ -674,7 +676,8 @@ SystemCapability.Ability.Form
## getFormsInfo
getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback
<
Array
<
FormInfo
>>
): void;
getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback
<
Array
<
formInfo.FormInfo
>>
): void;
获取设备上指定应用程序提供的卡片信息。
...
...
@@ -704,7 +707,8 @@ SystemCapability.Ability.Form
## getFormsInfo
getFormsInfo(bundleName: string, moduleName?: string): Promise
<
Array
<
FormInfo
>>
;
getFormsInfo(bundleName: string, moduleName?: string): Promise
<
Array
<
formInfo.FormInfo
>>
;
获取设备上指定应用程序提供的卡片信息。
...
...
@@ -767,7 +771,7 @@ SystemCapability.Ability.Form
## deleteInvalidForms
function
deleteInvalidForms(formIds: Array
<
string
>
): Promise
<
number
>
;
deleteInvalidForms(formIds: Array
<
string
>
): Promise
<
number
>
;
根据列表删除应用程序的无效卡片。
...
...
@@ -800,7 +804,7 @@ SystemCapability.Ability.Form
## acquireFormState
acquireFormState(want: Want, callback: AsyncCallback
<
FormStateInfo
>
): void;
acquireFormState(want: Want, callback: AsyncCallback
<
formInfo.
FormStateInfo
>
): void;
获取卡片状态
...
...
@@ -834,7 +838,7 @@ SystemCapability.Ability.Form
## acquireFormState
function acquireFormState(want: Want): Promise
<
FormStateInfo
>
;
acquireFormState(want: Want): Promise
<
formInfo.
FormStateInfo
>
;
获取卡片状态。
...
...
zh-cn/application-dev/reference/apis/js-apis-formprovider.md
浏览文件 @
175cc45a
...
...
@@ -80,7 +80,7 @@ SystemCapability.Ability.Form
## updateForm
updateForm(formId: string, formBindingData:
FormBindingData,
callback: AsyncCallback
<
void
>
): void;
updateForm(formId: string, formBindingData:
formBindingData.FormBindingData,
callback: AsyncCallback
<
void
>
): void;
更新指定的卡片。
...
...
@@ -111,7 +111,7 @@ SystemCapability.Ability.Form
## updateForm
updateForm(formId: string, formBindingData: FormBindingData): Promise
<
void
>
;
updateForm(formId: string, formBindingData:
formBindingData.
FormBindingData): Promise
<
void
>
;
更新指定的卡片,以promise方式返回。
...
...
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,11 @@
权限请求结果。
## 导入模块
```
js
import
PermissionRequestResult
from
'
@ohos.application.permissionRequestResult
'
```
## 属性
...
...
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md
浏览文件 @
175cc45a
...
...
@@ -6,6 +6,11 @@
进程运行信息。
## 导入模块
```
js
import
ProcessRunningInfo
from
'
@ohos.application.processRunningInfo
'
```
## 使用说明
...
...
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
浏览文件 @
175cc45a
...
...
@@ -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
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录