HarmonyOS API：接口依赖的元素及定义

joytrian

发布于 2023-3-31 18:06

浏览

0收藏

版本：v3.1 Beta

AbilityResult

更新时间: 2023-02-17 09:19

定义ability拉起、销毁之后返回的结果码和数据。

说明

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	可读	可写	类型	必填	说明
resultCode	是	否	number	否	表示ability拉起、销毁之后返回的结果码。
want	是	否	Want	否	表示ability销毁之后返回的数据。

示例：

let want = {
  bundleName: 'com.example.mydocapplication',
  abilityName: 'MainAbility',
};
this.context.startAbilityForResult(want, (error, data) => {
    let resultCode = data.resultCode;
    let want = data.want;
});

ConnectOptions

更新时间: 2023-02-17 09:19

ConnectOptions类型说明

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

参数名	类型	必填	说明
onConnect⁷⁺	function	是	连接成功时的回调函数。
onDisconnect⁷⁺	function	是	连接失败时的回调函数。
onFailed⁷⁺	function	是	ConnectAbility调用失败时的回调函数。

返回值：

类型	说明
number	连接的ServiceAbilityID。

示例：

import rpc from '@ohos.rpc';
import featureAbility from '@ohos.ability.featureAbility';
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connectId = featureAbility.connectAbility(
    {
        deviceId: "",
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);

DataAbilityOperation

更新时间: 2023-02-17 09:19

定义dataAbility数据操作方式。

说明

本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本接口仅可在FA模型下使用

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel

名称	类型	必填	说明
uri	string	是	指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。
type	featureAbility.DataAbilityOperationType	是	指示操作类型。
valuesBucket?	rdb.ValuesBucket	否	指示要设置的数据值。
valueBackReferences?	rdb.ValuesBucket	否	指示包含一组键值对的valuesBucket对象。
predicates?	dataAbility.DataAbilityPredicates	否	指示要设置的筛选条件。如果此参数为空，则所有数据记录。
predicatesBackReferences?	Map<number, number>	否	指示用作谓词中筛选条件的反向引用。
interrupted?	boolean	否	指定是否可以中断批处理操作。
expectedCount?	number	否	指示要更新或删除的预期行数。

示例：

import featureAbility from '@ohos.ability.featureAbility'

let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility");
let DAHelper;
try {
    DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri);
    if(DAHelper == null){
        console.error('DAHelper is null');
        return;
    }
} catch (err) {
    console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err));
    return;
}

let valueBucket = {
    "name": "DataAbilityHelperTest",
    "age": 24,
    "salary": 2024.20,
};
let dataAbilityOperation = {
    uri: dataAbilityUri,
    type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
    valuesBucket: valueBucket,
    predicates: null,
    expectedCount: 1,
    PredicatesBackReferences: {},
    interrupted: true
}
let operations = [
    dataAbilityOperation
];
try {
    DAHelper.executeBatch(dataAbilityUri, operations,
        (err, data) => {
            console.log("executeBatch, data: " + JSON.stringify(data));
        }
    );
} catch (err) {
    console.error('executeBatch fail: ' + JSON.stringify(err));
}

DataAbilityResult

更新时间: 2023-02-17 09:19

定义dataAbility数据操作结果。

说明

本接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本接口仅可在FA模型下使用

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel

名称	类型	必填	说明
uri?	string	否	指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"。
count?	number	否	指示受操作影响的行数。

示例：

import featureAbility from '@ohos.ability.featureAbility'

let dataAbilityUri = ("dataability:///com.example.myapplication.TestDataAbility");
let DAHelper;
try {
    DAHelper = featureAbility.acquireDataAbilityHelper(dataAbilityUri);
    if(DAHelper == null){
        console.error('DAHelper is null');
        return;
    }
} catch (err) {
    console.error('acquireDataAbilityHelper fail, error:' + JSON.stringify(err));
    return;
}

let valueBucket = {
    "name": "DataAbilityHelperTest",
    "age": 24,
    "salary": 2024.20,
};
let operations = [
{
    uri: dataAbilityUri,
    type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
    valuesBucket: valueBucket,
    predicates: null,
    expectedCount: 1,
    PredicatesBackReferences: {},
    interrupted: true,
},
{
    uri: dataAbilityUri,
    type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
    valuesBucket: valueBucket,
    predicates: null,
    expectedCount: 1,
    PredicatesBackReferences: {},
    interrupted: true,
}
];

try {
    let promise = DAHelper.executeBatch(dataAbilityUri, operations).then((data) => {
        for (let i = 0; i < data.length; i++) {
            let dataAbilityResult = data[i];
            console.log('dataAbilityResult.uri: ' + dataAbilityResult.uri);
            console.log('dataAbilityResult.count: ' + dataAbilityResult.count);
        }
    }).catch(err => {
        console.error('executeBatch error: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('executeBatch error: ' + JSON.stringify(err));
}

StartAbilityParameter

更新时间: 2023-03-03 17:21

定义启动Ability参数。

说明

本接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本接口仅可在FA模型下使用

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel

名称	类型	必填	说明
want	Want	是	表示需要包含有关目标启动能力的信息。
abilityStartSetting	{[key: string]: any}	否	表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。

示例：

import featureAbility from '@ohos.ability.featureAbility'

let Want = {
    bundleName: "com.example.abilityStartSettingApp2",
    abilityName: "com.example.abilityStartSettingApp.MainAbility",
}

let abilityStartSetting ={
    [featureAbility.AbilityStartSetting.BOUNDS_KEY] : [100,200,300,400],
    [featureAbility.AbilityStartSetting.WINDOW_MODE_KEY] :
    featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED,
    [featureAbility.AbilityStartSetting.DISPLAY_ID_KEY] : 1,
}

let startAbilityParameter = {
    want:Want,
    abilityStartSetting:abilityStartSetting
}

featureAbility.startAbility(startAbilityParameter, (err, data)=>{
    console.log('errCode : ' + JSON.stringify(err));
    console.log('data : ' + JSON.stringify(data));
}).catch(error => {
    console.log("startAbility error: " + JSON.stringify(error));
})

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-inner-ability-startabilityparameter-0000001427902612-V3?catalogVersion=V3

分类

IDE

其他

标签

HarmonyOS API

已于2023-3-31 18:06:14修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：接口依赖的元素及定义

AbilityResult

ConnectOptions

DataAbilityOperation

DataAbilityResult

StartAbilityParameter

目录

订阅鸿蒙技术特刊，精选内容抢先看