Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
52ddf448
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看板
提交
52ddf448
编写于
3月 22, 2022
作者:
Y
yuyaozhi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Fix sample code and error content issues of ability api
Signed-off-by:
N
yuyaozhi
<
yuyaozhi@h-partners.com
>
上级
153002a0
变更
9
隐藏空白更改
内联
并排
Showing
9 changed file
with
185 addition
and
44 deletion
+185
-44
zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md
...nce/apis/js-apis-application-DataShareExtensionAbility.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md
...on-dev/reference/apis/js-apis-application-StartOptions.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
...ication-dev/reference/apis/js-apis-application-ability.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md
...on-dev/reference/apis/js-apis-application-abilitystage.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
+13
-2
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md
...ation-dev/reference/apis/js-apis-configurationconstant.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
.../application-dev/reference/apis/js-apis-featureAbility.md
+132
-2
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
.../application-dev/reference/apis/js-apis-missionManager.md
+20
-20
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
...application-dev/reference/apis/js-apis-particleAbility.md
+2
-2
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md
浏览文件 @
52ddf448
...
...
@@ -6,7 +6,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 从API
V
ersion 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 从API
v
ersion 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
类的数据共享扩展能力。
...
...
@@ -21,10 +21,10 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili
## 属性
| 名称 |
参数类型 | 可读 | 可写
| 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context
? | ExtensionContext | 是
| 否 | 指示数据共享扩展能力上下文。
<br/>
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Provider |
| 名称 |
可读 | 可写 | 参数类型 | 必填
| 说明 |
| -------- | -------- | -------- | -------- | -------- |
-------- |
| context
| 是 | 否 | ExtensionContext
| 否 | 指示数据共享扩展能力上下文。
<br/>
**系统能力**
:SystemCapability.DistributedDataManager.DataShare.Provider |
## DataShareExtensionAbility.onCreate
...
...
@@ -83,7 +83,7 @@ DAHelper.getFileTypes(
## DataShareExtensionAbility.insert
insert?(uri: string, value
s
Bucket: rdb.ValuesBucket, callback: AsyncCallback
\<
number>): void
insert?(uri: string, valueBucket: rdb.ValuesBucket, callback: AsyncCallback
\<
number>): void
将单个数据记录插入数据库(callback形式)。
...
...
@@ -120,7 +120,7 @@ DAHelper.insert(
## DataShareExtensionAbility.update
update?(uri: string, value
s
Bucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback
\<
number>): void
update?(uri: string, valueBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback
\<
number>): void
更新数据库中的数据记录(callback形式)。
...
...
@@ -259,7 +259,7 @@ DAHelper.getType(
## DataShareExtensionAbility.batchInsert
batchInsert?(uri: string, value
s
Buckets: Array
<rdb.ValuesBucket>
, callback: AsyncCallback
\<
number>): void
batchInsert?(uri: string, valueBuckets: Array
<rdb.ValuesBucket>
, callback: AsyncCallback
\<
number>): void
插入数据库(callback形式)。
...
...
zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md
浏览文件 @
52ddf448
...
...
@@ -6,7 +6,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
从API V
ersion 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
本模块首批接口从API v
ersion 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
StartOptions是系统的基本通信组件。
...
...
@@ -21,10 +21,10 @@ import StartOptions from '@ohos.application.StartOptions';
## 属性
| 名称 |
参数类型 | 可读 | 可写
| 说明 |
| -------- | -------- | -------- | -------- | -------- |
| windowMode
? | number | 是
| 否 | 窗口模式。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore |
| displayId
? | number | 是
| 否 | 显示ID。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore |
| 名称 |
可读 | 可写 | 参数类型 | 必填
| 说明 |
| -------- | -------- | -------- | -------- | -------- |
-------- |
| windowMode
| 是 | 否 | number
| 否 | 窗口模式。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore |
| displayId
| 是 | 否 | number
| 否 | 显示ID。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore |
...
...
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @
52ddf448
# Ability
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
从API V
ersion 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
本模块首批接口从API v
ersion 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Ability模块,提供对Ability生命周期、上下文环境等调用管理。
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md
浏览文件 @
52ddf448
# AbilityStage
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API
9
开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API
version 9
开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
AbilityStage是HAP包的运行时类。在HAP加载的时候,通知开发者,开发者可以在此进行该HAP的初始化(如资源预加载,线程创建等)。
...
...
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
浏览文件 @
52ddf448
# appManager
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API
7
开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API
version 7
开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
App管理。
...
...
@@ -165,4 +165,15 @@ getAppMemorySize(callback: AsyncCallback\<number>): void;
console
.
log
(
'
startAbility result success:
'
+
JSON
.
stringify
(
data
));
})
}
```
\ No newline at end of file
```
## ProcessRunningInfo
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| pid
<sup>
8+
</sup>
| 只读 | number | 否 | 进程ID。 |
| uid
<sup>
8+
</sup>
| 只读 | number | 否 | 用户ID。 |
| processName
<sup>
8+
</sup>
| 只读 | string | 否 | 进程的名称。 |
| bundleNames
<sup>
8+
</sup>
| 只读 | Array
\<
string> | 否 | 进程中运行的bundleName数组。 |
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md
浏览文件 @
52ddf448
...
...
@@ -22,7 +22,7 @@ import ConfigurationConstant from '@ohos.application.ConfigurationConstant';
**示例:**
```
ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT
。
ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
...
...
@@ -41,7 +41,7 @@ ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT。
**示例:**
```
ConfigurationConstant.Direction.DIRECTION_VERTICAL
。
ConfigurationConstant.Direction.DIRECTION_VERTICAL
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
...
...
@@ -60,7 +60,7 @@ ConfigurationConstant.Direction.DIRECTION_VERTICAL。
**示例:**
```
ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET
。
ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
...
...
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @
52ddf448
...
...
@@ -694,6 +694,136 @@ GetWindowPromise(){
}
```
## ConnectOptions.onConnect<sup>7+</sup>
onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;
连接成功时的回调函数。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| elementName | ElementName | 是 | 元素名。 |
| remote | rpc.IRemoteObject | 是 | rpc远程对象。 |
**示例:**
```
javascript
import
rpc
from
'
@ohos.rpc
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
function
onConnectCallback
(
element
,
remote
){
console
.
log
(
'
ConnectAbility onConnect remote is proxy:
'
+
(
remote
instanceof
rpc
.
RemoteProxy
));
}
function
onDisconnectCallback
(
element
){
console
.
log
(
'
ConnectAbility onDisconnect element.deviceId :
'
+
element
.
deviceId
)
}
function
onFailedCallback
(
code
){
console
.
log
(
'
featureAbilityTest ConnectAbility onFailed errCode :
'
+
code
)
}
var
connId
=
featureAbility
.
connectAbility
(
{
deviceId
:
""
,
bundleName
:
"
com.ix.ServiceAbility
"
,
abilityName
:
"
ServiceAbilityA
"
,
},
{
onConnect
:
onConnectCallback
,
onDisconnect
:
onDisconnectCallback
,
onFailed
:
onFailedCallback
,
},
);
```
## ConnectOptions.onDisconnect<sup>7+</sup>
onDisconnect(elementName: ElementName): void;
连接失败时的回调函数。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| elementName | ElementName | 是 | 元素名。 |
**示例:**
```
javascript
import
rpc
from
'
@ohos.rpc
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
function
onConnectCallback
(
element
,
remote
){
console
.
log
(
'
ConnectAbility onConnect remote is proxy:
'
+
(
remote
instanceof
rpc
.
RemoteProxy
));
}
function
onDisconnectCallback
(
element
){
console
.
log
(
'
ConnectAbility onDisconnect element.deviceId :
'
+
element
.
deviceId
)
}
function
onFailedCallback
(
code
){
console
.
log
(
'
featureAbilityTest ConnectAbility onFailed errCode :
'
+
code
)
}
var
connId
=
featureAbility
.
connectAbility
(
{
deviceId
:
""
,
bundleName
:
"
com.ix.ServiceAbility
"
,
abilityName
:
"
ServiceAbilityA
"
,
},
{
onConnect
:
onConnectCallback
,
onDisconnect
:
onDisconnectCallback
,
onFailed
:
onFailedCallback
,
},
);
```
## ConnectOptions.onFailed<sup>7+</sup>
onFailed(code: number): void;
ConnectAbility调用失败时的回调函数。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| code | number | 是 | number类型。 |
**示例:**
```
javascript
import
rpc
from
'
@ohos.rpc
'
import
featureAbility
from
'
@ohos.ability.featureAbility
'
function
onConnectCallback
(
element
,
remote
){
console
.
log
(
'
ConnectAbility onConnect remote is proxy:
'
+
(
remote
instanceof
rpc
.
RemoteProxy
));
}
function
onDisconnectCallback
(
element
){
console
.
log
(
'
ConnectAbility onDisconnect element.deviceId :
'
+
element
.
deviceId
)
}
function
onFailedCallback
(
code
){
console
.
log
(
'
featureAbilityTest ConnectAbility onFailed errCode :
'
+
code
)
}
var
connId
=
featureAbility
.
connectAbility
(
{
deviceId
:
""
,
bundleName
:
"
com.ix.ServiceAbility
"
,
abilityName
:
"
ServiceAbilityA
"
,
},
{
onConnect
:
onConnectCallback
,
onDisconnect
:
onDisconnectCallback
,
onFailed
:
onFailedCallback
,
},
);
```
## AbilityWindowConfiguration
...
...
@@ -702,7 +832,7 @@ GetWindowPromise(){
**示例:**
```
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
。
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
```
| 名称 | 参数 | 描述 |
...
...
@@ -723,7 +853,7 @@ abilityStartSetting属性是一个定义为[key: string]: any的对象,key对
**示例:**
```
featureAbility.AbilityStartSetting.BOUNDS_KEY
。
featureAbility.AbilityStartSetting.BOUNDS_KEY
```
| 名称 | 参数 | 描述 |
...
...
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
浏览文件 @
52ddf448
...
...
@@ -18,7 +18,7 @@ import missionManager from '@ohos.application.missionManager'
## missionManager.registerMissionListener
function
registerMissionListener(listener: MissionListener): number;
registerMissionListener(listener: MissionListener): number;
注册系统任务状态监听。
...
...
@@ -53,7 +53,7 @@ function registerMissionListener(listener: MissionListener): number;
## missionManager.unregisterMissionListener
function
unregisterMissionListener(listenerId: number, callback: AsyncCallback
<
void
>
): void;
unregisterMissionListener(listenerId: number, callback: AsyncCallback
<
void
>
): void;
取消任务状态监听。
...
...
@@ -86,7 +86,7 @@ function unregisterMissionListener(listenerId: number, callback: AsyncCallback&l
## missionManager.unregisterMissionListener
function
unregisterMissionListener(listenerId: number): Promise
<
void
>
;
unregisterMissionListener(listenerId: number): Promise
<
void
>
;
取消任务状态监听,以promise方式返回执行结果。
...
...
@@ -118,7 +118,7 @@ function unregisterMissionListener(listenerId: number): Promise<void>;
## missionManager.getMissionInfo
function
getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback
<
MissionInfo
>
): void;
getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback
<
MissionInfo
>
): void;
获取任务信息,以异步回调的方式返回任务信息。
...
...
@@ -151,7 +151,7 @@ function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCall
## missionManager.getMissionInfo
function
getMissionInfo(deviceId: string, missionId: number): Promise
<
MissionInfo
>
;
getMissionInfo(deviceId: string, missionId: number): Promise
<
MissionInfo
>
;
获取任务信息,以promise方式返回任务信息。
...
...
@@ -183,7 +183,7 @@ function getMissionInfo(deviceId: string, missionId: number): Promise<Mission
## missionManager.getMissionInfos
function
getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback
<
Array
<
MissionInfo
>>
): void;
getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback
<
Array
<
MissionInfo
>>
): void;
获取所有任务信息,以回调函数的方式返回任务信息数组。
...
...
@@ -212,7 +212,7 @@ function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallba
## missionManager.getMissionInfos
function
getMissionInfos(deviceId: string, numMax: number): Promise
<
Array
<
MissionInfo
>>
;
getMissionInfos(deviceId: string, numMax: number): Promise
<
Array
<
MissionInfo
>>
;
获取所有任务信息,以promise的方式返回任务信息数组。
...
...
@@ -244,7 +244,7 @@ function getMissionInfos(deviceId: string, numMax: number): Promise<Array<
## missionManager.getMissionSnapShot
function
getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback
<
MissionSnapshot
>
): void;
getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback
<
MissionSnapshot
>
): void;
获取任务快照,以回调函数的方式返回快照内容。
...
...
@@ -279,7 +279,7 @@ function getMissionSnapShot(deviceId: string, missionId: number, callback: Async
## missionManager.getMissionSnapShot
function
getMissionSnapShot(deviceId: string, missionId: number): Promise
<
MissionSnapshot
>
;
getMissionSnapShot(deviceId: string, missionId: number): Promise
<
MissionSnapshot
>
;
获取任务快照,以promise的方式返回快照内容。
...
...
@@ -317,7 +317,7 @@ function getMissionSnapShot(deviceId: string, missionId: number): Promise<Mis
## missionManager.lockMission
function
lockMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
lockMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
锁定指定任务id的任务,以回调函数的方式返回。
...
...
@@ -350,7 +350,7 @@ function lockMission(missionId: number, callback: AsyncCallback<void>): vo
## missionManager.lockMission
function
lockMission(missionId: number): Promise
<
void
>
;
lockMission(missionId: number): Promise
<
void
>
;
锁定指定任务id的任务,以promise方式返回。
...
...
@@ -382,7 +382,7 @@ function lockMission(missionId: number): Promise<void>;
## missionManager.unlockMission
function
unlockMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
unlockMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
解锁指定任务id的任务,以回调函数的方式返回。
...
...
@@ -414,7 +414,7 @@ function unlockMission(missionId: number, callback: AsyncCallback<void>):
## missionManager.unlockMission
function
unlockMission(missionId: number): Promise
<
void
>
;
unlockMission(missionId: number): Promise
<
void
>
;
解锁指定任务id的任务,以promise的方式返回。
...
...
@@ -449,7 +449,7 @@ function unlockMission(missionId: number): Promise<void>;
## missionManager.clearMission
function
clearMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
clearMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
清理指定任务id的任务,无论该任务是否被锁定,以回调函数的方式返回。
...
...
@@ -482,7 +482,7 @@ function clearMission(missionId: number, callback: AsyncCallback<void>): v
## missionManager.clearMission
function
clearMission(missionId: number): Promise
<
void
>
;
clearMission(missionId: number): Promise
<
void
>
;
清理指定任务id的任务,无论该任务是否被锁定,以promise的方式返回。
...
...
@@ -514,7 +514,7 @@ function clearMission(missionId: number): Promise<void>;
## missionManager.clearAllMissions
function
clearAllMissions(callback: AsyncCallback
<
void
>
): void;
clearAllMissions(callback: AsyncCallback
<
void
>
): void;
清理所有未锁定的任务,以回调函数的方式返回。
...
...
@@ -533,7 +533,7 @@ function clearAllMissions(callback: AsyncCallback<void>): void;
## missionManager.clearAllMissions
function
clearAllMissions(): Promise
<
void
>
;
clearAllMissions(): Promise
<
void
>
;
清理所有未锁定的任务,以promise的方式返回。
...
...
@@ -551,7 +551,7 @@ function clearAllMissions(): Promise<void>;
## missionManager.moveMissionToFront
function
moveMissionToFront(missionId: number, callback: AsyncCallback
<
void
>
): void;
moveMissionToFront(missionId: number, callback: AsyncCallback
<
void
>
): void;
把指定任务id的任务切到前台,以回调函数的方式返回。
...
...
@@ -584,7 +584,7 @@ function moveMissionToFront(missionId: number, callback: AsyncCallback<void&g
## missionManager.moveMissionToFront
function
moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback
<
void
>
): void;
moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback
<
void
>
): void;
把指定任务id的任务切到前台,同时指定任务切换到前台时的启动参数,例如窗口模式、设备ID等,以回调函数的方式返回。
...
...
@@ -618,7 +618,7 @@ function moveMissionToFront(missionId: number, options: StartOptions, callback:
## missionManager.moveMissionToFront
function
moveMissionToFront(missionId: number, options?: StartOptions): Promise
<
void
>
;
moveMissionToFront(missionId: number, options?: StartOptions): Promise
<
void
>
;
把指定任务id的任务切到前台,以promise的方式返回。
...
...
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @
52ddf448
...
...
@@ -417,7 +417,7 @@ connectAbility(request: Want, options:ConnectOptions): number
## particleAbility.disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback
<void>
): void;
disconnectAbility(connection: number, callback:AsyncCallback
\
<
void>): void;
将功能与服务功能断开连接。
...
...
@@ -463,7 +463,7 @@ disconnectAbility(connection: number, callback:AsyncCallback<void>): void;
## particleAbility.disconnectAbility
disconnectAbility(connection: number): Promise
<void>
;
disconnectAbility(connection: number): Promise
\
<
void>;
将功能与服务功能断开连接。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录