Skip to content

D
Docs

OpenHarmony / Docs
11 个月 前同步成功

通知 158
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 a908a510 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2096 Fix ability issue of unmatched content between dts files and md files 

Merge pull request !2096 from yuyaozhi/master
上级 a7cf4d28 7cb2e813
隐藏空白更改
内联 并排
Showing with 903 addition and 198 deletion
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
浏览文件 @ a908a510
# DataUriUtils模块
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
......
zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md 0 → 100644
浏览文件 @ a908a510
# DataShareExtensionAbility
- [导入模块](#导入模块)
- [属性](#属性)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 从API Version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
类的数据共享扩展能力。
## 导入模块
```
import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility';
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context? | ExtensionContext | 是 | 否 | 指示数据共享扩展能力上下文。<br/>**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider |
## DataShareExtensionAbility.onCreate
onCreate?(want: Want): void;
在启动数据共享扩展功能进行初始化时回调。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | Want | 是 | want表示有关数据共享扩展功能的连接信息。|
**示例：**
```js
class myAbility extends DataShareExtensionAbility {
onCreate(want) {
console.log('onCreate, want:' + want.abilityName);
}
}
```
## DataShareExtensionAbility.getFileTypes
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
获取支持的文件的MIME类型（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调方法，返回匹配的MIME类型数组。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
"dataability:///com.example.DataAbility",
"image/*",
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.insert
insert?(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void
将单个数据记录插入数据库（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空，将插入一个空行。 |
| callback | AsyncCallback\<number> | 是 | 回调方法，返回插入数据记录的索引。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
const valueBucket = {
"name": "rose",
"age": 22,
"salary": 200.5,
"blobType": u8,
}
DAHelper.insert(
"dataability:///com.example.DataAbility",
valueBucket,
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.update
update?(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
更新数据库中的数据记录（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要更新的数据的路径。 |
| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback\<number> | 是 | 回调方法，返回更新的数据记录数。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
const va = {
"name": "roe1",
"age": 21,
"salary": 20.5,
"blobType": u8,
}
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update(
"dataability:///com.example.DataAbility",
va,
da,
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.delete
delete?(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
从数据库中删除一个或多个数据记录（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback\<number> | 是 | 回调方法。返回已删除的数据记录数。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
"dataability:///com.example.DataAbility",
da,
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.query
query?(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void
查询数据库中的数据（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时，应定义处理逻辑。 |
| callback | AsyncCallback\<ResultSet> | 是 | 回调方法，返回查询结果。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
var cars=new Array("value1", "value2", "value3", "value4");
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
"dataability:///com.example.DataAbility",
cars,
da,
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.getType
getType?(uri: string, callback: AsyncCallback\<string>): void
获取给定URI指定数据的MIME类型（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<string> | 是 | 回调方法，返回与uri指定的数据匹配的MIME类型。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
DAHelper.getType(
"dataability:///com.example.DataAbility",
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.batchInsert
batchInsert?(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void
插入数据库（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| ------------ | ----------------------- | ---- | -------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback\<number> | 是 | 回调方法。返回插入的数据记录数。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,},
{"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,},
{"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,})
DAHelper.batchInsert(
"dataability:///com.example.DataAbility",
cars,
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.normalizeUri
normalizeUri?(uri: string, callback: AsyncCallback\<string>): void
将引用数据功能的给定uri转换为规范化uri（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
"dataability:///com.example.DataAbility",
(err, data) => {
console.info("==========================>Called=======================>");
});
```
## DataShareExtensionAbility.denormalizeUri
denormalizeUri?(uri: string, callback: AsyncCallback\<string>): void
将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。
**系统能力**：SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果反规范化成功，则返回反规范化uri对象。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
"dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
"dataability:///com.example.DataAbility",
(err, data) => {
console.info("==========================>Called=======================>");
});
```
zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md 0 → 100644
浏览文件 @ a908a510
# StartOptions
- [导入模块](#导入模块)
- [属性](#属性)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 从API Version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
StartOptions是系统的基本通信组件。
## 导入模块
```
import StartOptions from '@ohos.application.StartOptions';
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| 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
浏览文件 @ a908a510
# Ability
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 从API Version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 从API Version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
Ability模块，提供对Ability生命周期、上下文环境等调用管理。
......@@ -14,7 +14,6 @@ Ability模块，提供对Ability生命周期、上下文环境等调用管理。
import Ability from '@ohos.application.Ability';
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
......@@ -570,3 +569,19 @@ off(method: string): void;
}
```
## OnReleaseCallBack
(msg: string): void;
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore |
## CaleeCallBack
(indata: rpc.MessageParcel): rpc.Sequenceable;
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore |
zh-cn/application-dev/reference/apis/js-apis-application-abilityContext.md 0 → 100644
浏览文件 @ a908a510
# AbilityConstant
- [导入模块](#导入模块)
- [属性](#属性)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。
启动参数的接口.
## 导入模块
```js
import AbilityConstant from '@ohos.application.AbilityConstant';
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason | LaunchReason| 是 | 是 | 指示启动原因。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
## AbilityConstant.LaunchReason
初次开始原因的类型。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| START_ABILITY | 1 | 启动能力。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| CALL | 2 | 呼叫。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| CONTINUATION | 3 | 继续。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
## AbilityConstant.LaunchReason
上次退出原因的类型。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| ABILITY_NOT_RESPONDING | 1 | 能力没有反应<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| NORMAL | 2 | 正常的状态。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
## AbilityConstant.OnContinueResult
继续结果的类型。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| AGREE | 0 | 同意。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| REJECT | 1 | 拒绝。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| MISMATCH | 2 | 不匹配。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md
浏览文件 @ a908a510
......@@ -90,4 +90,10 @@ onConfigurationUpdated(config: Configuration): void;
}
}
```
## AbilityStage.context
指示有关上下文的配置信息。
| 属性名 | 类型 | 说明 |
| ----------- | --------------------------- | ------------------------------------------------------------ |
| context | [AbilityStageContext](js-apis-featureAbility.md) | 在启动能力阶段进行初始化时回调。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @ a908a510
......@@ -53,7 +53,7 @@ createBundleContext(bundleName: string): Context;
**示例：**
```js
let test = "com.huawei.test";
let test = "com.example.test";
let context = this.context.createBundleContext(test);
```
......
zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md 0 → 100644
浏览文件 @ a908a510
# StaticSubscriberExtensionAbility
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API 9开始支持。
## 导入模块
```
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
```
## StaticSubscriberExtensionAbility.onReceiveEvent
onReceiveEvent(event: CommonEventData): void;
静态订阅者通用事件回调。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | CommonEventData | 是 | 静态订阅者通用事件回调。 |
**示例：**
```js
var StaticSubscriberExtensionAbility = requireNapi("application.StaticSubscriberExtensionAbility")
{
onReceiveEvent(event){
console.log('onReceiveEvent,event:' + event.code);
}
}
export default MyStaticSubscriberExtensionAbility
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
浏览文件 @ a908a510
# appManager
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块首批接口从API 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
App管理。
......@@ -15,7 +15,7 @@ import app from '@ohos.application.appManager';
```
## appManager.isRunningInStabilityTest
## appManager.isRunningInStabilityTest<sup>8+</sup>
static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
......@@ -39,7 +39,7 @@ static isRunningInStabilityTest(callback: AsyncCallback&lt;boolean&gt;): void
```
## appManager.isRunningInStabilityTest
## appManager.isRunningInStabilityTest<sup>8+</sup>
static isRunningInStabilityTest(): Promise&lt;boolean&gt;
......@@ -63,3 +63,106 @@ static isRunningInStabilityTest(): Promise&lt;boolean&gt;
console.log('failed:' + JSON.stringfy(error));
});
```
## appManager.isRamConstrainedDevice
isRamConstrainedDevice(): Promise\<boolean>;
它是ram受限设备吗。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 是否为ram受限设备。 |
**示例：**
```js
IsRamConstrainedDevicePromise(){
app.isRamConstrainedDevicePromise().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
}
```
## appManager.isRamConstrainedDevice
isRamConstrainedDevice(callback: AsyncCallback\<boolean>): void;
它是ram受限设备吗。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 否 | 返回当前是否是ram受限设备。 |
**示例：**
```js
IsRamConstrainedDeviceCallBack(){
app.isRamConstrainedDevicePromise((err, data) => {
console.log('startAbility result failed:' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data));
})
}
```
## appManager.getAppMemorySize
getAppMemorySize(): Promise\<number>;
获取应用程序的内存大小。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | 应用程序内存大小。 |
**示例：**
```js
GetAppMemorySize(){
app.getAppMemorySize().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
}
```
## appManager.getAppMemorySize
getAppMemorySize(callback: AsyncCallback\<number>): void;
获取应用程序的内存大小。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;number&gt; | 否 | 应用程序内存大小。 |
**示例：**
```js
GetAppMemorySizeCallBack(){
app.getAppMemorySize((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data));
})
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-configuration.md
浏览文件 @ a908a510
......@@ -23,6 +23,6 @@ import Configuration from '@ohos.application.Configuration';
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode | [ColorMode](js-apis-configurationconstant.md) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
| direction | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
| displayId | number | 是 | 否 | 表示应用所在的displayId。 |
| direction<sup>9+</sup> | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity<sup>9+</sup> | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
| displayId<sup>9+</sup> | number | 是 | 否 | 表示应用所在的displayId。 |
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md
浏览文件 @ a908a510
......@@ -48,9 +48,9 @@ ConfigurationConstant.Direction.DIRECTION_VERTICAL。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DIRECTION_NOT_SET | -1 | 未设置方向。 |
| DIRECTION_VERTICAL | 0 | 垂直方向。 |
| DIRECTION_HORIZONTAL | 1 | 水平方向。 |
| DIRECTION_NOT_SET<sup>9+</sup> | -1 | 未设置方向。 |
| DIRECTION_VERTICAL<sup>9+</sup> | 0 | 垂直方向。 |
| DIRECTION_HORIZONTAL<sup>9+</sup> | 1 | 水平方向。 |
## ConfigurationConstant.ScreenDensity
......@@ -67,10 +67,10 @@ ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 |
| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 |
| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 |
| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 |
| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 |
| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 |
| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 |
| SCREEN_DENSITY_NOT_SET<sup>9+</sup> | 0 | 未设置屏幕分辨率。 |
| SCREEN_DENSITY_SDPI<sup>9+</sup> | 120 | 屏幕分辨率为"sdpi"。 |
| SCREEN_DENSITY_MDPI<sup>9+</sup> | 160 | 屏幕分辨率为"mdpi"。 |
| SCREEN_DENSITY_LDPI<sup>9+</sup> | 240 | 屏幕分辨率为"ldpi"。 |
| SCREEN_DENSITY_XLDPI<sup>9+</sup> | 320 | 屏幕分辨率为"xldpi"。 |
| SCREEN_DENSITY_XXLDPI<sup>9+</sup> | 480 | 屏幕分辨率为"xxldpi"。 |
| SCREEN_DENSITY_XXXLDPI<sup>9+</sup> | 640 | 屏幕分辨率为"xxxldpi"。 |
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @ a908a510
# FeatureAbility模块(JS端SDK接口)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用限制
FeatureAbility模块的接口只能在Page类型的Ability调用
......@@ -87,7 +90,7 @@ featureAbility.startAbility(
});
```
## featureAbility.acquireDataAbilityHelper
## featureAbility.acquireDataAbilityHelper<sup>7+</sup>
acquireDataAbilityHelper(uri: string): DataAbilityHelper
......@@ -116,7 +119,7 @@ featureAbility.acquireDataAbilityHelper(
)
```
## featureAbility.startAbilityForResult
## featureAbility.startAbilityForResult<sup>7+</sup>
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
......@@ -153,7 +156,7 @@ featureAbility.startAbilityForResult(
)
```
## featureAbility.startAbilityForResult
## featureAbility.startAbilityForResult<sup>7+</sup>
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
......@@ -209,7 +212,7 @@ featureAbility.startAbilityForResult(
});
```
## featureAbility.terminateSelfWithResult
## featureAbility.terminateSelfWithResult<sup>7+</sup>
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
......@@ -257,7 +260,7 @@ featureAbility.terminateSelfWithResult(
);
```
## featureAbility.terminateSelfWithResult
## featureAbility.terminateSelfWithResult<sup>7+</sup>
terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
......@@ -314,7 +317,7 @@ featureAbility.terminateSelfWithResult(
## featureAbility.hasWindowFocus
## featureAbility.hasWindowFocus<sup>7+<sup>
hasWindowFocus(callback: AsyncCallback\<boolean>): void
......@@ -337,7 +340,7 @@ featureAbility.hasWindowFocus()
## featureAbility.hasWindowFocus
## featureAbility.hasWindowFocus<sup>7+<sup>
hasWindowFocus(): Promise\<boolean>
......@@ -432,7 +435,7 @@ context.getBundleName()
## featureAbility.terminateSelf
## featureAbility.terminateSelf<sup>7+</sup>
terminateSelf(callback: AsyncCallback\<void>): void
......@@ -455,7 +458,7 @@ featureAbility.terminateSelf()
## featureAbility.terminateSelf
## featureAbility.terminateSelf<sup>7+</sup>
terminateSelf(): Promise\<void>
......@@ -477,7 +480,7 @@ featureAbility.terminateSelf().then((data) => { console.info("=============
});
```
## featureAbility.connectAbility
## featureAbility.connectAbility<sup>7+</sup>
connectAbility(request: Want, options:ConnectOptions): number
......@@ -546,7 +549,7 @@ var connId = featureAbility.connectAbility(
);
```
## featureAbility.disconnectAbility
## featureAbility.disconnectAbility<sup>7+</sup>
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
......@@ -593,7 +596,7 @@ var result = featureAbility.disconnectAbility(connId,
);
```
## featureAbility.disconnectAbility
## featureAbility.disconnectAbility<sup>7+</sup>
disconnectAbility(connection: number): Promise\<void>
......@@ -644,14 +647,124 @@ featureAbility.disconnectAbility(connId).then((error,data)=>{
});
```
## featureAbility.getWindow<sup>7+</sup>
getWindow(callback: AsyncCallback\<window.Window>): void
获取当前技能对应的窗口（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<window.Window> | 是 | 返回与当前能力对应的窗口。 |
**示例：**
```javascript
GetWindow(){
featureAbility.getWindow()
}
```
## featureAbility.getWindow<sup>7+</sup>
getWindow(): Promise\<window.Window>;
获取当前技能对应的窗口（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**返回值：**
| 类型 | 说明 |
| ----------------- | ---------------------------------------------------------- |
| Promise\<window.Window> | 返回与当前能力对应的窗口。 |
**示例：**
```javascript
GetWindowPromise(){
featureAbility.getWindow().then((data) => {
console.info("=============getWindowPromise========== " + JSON.stringify(data));
});
}
```
## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取。
**示例：**
```
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
```
| 名称 | 参数 | 描述 |
| --------------------------- | ---- | ---------- |
| WINDOW_MODE_UNDEFINED<sup>7+</sup> | 0 | 未定义。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FULLSCREEN<sup>7+</sup> | 1 | 全屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup> | 100 | 分屏主屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_SPLIT_SECONDARY<sup>7+</sup> | 101 | 分屏次屏。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_FLOATING<sup>7+</sup> | 102 | 悬浮窗。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## AbilityStartSetting
abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
使用时通过featureAbility.AbilityStartSetting获取。
**示例：**
```
featureAbility.AbilityStartSetting.BOUNDS_KEY。
```
| 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- |
| BOUNDS_KEY<sup>7+</sup> | "abilityBounds" | 窗口显示大小属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode" | 窗口显示模式属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| DISPLAY_ID_KEY<sup>7+</sup> | "displayId" | 窗口显示设备ID属性的名称。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## ErrorCode
获取错误代码。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| NO_ERROR<sup>7+</sup> | 0 | 没有错误。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到能力。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| PERMISSION_DENY<sup>7+</sup> | -3 | 拒绝许可。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## DataAbilityOperationType
指示数据的操作类型。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| TYPE_INSERT<sup>7+</sup> | 1 | 插入类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| TYPE_UPDATE<sup>7+</sup> | 2 | 修改类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| TYPE_DELETE<sup>7+</sup> | 3 | 删除类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| TYPE_ASSERT<sup>7+</sup> | 4 | 声明类型。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
## AbilityResult
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
| resultCode<sup>7+</sup> | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）。 |
| want<sup>7+</sup> | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 |
## StartAbilityParameter
......@@ -662,21 +775,22 @@ featureAbility.disconnectAbility(connId).then((error,data)=>{
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
## Want
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 |
| action | 只读 | string | 否 | 表示action选项描述。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
| deviceId<sup>8+</sup> | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName<sup>8+</sup> | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName<sup>8+</sup> | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri<sup>8+</sup> | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type<sup>8+</sup> | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 |
| flags<sup>8+</sup> | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 |
| action<sup>8+</sup> | 只读 | string | 否 | 表示action选项描述。 |
| parameters<sup>8+</sup> | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
| entities<sup>8+</sup> | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
## flags说明
......
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md
浏览文件 @ a908a510
......@@ -44,6 +44,8 @@ createFormBindingData(obj?: Object | string): FormBindingData
## formBindingData.FormBindingData
data: Object
FormBindingData相关描述。
**系统能力**：SystemCapability.Ability.Form
......
zh-cn/application-dev/reference/apis/js-apis-formextension.md
浏览文件 @ a908a510
# FormExtension
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
提供FormExtension卡片扩展相关接口。
......@@ -192,4 +192,28 @@ onDestroy(formId: string): void
console.log('FormExtension onDestroy, formId:' + formId);
}
}
```
## FormExtension.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
当系统配置更新时调用。
**系统能力**：SystemCapability.Ability.Form
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [Configuration](#section188911144124715) | 是 | 表示需要更新的配置信息。 |
**示例：**
```js
class MyFormExtension extends MyFormExtension {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @ a908a510
# particleAbility模块
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用限制
particleAbility模块用来对Data和Service类型的Ability进行操作。
......@@ -180,94 +183,6 @@ var uri = "";
particleAbility.acquireDataAbilityHelper(uri)
```
## StartAbilityParameter
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 |
| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 |
## Want
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 |
| action | 只读 | string | 否 | 表示action选项描述。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
## flags说明
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 参数 | 描述 |
| ------------------------------------ | ---------- | ------------------------------------------------------------ |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 |
| 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_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用。 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
## AbilityStartSetting
abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
使用时通过featureAbility.AbilityStartSetting获取。
**示例：**
```
featureAbility.AbilityStartSetting.BOUNDS_KEY。
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数 | 描述 |
| --------------- | --------------- | -------------------------- |
| BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。 |
| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 |
| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 |
## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取。
**示例：**
```
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
| 名称 | 参数 | 描述 |
| --------------------------- | ---- | ---------- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义。 |
| WINDOW_MODE_FULLSCREEN | 1 | 全屏。 |
| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。 |
| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。 |
| WINDOW_MODE_FLOATING | 102 | 悬浮窗。 |
## particleAbility.startBackgroundRunning
......@@ -452,116 +367,157 @@ particleAbility.cancelBackgroundRunning().then(() => {
```
## particleAbility.connectAbility
connectAbility(request: Want, options: ConnectOptions): number;
connectAbility(request: Want, options:ConnectOptions): number
将一个ability与服务类型的Ability绑定。
将当前ability连接到指定ServiceAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | Want | 是 | 服务类型Ability的want信息。 |
| options | [ConnectOptions](#connectoptions) | 是 | 客户端的回调对象。如果为空，抛出异常。 |
| 名称 | 类型 | 必填 | 描述 |
| ------- | -------------- | ---- | ---------------------------- |
| request | [Want](#want) | 是 | 表示被连接的ServiceAbility。 |
| options | 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);
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('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = particleAbility.connectAbility(
{
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
particleAbility.disconnectAbility(connId).then((error,data)=>{
console.log('particleAbilityTest result errCode : ' + error.code + " data: " + data);
});
```
## particleAbility.disconnectAbility
disconnectAbility(connection: number): Promise<void>;
disconnectAbility(connection: number, callback:AsyncCallback<void>): void;
将一个Ability与绑定的服务类型的Ability解绑，使用Promise形式返回。
将功能与服务功能断开连接。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | [particleAbility.connectAbility](#particleAbiltiy.connectAbility)接口的返回值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回断开连接的结果 |
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| 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);
})
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('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = particleAbility.connectAbility(
{
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
var result = particleAbility.disconnectAbility(connId,
(error,data) => {
console.log('particleAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code + " data: " + data)
},
);
```
## particleAbility.disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback<void>): void
disconnectAbility(connection: number): Promise<void>;
将一个Ability与绑定的服务类型的Ability解绑，使用callback形式返回。
将功能与服务功能断开连接。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
**参数：**
**返回值：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | [particleAbility.connectAbility](#particleAbility.connectAbility)接口的返回值。 |
| callback | AsyncCallback<void> | 是 | callback形式返回接口调用结果。|
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
**示例**：
**示例**：
```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);
});
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('particleAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = particleAbility.connectAbility(
{
bundleName: "com.ix.ServiceAbility",
abilityName: "ServiceAbilityA",
},
{
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback,
onFailed: onFailedCallback,
},
);
particleAbility.disconnectAbility(connId).then((error,data)=>{
console.log('particleAbilityTest result errCode : ' + error.code + " data: " + data);
});
```
## ConnectOptions
## ErrorCode
ConnectOptions数据结构。
获取错误代码。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| INVALID_PARAMETER | -1 | 无效的参数。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel |
| 名称 | 说明 |
| -------- | -------- |
| onConnect(elementName: ElementName, remote: IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。<br/>**系统能力**：SystemCapability.Ability.AbilityRuntime.Core |
| onFailed(code:&nbsp;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.
先完成此消息的编辑！
想要评论请 注册 或