鸿蒙开发接口Ability框架：【DataAbilityHelper模块(JS端SDK接口)】

jf_46214456 2024-05-13 624

电子说

1.3w人已加入

描述

DataAbilityHelper模块(JS端SDK接口)

说明：

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

使用说明

使用前根据具体情况引入如下模块

import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataAbility'
import ohos_data_rdb from '@ohos.data.rdb'

开发前请熟悉鸿蒙开发指导文档：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

DataAbilityHelper.openFile

openFile(uri: string, mode: string, callback: AsyncCallback): void

在指定的远程路径中打开文件（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要打开的文件的路径。
modestring是指示文件打开模式‘rwt’。
callbackAsyncCallback是被指定的回调方法，返回文件描述符。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
    "dataability:///com.example.DataAbility",
    mode,
    (err) = > {
		console.info("========================== >Called======================= >");
});

DataAbilityHelper.openFile

openFile(uri: string, mode: string): Promise

在指定的远程路径中打开文件（promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要打开的文件的路径。
modestring是指示文件打开模式‘rwt’。

返回值：

类型说明
Promise返回文件描述符。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
    "dataability:///com.example.DataAbility",
    mode).then((data) = > {
		console.info("========================== >openFileCallback======================= >");
});

DataAbilityHelper.on

on(type: 'dataChange', uri: string, callback: AsyncCallback): void

注册观察者以观察给定uri指定的数据callback通知。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
typestring是数据更改。
uristring是指示要操作的数据的路径。
callbackAsyncCallback是指示数据更改时的回调。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
    console.info("========================== >onChangeNotify======================= >");
};
helper.on(
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)

DataAbilityHelper.off

off(type: 'dataChange', uri: string, callback?: AsyncCallback): void

注消观察者以停止观察给定uri指定的数据callback通知。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
typestring是数据更改。
uristring是指示要操作的数据的路径。
callbackAsyncCallback否指示已注册的回调。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
    console.info("========================== >onChangeNotify======================= >");
};
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
)
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)

DataAbilityHelper.getType

getType(uri: string, callback: AsyncCallback): void

获取给定URI指定数据的MIME类型（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要操作的数据的路径。
callbackAsyncCallback是回调方法，返回与uri指定的数据匹配的MIME类型。

示例：

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======================= >");
});

DataAbilityHelper.getType

getType(uri: string): Promise

获取给定URI指定数据的MIME类型（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要操作的数据的路径。

返回值：

类型说明
Promise返回与uri指定的数据匹配的MIME类型。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getType(
    "dataability:///com.example.DataAbility"
	).then((data) = > {
		console.info("========================== >getTypeCallback======================= >");
});

DataAbilityHelper.getFileTypes

getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback>): void

获取支持的文件的MIME类型（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要获取的文件的路径。
mimeTypeFilterstring是指示要获取的文件的MIME类型。
callbackAsyncCallback>是回调方法，返回匹配的MIME类型数组。

示例：

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======================= >");
});

DataAbilityHelper.getFileTypes

getFileTypes(uri: string, mimeTypeFilter: string): Promise>

获取支持的文件的MIME类型（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要获取的文件的路径。
mimeTypeFilterstring是指示要获取的文件的MIME类型。

返回值：

类型说明
Promise>返回匹配的MIME类型数组。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
    "dataability:///com.example.DataAbility",
    "image/*"
	).then((data) = > {
		console.info("========================== >getFileTypesCallback======================= >");
});

DataAbilityHelper.normalizeUri

normalizeUri(uri: string, callback: AsyncCallback): void

将引用数据功能的给定uri转换为规范化uri（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要规范化的uri对象。
callbackAsyncCallback是回调方法。如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。

示例：

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======================= >");
});

DataAbilityHelper.normalizeUri

normalizeUri(uri: string): Promise

将引用数据功能的给定uri转换为规范化uri（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要规范化的uri对象。

返回值：

类型说明
Promise如果数据功能支持uri规范化，则返回规范化uri对象；否则返回null。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
    "dataability:///com.example.DataAbility",
	).then((data) = > {
		console.info("========================== >normalizeUriCallback======================= >");
});

DataAbilityHelper.denormalizeUri

denormalizeUri(uri: string, callback: AsyncCallback): void

将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要规范化的uri对象。
callbackAsyncCallback是回调方法。如果反规范化成功，则返回反规范化uri对象。

示例：

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======================= >");
});

DataAbilityHelper.denormalizeUri

denormalizeUri(uri: string): Promise

将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要规范化的uri对象。

返回值：

类型说明
Promise如果反规范化成功，则返回反规范化uri对象。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
    "dataability:///com.example.DataAbility",
	).then((data) = > {
		console.info("========================== >denormalizeUriCallback======================= >");
});

DataAbilityHelper.notifyChange

notifyChange(uri: string, callback: AsyncCallback): void

通知已注册的观察者uri指定的数据资源的更改（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要操作的数据的路径。
callbackAsyncCallback是回调方法。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
helper.notifyChange(
    "dataability:///com.example.DataAbility",
    (err) = > {
		console.info("========================== >Called======================= >");
});

DataAbilityHelper.notifyChange

notifyChange(uri: string): Promise

通知已注册的观察者uri指定的数据资源的更改（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要操作的数据的路径。

返回值：

类型说明
Promise返回值为Promise对象。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.notifyChange(
    "dataability:///com.example.DataAbility",
	).then(() = > {
		console.info("========================== >notifyChangeCallback======================= >");
});

DataAbilityHelper.insert

insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback): void

将单个数据记录插入数据库（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要插入的数据的路径。
valuesBucketrdb.ValuesBucket是指示要插入的数据记录。如果此参数为空，将插入一个空行。
callbackAsyncCallback是回调方法，返回插入数据记录的索引。

示例：

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======================= >");
});

DataAbilityHelper.insert

insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise

将单个数据记录插入数据库（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要插入的数据的路径。
valuesBucketrdb.ValuesBucket是指示要插入的数据记录。如果此参数为空，将插入一个空行。

返回值：

类型说明
Promise返回插入数据记录的索引。

示例：

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const valueBucket = {
    "name": "rose1",
    "age": 221,
    "salary": 20.5,
    "blobType": "u8",
}
DAHelper.insert(
    "dataability:///com.example.DataAbility",
    valueBucket
	).then((data) = > {
		console.info("========================== >insertCallback======================= >");
});

DataAbilityHelper.batchInsert

batchInsert(uri: string, valuesBuckets: Array, callback: AsyncCallback): void

插入数据库（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要插入的数据的路径。
valuesBucketArray是指示要插入的数据记录。
callbackAsyncCallback是回调方法。返回插入的数据记录数。

示例：

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======================= >");
});

DataAbilityHelper.batchInsert

batchInsert(uri: string, valuesBuckets: Array): Promise

将多个数据记录插入数据库（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要插入的数据的路径。
valuesBucketArray是指示要插入的数据记录。

返回值：

类型说明
Promise返回插入的数据记录数。

示例：

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
	).then((data) = > {
		console.info("========================== >batchInsertCallback======================= >");
});

DataAbilityHelper.delete

delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback): void

从数据库中删除一个或多个数据记录（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要删除的数据的路径。
valuesBucketdataAbility.DataAbilityPredicates是指示筛选条件。当此参数为null时，应定义处理逻辑。
callbackAsyncCallback是回调方法。返回已删除的数据记录数。

示例：

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======================= >");
});

DataAbilityHelper.delete

delete(uri: string, predicates: dataAbility.DataAbilityPredicates): Promise

从数据库中删除一个或多个数据记录（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要删除的数据的路径。
valuesBucketdataAbility.DataAbilityPredicates是指示筛选条件。当此参数为null时，应定义处理逻辑。

返回值：

类型说明
Promise返回已删除的数据记录数。

示例：

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
	).then((data) = > {
		console.info("========================== >deleteCallback======================= >");
});

DataAbilityHelper.update

update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback): void

更新数据库中的数据记录（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要更新的数据的路径。
valuesBucketrdb.ValuesBucket是指示要更新的数据。
predicatesdataAbility.DataAbilityPredicates是指示筛选条件。当此参数为null时，应定义处理逻辑。
callbackAsyncCallback是回调方法，返回更新的数据记录数。

示例：

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======================= >");
});

DataAbilityHelper.update

update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): Promise

更新数据库中的数据记录（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要更新的数据的路径。
valuesBucketrdb.ValuesBucket是指示要更新的数据。
predicatesdataAbility.DataAbilityPredicates是指示筛选条件。当此参数为null时，应定义处理逻辑。

返回值：

类型说明
PromisePromise中包含更新的数据记录数。 。

示例：

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
	).then((data) = > {
		console.info("========================== >updateCallback======================= >");
});

DataAbilityHelper.query

query(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback): void

查询数据库中的数据（callback形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要查询的数据的路径。
columnsrdb.ValuesBucket是指示要查询的列。如果此参数为空，则查询所有列。
predicatesdataAbility.DataAbilityPredicates是指示筛选条件。当此参数为null时，应定义处理逻辑。
callbackAsyncCallback是回调方法，返回查询结果。

示例：

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======================= >");
});

DataAbilityHelper.query

query(uri: string, columns: Array, predicates: dataAbility.DataAbilityPredicates): Promise

查询数据库中的数据（Promise形式）。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指示要查询的数据的路径。
columnsrdb.ValuesBucket是指示要查询的列。如果此参数为空，则查询所有列。
predicatesdataAbility.DataAbilityPredicates是指示筛选条件。当此参数为null时，应定义处理逻辑。

返回值：

类型说明
Promise返回查询结果。

示例：

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
	).then((data) = > {
		console.info("========================== >queryCallback======================= >");
});

DataAbilityHelper.call

call(uri: string, method: string, arg: string, extras: PacMap): Promise

调用DataAbility的扩展接口，使用Promise方式作为异步方法。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"
methodstring是被调用的方法名。
argstring是需传入的参数。
extras[PacMap]是键值对参数。

返回值：

类型说明
Promise[[PacMap]调用的返回值。

示例：

import featureAbility from '@ohos.ability.featureAbility';

let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}).then((data) = > {
    console.info('Operation succeeded: ' + data);
}).catch((error) = > {
    console.error('Operation failed. Cause: ' + error);
});

DataAbilityHelper.call

call(uri: string, method: string, arg: string, extras: PacMap, callback: AsyncCallback): void

调用DataAbility的扩展接口，使用callback方式作为异步方法。

系统能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

参数：

名称类型必填描述
uristring是指定待处理的DataAbility。例："dataability:///com.example.xxx.xxxx"
methodstring是被调用的方法名。
argstring是需传入的参数。
extras[PacMap]是键值对参数。
callbackAsyncCallback[[PacMap]是返回值。HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿

接口

示例：

import featureAbility from '@ohos.ability.featureAbility';

let dataAbilityHelper = featureAbility.acquireDataAbilityHelper("dataability:///com.example.jsapidemo.UserDataAbility");
dataAbilityHelper.call("dataability:///com.example.jsapidemo.UserDataAbility", "method", "arg", {"key1":"value1"}, (err, data) = > {
    if (err) {
        console.error('Operation failed. Cause: ' + err);
        return;
    }
    console.info('Operation succeeded: ' + data);
});

PacMap

名称参数类型必填说明
[key: string]numberstringboolean

审核编辑 黄宇

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分