Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7d8df50b
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看板
提交
7d8df50b
编写于
3月 16, 2022
作者:
D
dy
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
api7新增接口资料补齐
Signed-off-by:
N
dy
<
dingyao5@huawei.com
>
上级
c7d28748
变更
4
隐藏空白更改
内联
并排
Showing
4 changed file
with
913 addition
and
2 deletion
+913
-2
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
+301
-0
zh-cn/application-dev/reference/apis/js-apis-Context.md
zh-cn/application-dev/reference/apis/js-apis-Context.md
+422
-0
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
...plication-dev/reference/apis/js-apis-dataAbilityHelper.md
+75
-1
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
...application-dev/reference/apis/js-apis-particleAbility.md
+115
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @
7d8df50b
...
...
@@ -490,8 +490,309 @@ bundle.getAllApplicationInfo(bundleFlags, (err, data) => {
})
```
``## bundle.getAbilityInfo
getAbilityInfo(bundleName: string, abilityName: string): Promise\<AbilityInfo>
以异步方法根据给定的意图获取Ability信息,使用Promise形式返回结果。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | -------------------------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------------------------- |
| Promise\<AbilityInfo> | Promise形式返回Ability信息。 |
**示例:**
```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName)
.then((data) => {
console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```
## bundle.getAbilityInfo
getAbilityInfo(bundleName: string, abilityName: string): callback :
AsyncCallback\<AbilityInfo>: void
以异步方法根据给定的意图获取Ability信息,使用callback形式返回结果。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 |
| callback | AsyncCallback\<AbilityInfo> | 是 | 程序启动作为入参的回调函数,返回Ability信息。|
**示例:**
```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityInfo(bundleName, abilityName, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## bundle.getAbilityLabel
getAbilityLabel(bundleName: string, abilityName: string): Promise\<string>
以异步方法根据给定的意图获取应用名称,使用Promise形式返回结果。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | -------------------------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------------------------- |
| Promise\<string> | Promise形式返回应用名称信息。 |
**示例:**
```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, abilityName)
.then((data) => {
console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```
## bundle.getAbilityLabel
getAbilityLabel(bundleName: string, abilityName: string, callback : AsyncCallback\<string>): void
以异步方法根据给定的意图获取应用名称,使用callback形式返回结果。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| abilityName | string | 是 | 表示待查询的Ability名称。 |
| callback | AsyncCallback\<string> | 是 | 返回应用名称信息。|
**示例:**
```js
let bundleName = "com.example.myapplication";
let abilityName = "com.example.myapplication.MainAbility";
bundle.getAbilityLabel(bundleName, abilityName, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## bundle.isAbilityEnabled
isAbilityEnabled(info: AbilityInfo): Promise\<boolean>
以异步方法根据给定的意图查询ability是否已经启用,使用Promise形式返回结果。
**需要权限:**
无
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------ |
| info | AbilityInfo | 是 | Ability的配置信息 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ------------------------|
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |
**示例:**
```js
let Info = {
bundleName : "com.example.myapplication",
name : "com.example.myapplication.MainAbility"
};
bundle.isAbilityEnabled(Info)
.then((data) => {
console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```
## bundle.isAbilityEnabled
isAbilityEnabled(info : AbilityInfo, callback : AsyncCallback\<boolean>): void
以异步方法根据给定的意图查询ability是否已经启用,使用callback形式返回结果。
**需要权限:**
无
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- |
| info | AbilityInfo | 是 | Ability的配置信息 |
| callback | AsyncCallback\<boolean> | 是 | 返回boolean代表是否启用 |
**示例:**
```js
let Info = {
bundleName : "com.example.myapplication",
name : "com.example.myapplication.MainAbility"
};
bundle.isAbilityEnabled(Info, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## bundle.isApplicationEnabled
isApplicationEnabled(bundleName: string): Promise\<boolean>
以异步方法根据给定的意图查询指定应用程序是否已经启用,使用Promise形式返回结果。
**需要权限:**
无
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | -------------------------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ------------------------|
| Promise\<boolean> | Promise形式返回boolean代表是否启用。 |
**示例:**
```js
let bundleName : "com.example.myapplication";
bundle.
.then((data) => {
console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```
## bundle.isApplicationEnabled
isApplicationEnabled(bundleName: string, callback : AsyncCallback\<boolean>): void
以异步方法根据给定的意图查询指定应用程序是否已经启用,使用callback形式返回结果。
**需要权限:**
无
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------------------------- |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| callback | AsyncCallback\<boolean> | 是 | 返回boolean代表是否启用 |
**示例:**
```js
let bundleName : "com.example.myapplication";
bundle.isApplicationEnabled(bundleName, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## bundle.queryAbilityByWant
...
...
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @
7d8df50b
...
...
@@ -500,6 +500,397 @@ context.getCallingBundle().then((data) => {
});
```
## Context.getCacheDir
getCacheDir(callback: AsyncCallback
\<
string>): void
获取该应用程序的内部存储目录(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
string> | 是 | 返回该应用程序的内部存储目录。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getCacheDir
();
context
.
getCacheDir
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getCacheDir
getCacheDir(): Promise
\<
string>
获取该应用程序的内部存储目录(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
string> | 获取该应用程序的内部存储目录 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getCacheDir
().
then
((
data
)
=>
{
console
.
info
(
"
======================>getCacheDirPromsie====================>
"
);
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getFilesDir
getFilesDir(callback: AsyncCallback
\<
string>): void
获取内部存储器上此应用程序的文件目录(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
string> | 是 | 返回内部存储器上此应用程序的文件目录。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getFilesDir
();
context
.
getFilesDir
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getFilesDir
getFilesDir(): Promise
\<
string>
获取内部存储器上此应用程序的文件目录(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
string> | 返回内部存储器上此应用程序的文件目录。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getFilesDir
().
then
((
data
)
=>
{
console
.
info
(
"
======================>getFilesDirPromsie====================>
"
);
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getOrCreateDistributedDir
getOrCreateDistributedDir(callback: AsyncCallback
\<
string>): void
获取Ability或应用的分布式文件路径。
如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
string> | 是 | 回调函数,可以在回调函数中处理接口返回值,返回Ability或应用的分布式文件路径。如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getOrCreateDistributedDir
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getOrCreateDistributedDir
getOrCreateDistributedDir(): Promise
\<
string>
获取Ability或应用的分布式文件路径。
如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
string> | Ability或应用的分布式文件路径。如果是第一次调用,则将创建目录。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getOrCreateDistributedDir
().
then
((
data
)
=>
{
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getAppType
getAppType(callback: AsyncCallback
\<
string>): void
获取此应用的类型(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
string> | 是 | 回调函数,可以在回调函数中处理接口返回值,返回此应用程序的类型。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getAppType
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getAppType
getAppType(): Promise
\<
string>
获取此应用的类型(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
string> | Promise形式返回此应用的类型。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getAppType
().
then
((
data
)
=>
{
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getHapModuleInfo
getHapModuleInfo(callback: AsyncCallback
\<
HapModuleInfo>): void
获取应用的ModuleInfo对象(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
[
HapModuleInfo
](
#hapmoduleinfo
)
> | 是 | 回调函数,可以在回调函数中处理接口返回值,返回应用的ModuleInfo对象。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getHapModuleInfo
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getHapModuleInfo
getHapModuleInfo(): Promise
\<
HapModuleInfo>
获取应用的ModuleInfo对象(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
[
HapModuleInfo
](
#hapmoduleinfo
)
> | Promise形式返回应用的ModuleInfo对象。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getHapModuleInfo
().
then
((
data
)
=>
{
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getAppVersionInfo
getAppVersionInfo(callback: AsyncCallback
\<
HapModuleInfo>): void
获取应用的版本信息(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
[
AppVersionInfo
](
#appversioninfo
)
> | 是 | 回调函数,可以在回调函数中处理接口返回值,返回应用版本信息。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getAppVersionInfo
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getAppVersionInfo
getAppVersionInfo(): Promise
\<
AppVersionInfo>
获取应用的版本信息(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
[
AppVersionInfo
](
#appversioninfo
)
> | 返回应用版本信息。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getAppVersionInfo
().
then
((
data
)
=>
{
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getAbilityInfo
getAbilityInfo(callback: AsyncCallback
\<
AbilityInfo>): void
查询当前归属Ability详细信息(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback
\<
[
AbilityInfo
](
#abilityInfo
)
> | 是 |回调函数,可以在回调函数中处理接口返回值,返回当前归属Ability详细信息。|
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getAbilityInfo
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Operation successful. Data:
'
+
JSON
.
stringify
(
data
));
});
```
## Context.getAbilityInfo
getAbilityInfo(): Promise
\<
AbilityInfo>
查询当前归属Ability详细信息(Promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise
\<
[
AbilityInfo
](
#abilityInfo
)
> | 返回当前归属Ability详细信息。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
();
context
.
getAbilityInfo
().
then
((
data
)
=>
{
console
.
info
(
"
====>data====>
"
+
JSON
.
stringify
(
data
));
});
```
## Context.getApplicationContext
getApplicationContext(): Context
获取应用上下文信息。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 参数 | 类型 | 说明 |
| --------------- | ------------------------- |------ |
| Context | Context |返回应用版本信息。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
var
context
=
featureAbility
.
getContext
().
getApplicationContext
();
```
## PermissionOptions
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -518,3 +909,34 @@ context.getCallingBundle().then((data) => {
| requestCode | 只读 | number | 是 | 用户传入的请求代码。 |
| permissions | 只读 | Array
\<
string> | 是 | 用户传入的权限。 |
| authResults | 只读 | Array
\<
number> | 是 | 求权限的结果。 |
## HapModuleInfo
Hap模块信息
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 模块名称 |
| description | string | 是 | 否 | 模块描述信息 |
| descriptionId | number | 是 | 否 | 描述信息ID |
| icon | string | 是 | 否 | 模块图标 |
| label | string | 是 | 否 | 模块标签 |
| labelId | number | 是 | 否 | 模块标签ID |
| iconId | number | 是 | 否 | 模块图标ID |
| backgroundImg | string | 是 | 否 | 模块背景图片 |
| supportedModes | number | 是 | 否 | 模块支持的模式 |
| reqCapabilities | Array
<string>
| 是 | 否 | 模块运行需要的能力 |
| deviceTypes | Array
<string>
| 是 | 否 | 支持运行的设备类型 |
| abilityInfo | Array
<AbilityInfo>
| 是 | 否 | Ability信息 |
| moduleName | string | 是 | 否 | 模块名 |
| mainAbilityName | string | 是 | 否 | 入口Ability名称 |
| installationFree | boolean | 是 | 否 | 是否支持免安装 |
| mainElementName | string | 是 | 否 | 入口ability信息 |
## AppVersionInfo
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------| ------ | ------ |
| appName | string | 是 | 否 | 模块名称 |
| versionCode | number | 是 | 否 | 模块描述信息 |
| versionName | string | 是 | 否 | 描述信息ID |
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @
7d8df50b
...
...
@@ -855,4 +855,78 @@ DAHelper.query(
).
then
((
data
)
=>
{
console
.
info
(
"
==========================>queryCallback=======================>
"
);
});
```
\ No newline at end of file
```
## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap): Promise
<PacMap>
调用DataAbility的扩展接口,使用Promise方式作为异步方法。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 |
| arg | string | 是 |需传入的参数。 |
| extras |
[
PacMap
](
#pacmap
)
| 是 | 键值对参数。 |
**返回值:**
| 类型 | 说明 |
|------ | ------- |
|Promise
<
[
PacMap
](
#pacmap
)
>
| 调用的返回值。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
dataAbilityHelper
=
featureAbility
.
acquireDataAbilityHelper
(
"
dataability:///com.example.jsapidemo.UserDataAbility
"
);
dataAbilityHelper
.
call
(
"
dataability:///com.example.jsapidemo.UserDataAbility
"
,
"
method
"
,
"
arg
"
,
{
"
key1
"
:
"
value1
"
}).
then
((
data
)
=>
{
console
.
info
(
'
Operation succeeded:
'
+
data
);
}).
catch
((
error
)
=>
{
console
.
error
(
'
Operation failed. Cause:
'
+
error
);
});
```
## DataAbilityHelper.call
call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback
<PacMap>
): void
调用DataAbility的扩展接口,使用callback方式作为异步方法。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指定待处理的DataAbility。例:"dataability:///com.example.xxx.xxxx" |
| method | string | 是 | 被调用的方法名。 |
| arg | string | 是 |需传入的参数。 |
| extras |
[
PacMap
](
#pacmap
)
| 是 | 键值对参数。 |
| callback | AsyncCallback
<
[
PacMap
](
#pacmap
)
>
| 是 | 返回值。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
let
dataAbilityHelper
=
featureAbility
.
acquireDataAbilityHelper
(
"
dataability:///com.example.jsapidemo.UserDataAbility
"
);
dataAbilityHelper
.
call
(
"
dataability:///com.example.jsapidemo.UserDataAbility
"
,
"
method
"
,
"
arg
"
,
{
"
key1
"
:
"
value1
"
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
err
);
return
;
}
console
.
info
(
'
Operation succeeded:
'
+
data
);
});
```
## PacMap
| 名称 | 参数类型 | 必填 | 说明 |
| ------ | ------ | ------ | ------ |
| [key: string] | number
\|
string
\|
boolean
\|
Array
\<
string
\|
number
\|
boolean
\>
\|
null | 是 | 数据存储在键值对中。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @
7d8df50b
...
...
@@ -450,4 +450,118 @@ particleAbility.cancelBackgroundRunning().then(() => {
console
.
error
(
"
Operation failed Cause:
"
+
err
);
});
```
\ No newline at end of file
```
## particleAbility.connectAbility
connectAbility(request: Want, options: ConnectOptions): number;
将一个ability与服务类型的Ability绑定。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | Want | 是 | 服务类型Ability的want信息。 |
| options |
[
ConnectOptions
](
#connectoptions
)
| 是 | 客户端的回调对象。如果为空,抛出异常。 |
**示例**
:
```
js
import
particleAbility
from
'
@ohos.ability.particleAbility
'
;
let
request
=
{
"
bundleName
"
:
"
xxx.xxx.xxx
"
,
"
abilityName
"
:
"
xxx
"
,
}
let
options
=
{
onConnect
:
function
(
elementName
,
proxy
)
{},
onDisconnect
:
function
(
elementName
)
{},
onFailed
:
function
()
{}
}
let
connection
=
particleAbility
.
connectAbility
(
request
,
options
);
```
## particleAbility.disconnectAbility
disconnectAbility(connection: number): Promise
<void>
;
将一个Ability与绑定的服务类型的Ability解绑,使用Promise形式返回。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 |
[
particleAbility.connectAbility
](
#particleAbiltiy.connectAbility
)
接口的返回值。 |
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise
\<
void> | Promise形式返回接口调用结果。 |
**示例**
:
```
js
import
particleAbility
from
'
@ohos.ability.particleAbility
'
;
particleAbility
.
disconnectAbility
(
connection
).
then
((
data
)
=>
{
console
.
info
(
'
Operation succeeded:
'
+
data
);
}).
catch
((
error
)
=>
{
console
.
error
(
'
Operation failed. Cause:
'
+
error
);
})
```
## particleAbility.disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback
<void>
): void
将一个Ability与绑定的服务类型的Ability解绑,使用callback形式返回。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 |
[
particleAbility.connectAbility
](
#particleAbility.connectAbility
)
接口的返回值。 |
| callback | AsyncCallback
<void>
| 是 | callback形式返回接口调用结果。|
**示例**
:
```
js
import
particleAbility
from
'
@ohos.ability.particleAbility
'
;
particleAbility
.
disconnectAbility
(
connection
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
error
(
'
Operation failed. Cause:
'
+
error
);
return
;
}
console
.
info
(
'
Operation succeeded:
'
+
data
);
});
```
## ConnectOptions
ConnectOptions数据结构。
| 名称 | 说明 |
| -------- | -------- |
| onConnect(elementName: ElementName, remote: IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core |
| onFailed(code:
number) | 连接失败时回调该接口。code属于
[
ErrorCode
](
#errorcode
)
。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core |
## ErrorCode
使用时通过particleAbility.ErrorCode获取,示例:particleAbility.ErrorCode.NO_ERROR。
| 名称 | 值 | 说明 |
| -------- | ------ |-------- |
| INVALID_PARAMETER | -1 | 非法参数。 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录