diff --git a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md b/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md index 209056cff6868c3947afb09c15ada175183394ba..8cda4890e6647418ad4c5682ee534e42bdbac53c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md @@ -1,5 +1,8 @@ # DataUriUtils模块 +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md new file mode 100644 index 0000000000000000000000000000000000000000..a42342c7a9155f3874bde46c253f00ab194c3fe3 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md @@ -0,0 +1,350 @@ +# DataShareExtensionAbility + +- [导入模块](#导入模块) +- [属性](#属性) + + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> 从API Version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + + +类的数据共享扩展能力。 + + +## 导入模块 + + +``` +import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility'; +``` + +## 属性 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| context? | ExtensionContext | 是 | 否 | 指示数据共享扩展能力上下文。
**系统能力**: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>): void + +获取支持的文件的MIME类型(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| -------------- | ------------------------------ | ---- | ---------------------------------- | +| uri | string | 是 | 指示要获取的文件的路径。 | +| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | +| callback | AsyncCallback\> | 是 | 回调方法,返回匹配的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\): void + +将单个数据记录插入数据库(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| ------------ | ---------------------- | ---- | ------------------------------------------------------ | +| uri | string | 是 | 指示要插入的数据的路径。 | +| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 | +| callback | AsyncCallback\ | 是 | 回调方法,返回插入数据记录的索引。 | + +**示例:** + +```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\): void + +更新数据库中的数据记录(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| ------------ | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要更新的数据的路径。 | +| valuesBucket | rdb.ValuesBucket | 是 | 指示要更新的数据。 | +| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | +| callback | AsyncCallback\ | 是 | 回调方法,返回更新的数据记录数。 | + +**示例:** + +```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\): void + +从数据库中删除一个或多个数据记录(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| ------------ | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要删除的数据的路径。 | +| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | +| callback | AsyncCallback\ | 是 | 回调方法。返回已删除的数据记录数。 | + +**示例:** + +```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\, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\): void + +查询数据库中的数据(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| ---------- | --------------------------------- | ---- | ------------------------------------------------ | +| uri | string | 是 | 指示要查询的数据的路径。 | +| columns | rdb.ValuesBucket | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 | +| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 | +| callback | AsyncCallback\ | 是 | 回调方法,返回查询结果。 | + +**示例:** + +```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\): void + +获取给定URI指定数据的MIME类型(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | --------------------------------------------- | +| uri | string | 是 | 指示要操作的数据的路径。 | +| callback | AsyncCallback\ | 是 | 回调方法,返回与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, callback: AsyncCallback\): void + +插入数据库(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| ------------ | ----------------------- | ---- | -------------------------------- | +| uri | string | 是 | 指示要插入的数据的路径。 | +| valuesBucket | Array | 是 | 指示要插入的数据记录。 | +| callback | AsyncCallback\ | 是 | 回调方法。返回插入的数据记录数。 | + +**示例:** + +```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\): void + +将引用数据功能的给定uri转换为规范化uri(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ------------------------------------------------------------ | +| uri | string | 是 | 指示要规范化的uri对象。 | +| callback | AsyncCallback\ | 是 | 回调方法。如果数据功能支持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\): void + +将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(callback形式)。 + +**系统能力**:SystemCapability.DistributedDataManager.DataShare.Provider + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | --------------------------------------------------- | +| uri | string | 是 | 指示要规范化的uri对象。 | +| callback | AsyncCallback\ | 是 | 回调方法。如果反规范化成功,则返回反规范化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=======================>"); +}); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md b/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..bad372255e7d250eb79a1c656cabe8c0aed6a01a --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md @@ -0,0 +1,33 @@ +# StartOptions + +- [导入模块](#导入模块) +- [属性](#属性) + + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> 从API Version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + + +StartOptions是系统的基本通信组件。 + + +## 导入模块 + + +``` +import StartOptions from '@ohos.application.StartOptions'; +``` + +## 属性 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| windowMode? | number | 是 | 否 | 窗口模式。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore | +| displayId? | number | 是 | 否 | 显示ID。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore | + + + + + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index e68ee3078b212b68dbfb96638f6177340c96a125..45b4060a4fe3c75e58f530802c2278a3cf5b3fc2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -1,7 +1,7 @@ # 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 | 是 | 否 | 调用者注册的侦听器函数接口的原型。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore | + + + ## CaleeCallBack + +(indata: rpc.MessageParcel): rpc.Sequenceable; + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| (indata: rpc.MessageParcel) | rpc.Sequenceable | 是 | 否 | 被调用方注册的消息侦听器函数接口的原型。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityContext.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityContext.md new file mode 100644 index 0000000000000000000000000000000000000000..5976e69ece0f421b8f483053ea1fdda61b7ceff4 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityContext.md @@ -0,0 +1,60 @@ +# AbilityConstant + +- [导入模块](#导入模块) +- [属性](#属性) + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> 本模块首批接口从API version 9开始支持。 + + +启动参数的接口. + + +## 导入模块 + + +```js +import AbilityConstant from '@ohos.application.AbilityConstant'; +``` + + +## 属性 + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| launchReason | LaunchReason| 是 | 是 | 指示启动原因。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | + +## AbilityConstant.LaunchReason + +初次开始原因的类型。 + +| 变量 | 值 | 说明 | +| ----------------------------- | ---- | ------------------------------------------------------------ | +| UNKNOWN | 0 | 未知的状态。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| START_ABILITY | 1 | 启动能力。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| CALL | 2 | 呼叫。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| CONTINUATION | 3 | 继续。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | + + +## AbilityConstant.LaunchReason + +上次退出原因的类型。 + +| 变量 | 值 | 说明 | +| ----------------------------- | ---- | ------------------------------------------------------------ | +| UNKNOWN | 0 | 未知的状态。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| ABILITY_NOT_RESPONDING | 1 | 能力没有反应
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| NORMAL | 2 | 正常的状态。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | + + +## AbilityConstant.OnContinueResult + +继续结果的类型。 + +| 变量 | 值 | 说明 | +| ----------------------------- | ---- | ------------------------------------------------------------ | +| AGREE | 0 | 同意。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| REJECT | 1 | 拒绝。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | +| MISMATCH | 2 | 不匹配。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md index e46a4451919cb05149a306c0a1e134a87a321a80..c777da815e168dcca898b2a8970bb22be8520212 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md @@ -90,4 +90,10 @@ onConfigurationUpdated(config: Configuration): void; } } ``` +## AbilityStage.context +指示有关上下文的配置信息。 + +| 属性名 | 类型 | 说明 | +| ----------- | --------------------------- | ------------------------------------------------------------ | +| context | [AbilityStageContext](js-apis-featureAbility.md) | 在启动能力阶段进行初始化时回调。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-application-context.md index b8d41b675f4474e465acec3322c9f85ed57813d2..7ceea1edb9c33cd0fbaab1f414db1fe6b59bc027 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-context.md @@ -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); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md new file mode 100644 index 0000000000000000000000000000000000000000..870c0210970d9244172cb4def9ea739390866bf6 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md @@ -0,0 +1,39 @@ +# 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md index 89a655ece0fbfdff9cfe6cc791dcaf5be257fc10..f7d0f2fb6c7617c08d6b683d564b6f4d3c34df33 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -1,7 +1,7 @@ # 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.isRunningInStabilityTest8+ static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void @@ -39,7 +39,7 @@ static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void ``` -## appManager.isRunningInStabilityTest +## appManager.isRunningInStabilityTest8+ static isRunningInStabilityTest(): Promise<boolean> @@ -63,3 +63,106 @@ static isRunningInStabilityTest(): Promise<boolean> console.log('failed:' + JSON.stringfy(error)); }); ``` + + +## appManager.isRamConstrainedDevice + +isRamConstrainedDevice(): Promise\; + +它是ram受限设备吗。 + +**系统能力**:SystemCapability.Ability.AbilityRuntime.Core + +**返回值:** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<boolean> | 是否为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\): void; + +它是ram受限设备吗。 + +**系统能力**:SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 否 | 返回当前是否是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\; + +获取应用程序的内存大小。 + +**系统能力**:SystemCapability.Ability.AbilityRuntime.Core + +**返回值:** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<number> | 应用程序内存大小。 | + +**示例:** + + ```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\): void; + +获取应用程序的内存大小。 + +**系统能力**:SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<number> | 否 | 应用程序内存大小。 | + +**示例:** + + ```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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-configuration.md index 39ae599dc624fd62713b365c720b4a221b99be7b..0a57fb491dbbc3c6ef3bce2536b118c5f42fcf54 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configuration.md @@ -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。 | +| direction9+ | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 | +| screenDensity9+ | 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)。 | +| displayId9+ | number | 是 | 否 | 表示应用所在的displayId。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md b/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md index 1f47e4dbd4223868cae0d17846a7cf05d1d568fa..9af37d0aad2f4f402b2d96616c11620a34411cde 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md @@ -48,9 +48,9 @@ ConfigurationConstant.Direction.DIRECTION_VERTICAL。 | 名称 | 值 | 说明 | | -------- | -------- | -------- | -| DIRECTION_NOT_SET | -1 | 未设置方向。 | -| DIRECTION_VERTICAL | 0 | 垂直方向。 | -| DIRECTION_HORIZONTAL | 1 | 水平方向。 | +| DIRECTION_NOT_SET9+ | -1 | 未设置方向。 | +| DIRECTION_VERTICAL9+ | 0 | 垂直方向。 | +| DIRECTION_HORIZONTAL9+ | 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_SET9+ | 0 | 未设置屏幕分辨率。 | +| SCREEN_DENSITY_SDPI9+ | 120 | 屏幕分辨率为"sdpi"。 | +| SCREEN_DENSITY_MDPI9+ | 160 | 屏幕分辨率为"mdpi"。 | +| SCREEN_DENSITY_LDPI9+ | 240 | 屏幕分辨率为"ldpi"。 | +| SCREEN_DENSITY_XLDPI9+ | 320 | 屏幕分辨率为"xldpi"。 | +| SCREEN_DENSITY_XXLDPI9+ | 480 | 屏幕分辨率为"xxldpi"。 | +| SCREEN_DENSITY_XXXLDPI9+ | 640 | 屏幕分辨率为"xxxldpi"。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md index 87dfa9699547b63a7acf23135bed95712a21aeb1..94abaec42c062eb7d3503bae9f164b5b56bb2c31 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md @@ -1,5 +1,8 @@ # 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.acquireDataAbilityHelper7+ acquireDataAbilityHelper(uri: string): DataAbilityHelper @@ -116,7 +119,7 @@ featureAbility.acquireDataAbilityHelper( ) ``` -## featureAbility.startAbilityForResult +## featureAbility.startAbilityForResult7+ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\): void @@ -153,7 +156,7 @@ featureAbility.startAbilityForResult( ) ``` -## featureAbility.startAbilityForResult +## featureAbility.startAbilityForResult7+ startAbilityForResult(parameter: StartAbilityParameter): Promise\ @@ -209,7 +212,7 @@ featureAbility.startAbilityForResult( }); ``` -## featureAbility.terminateSelfWithResult +## featureAbility.terminateSelfWithResult7+ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\): void @@ -257,7 +260,7 @@ featureAbility.terminateSelfWithResult( ); ``` -## featureAbility.terminateSelfWithResult +## featureAbility.terminateSelfWithResult7+ terminateSelfWithResult(parameter: AbilityResult): Promise\ @@ -314,7 +317,7 @@ featureAbility.terminateSelfWithResult( -## featureAbility.hasWindowFocus +## featureAbility.hasWindowFocus7+ hasWindowFocus(callback: AsyncCallback\): void @@ -337,7 +340,7 @@ featureAbility.hasWindowFocus() -## featureAbility.hasWindowFocus +## featureAbility.hasWindowFocus7+ hasWindowFocus(): Promise\ @@ -432,7 +435,7 @@ context.getBundleName() -## featureAbility.terminateSelf +## featureAbility.terminateSelf7+ terminateSelf(callback: AsyncCallback\): void @@ -455,7 +458,7 @@ featureAbility.terminateSelf() -## featureAbility.terminateSelf +## featureAbility.terminateSelf7+ terminateSelf(): Promise\ @@ -477,7 +480,7 @@ featureAbility.terminateSelf().then((data) => { console.info("============= }); ``` -## featureAbility.connectAbility +## featureAbility.connectAbility7+ connectAbility(request: Want, options:ConnectOptions): number @@ -546,7 +549,7 @@ var connId = featureAbility.connectAbility( ); ``` -## featureAbility.disconnectAbility +## featureAbility.disconnectAbility7+ disconnectAbility(connection: number, callback:AsyncCallback\): void @@ -593,7 +596,7 @@ var result = featureAbility.disconnectAbility(connId, ); ``` -## featureAbility.disconnectAbility +## featureAbility.disconnectAbility7+ disconnectAbility(connection: number): Promise\ @@ -644,14 +647,124 @@ featureAbility.disconnectAbility(connId).then((error,data)=>{ }); ``` + +## featureAbility.getWindow7+ + +getWindow(callback: AsyncCallback\): void + +获取当前技能对应的窗口(callback形式)。 + +**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel + +**参数:** + +| 名称 | 类型 | 必填 | 描述 | +| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback\ | 是 | 返回与当前能力对应的窗口。 | + +**示例:** + +```javascript +GetWindow(){ + featureAbility.getWindow() + } +``` + +## featureAbility.getWindow7+ + +getWindow(): Promise\; + +获取当前技能对应的窗口(Promise形式)。 + +**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel + +**返回值:** + +| 类型 | 说明 | +| ----------------- | ---------------------------------------------------------- | +| Promise\ | 返回与当前能力对应的窗口。 | + +**示例:** + +```javascript +GetWindowPromise(){ + featureAbility.getWindow().then((data) => { + console.info("=============getWindowPromise========== " + JSON.stringify(data)); + }); + } +``` + + +## AbilityWindowConfiguration + +使用时通过featureAbility.AbilityWindowConfiguration获取。 + +**示例:** + +``` +featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED。 +``` + +| 名称 | 参数 | 描述 | +| --------------------------- | ---- | ---------- | +| WINDOW_MODE_UNDEFINED7+ | 0 | 未定义。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_FULLSCREEN7+ | 1 | 全屏。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_SPLIT_PRIMARY7+ | 100 | 分屏主屏。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_SPLIT_SECONDARY7+ | 101 | 分屏次屏。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_FLOATING7+ | 102 | 悬浮窗。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | + + +## AbilityStartSetting + +abilityStartSetting属性是一个定义为[key: string]: any的对象,key对应设定类型为:AbilityStartSetting枚举类型,value对应设定类型为:AbilityWindowConfiguration枚举类型。 + +使用时通过featureAbility.AbilityStartSetting获取。 + +**示例:** + +``` +featureAbility.AbilityStartSetting.BOUNDS_KEY。 +``` + +| 名称 | 参数 | 描述 | +| --------------- | --------------- | -------------------------- | +| BOUNDS_KEY7+ | "abilityBounds" | 窗口显示大小属性的名称。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_KEY7+ | "windowMode" | 窗口显示模式属性的名称。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| DISPLAY_ID_KEY7+ | "displayId" | 窗口显示设备ID属性的名称。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | + +## ErrorCode + +获取错误代码。 + +| 变量 | 值 | 说明 | +| ----------------------------- | ---- | ------------------------------------------------------------ | +| NO_ERROR7+ | 0 | 没有错误。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| INVALID_PARAMETER7+ | -1 | 无效的参数。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| ABILITY_NOT_FOUND7+ | -2 | 找不到能力。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| PERMISSION_DENY7+ | -3 | 拒绝许可。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | + + +## DataAbilityOperationType + +指示数据的操作类型。 + +| 变量 | 值 | 说明 | +| ----------------------------- | ---- | ------------------------------------------------------------ | +| TYPE_INSERT7+ | 1 | 插入类型。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| TYPE_UPDATE7+ | 2 | 修改类型。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| TYPE_DELETE7+ | 3 | 删除类型。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | +| TYPE_ASSERT7+ | 4 | 声明类型。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | + + + ## AbilityResult **系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ | -| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持)。 | -| want | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 | +| resultCode7+ | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持)。 | +| want7+ | 只读 | [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\ | 否 | 表示entities相关描述。 | +| deviceId8+ | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | +| bundleName8+ | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 | +| abilityName8+ | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 | +| uri8+ | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri,则Want将匹配指定的Uri信息,包括scheme, schemeSpecificPart, authority和path信息。 | +| type8+ | 只读 | string | 否 | 表示MIME type类型描述,比如:"text/plain" 、 "image/*"等。 | +| flags8+ | 只读 | number | 否 | 表示处理Want的方式。默认传数字,具体参考:[flags说明](#flags说明)。 | +| action8+ | 只读 | string | 否 | 表示action选项描述。 | +| parameters8+ | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 | +| entities8+ | 只读 | Array\ | 否 | 表示entities相关描述。 | ## flags说明 diff --git a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md index 0429806e44791a143ced57fecf0f54126757746d..62afcbe07f5423015866a878f2ec96e87dfdae88 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md @@ -44,6 +44,8 @@ createFormBindingData(obj?: Object | string): FormBindingData ## formBindingData.FormBindingData +data: Object + FormBindingData相关描述。 **系统能力**:SystemCapability.Ability.Form diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextension.md b/zh-cn/application-dev/reference/apis/js-apis-formextension.md index 86f13ed225531ce2fe642433a27e3a40f8255493..5ebc4381b10c7117b6c81838fdc5814c094303ec 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextension.md @@ -1,7 +1,7 @@ # 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 diff --git a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md b/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md index 5cff97c64a5352930e56d5ea192200f863fc808d..3ba49313fd95d0c44fc763ec73e1cfaf9bbb50cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md @@ -1,5 +1,8 @@ # 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\ | 否 | 表示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; +disconnectAbility(connection: number, callback:AsyncCallback): void; -将一个Ability与绑定的服务类型的Ability解绑,使用Promise形式返回。 +将功能与服务功能断开连接。 **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel - **参数:** +**参数:** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | connection | number | 是 | [particleAbility.connectAbility](#particleAbiltiy.connectAbility)接口的返回值。 | + | callback | AsyncCallback<void> | 是 | callback形式返回断开连接的结果 | -**返回值:** - -| 类型 | 说明 | -| -------------- | ------------------------- | -| Promise\ | 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 +disconnectAbility(connection: number): Promise; -将一个Ability与绑定的服务类型的Ability解绑,使用callback形式返回。 +将功能与服务功能断开连接。 **系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel - **参数:** +**返回值:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | connection | number | 是 | [particleAbility.connectAbility](#particleAbility.connectAbility)接口的返回值。 | - | callback | AsyncCallback | 是 | callback形式返回接口调用结果。| +| 类型 | 说明 | +| -------------- | ------------------------- | +| Promise\ | 使用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 | 无效的参数。
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel | + + + + + -| 名称 | 说明 | -| -------- | -------- | -| onConnect(elementName: ElementName, remote: IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | -| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | -| onFailed(code: number) | 连接失败时回调该接口。code属于[ErrorCode](#errorcode)。
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core | -## ErrorCode -使用时通过particleAbility.ErrorCode获取,示例:particleAbility.ErrorCode.NO_ERROR。 -| 名称 | 值 | 说明 | -| -------- | ------ |-------- | -| INVALID_PARAMETER | -1 | 非法参数。 | \ No newline at end of file