DataAbilityHelper模块(JS端SDK接口)

支持设备

API 手机 平板 智慧屏 智能穿戴 轻量级智能穿戴 智慧视觉设备
DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback<number>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.openFile(uri: string, mode: string) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback<void>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.getType(uri: string, callback: AsyncCallback<string>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.getType(uri: string) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback<string>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.normalizeUri(uri: string) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback<string>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.denormalizeUri(uri: string) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback<void>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.notifyChange(uri: string) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback<number>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback<number>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback<number>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback<number>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.query(uri: string, columns: Array<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback<ResultSet>) 支持 支持 支持 支持 不支持 不支持
DataAbilityHelper.query(uri: string, columns: Array<string>, predicates: dataAbility.DataAbilityPredicates) 支持 支持 支持 支持 不支持 不支持

权限列表

ohos.permission.RUNNING_LOCK permission

导入模块

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

DataAbilityHelper.openFile(uri: string, mode: string, callback: AsyncCallback<number>)

  • 接口说明

    在指定的远程路径中打开文件(callback形式)

  • 参数描述
名称 读写属性 类型 必填 描述
uri 只读 string 指示要打开的文件的路径。
mode 只读 string 指示文件打开模式‘rwt’。
callback 只读 AsyncCallback<void> 被指定的回调方法
  • 返回值

    返回文件描述符。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
    "dataability:///com.example.DataAbility",
    mode,
)

DataAbilityHelper.openFile(uri: string, mode: string)

  • 接口说明

    在指定的远程路径中打开文件(Promise形式)

  • 参数描述
名称 读写属性 类型 必填 描述
uri 只读 string 指示要打开的文件的路径。
mode 只读 string 指示文件打开模式‘rwt’。
  • 返回值

    返回文件描述符。

  • 示例

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

DataAbilityHelper.on(type: 'dataChange', uri: string, callback: AsyncCallback<void>)

  • 接口说明

    注册观察者以观察给定uri指定的数据(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
type 只读 string 数据更改。
uri 只读 string 指示要操作的数据的路径。
callback 只读 AsyncCallback<void> 指示数据更改时的回调。
  • 返回值

    void

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var helper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
helper.on(
    "dataChange",
    "dataability:///com.example.DataAbility",
)

DataAbilityHelper.off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>)

  • 接口说明

    注册观察者以观察给定uri指定的数据(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
type 只读 string 数据更改。
uri 只读 string 指示要操作的数据的路径。
callback 只读 AsyncCallback<void> 指示已注册的回调。
  • 返回值

    void

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var helper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
)

DataAbilityHelper.getType(uri: string, callback: AsyncCallback<string>)

  • 接口说明

    获取给定URI指定的日期的MIME类型(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要操作的数据的路径。
callback 只读 AsyncCallback<string> 回调方法
  • 返回值

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

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getType(
    "dataability:///com.example.DataAbility"
)

DataAbilityHelper.getType(uri: string)

  • 接口说明

    获取给定URI指定的日期的MIME类型(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要操作的数据的路径。
  • 返回值

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

  • 示例

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

DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>)

  • 接口说明

    获取支持的文件的MIME类型(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要获取的文件的路径。
mimeTypeFilter 只读 string 指示要获取的文件的MIME类型。
callback 只读 AsyncCallback<string> 回调方法
  • 返回值

    返回匹配的MIME类型数组。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
    "dataability:///com.example.DataAbility",
    "image/*"
)

DataAbilityHelper.getFileTypes(uri: string, mimeTypeFilter: string)

  • 接口说明

    获取支持的文件的MIME类型(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要获取的文件的路径。
mimeTypeFilter 只读 string 指示要获取的文件的MIME类型。
  • 返回值

    返回匹配的MIME类型数组。

  • 示例

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

DataAbilityHelper.normalizeUri(uri: string, callback: AsyncCallback<string>)

  • 接口说明

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

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要规范化的uri对象。
callback 只读 AsyncCallback<string> 回调方法
  • 返回值

    如果数据功能支持uri规范化或null,则返回规范化uri对象。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
    "dataability:///com.example.DataAbility",
)

DataAbilityHelper.normalizeUri(uri: string)

  • 接口说明

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

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要规范化的uri对象。
  • 返回值

    如果数据功能支持uri规范化或null,则返回规范化uri对象。

  • 示例

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

DataAbilityHelper.denormalizeUri(uri: string, callback: AsyncCallback<string>)

  • 接口说明

    将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要规范化的uri对象。
callback 只读 AsyncCallback<string> 回调方法
  • 返回值

    如果反规范化成功,则返回反规范化uri对象。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
    "dataability:///com.example.DataAbility",
)

DataAbilityHelper.denormalizeUri(uri: string)

  • 接口说明

    将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要规范化的uri对象。
  • 返回值

    如果反规范化成功,则返回反规范化uri对象。

  • 示例

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

DataAbilityHelper.notifyChange(uri: string, callback: AsyncCallback<void>)

  • 接口说明

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

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要操作的数据的路径。
callback 只读 AsyncCallback<void> 回调方法
  • 返回值

    void

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var helper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
helper.notifyChange(
    "dataability:///com.example.DataAbility",
)

DataAbilityHelper.notifyChange(uri: string)

  • 接口说明

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

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要操作的数据的路径。
  • 返回值

    void

  • 示例

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

DataAbilityHelper.insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback<number>)

  • 接口说明

    将单个数据记录插入数据库(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要插入的数据的路径。
valuesBucket 只读 rdb.ValuesBucket 指示要插入的数据记录。如果此参数为空,将插入一个空行。
callback 只读 AsyncCallback<number> 回调方法
  • 返回值

    返回插入数据记录的索引。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const valueBucket = {
    "name": "rose",
    "age": 22,
    "salary": 200.5,
    "blobType": u8,
}
DAHelper.insert(
    "dataability:///com.example.DataAbility",
    valueBucket
)

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

  • 接口说明

    将单个数据记录插入数据库(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要插入的数据的路径。
valuesBucket 只读 rdb.ValuesBucket 指示要插入的数据记录。如果此参数为空,将插入一个空行。
  • 返回值

    返回插入数据记录的索引。

  • 示例

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

DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback<number>)

  • 接口说明

    将多个数据记录插入数据库(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要插入的数据的路径。
valuesBucket 只读 Array<rdb.ValuesBucket> 指示要插入的数据记录。
callback 只读 AsyncCallback<number> 回调方法
  • 返回值

    返回插入的数据记录数。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "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
)

DataAbilityHelper.batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>)

  • 接口说明

    将多个数据记录插入数据库(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要插入的数据的路径。
valuesBucket 只读 Array<rdb.ValuesBucket> 指示要插入的数据记录。
  • 返回值

    返回插入的数据记录数。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "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((void) => {
		console.info("==========================>batchInsertCallback=======================>");
});

DataAbilityHelper.delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback<number>)

  • 接口说明

    从数据库中删除一个或多个数据记录(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要删除的数据的路径。
valuesBucket 只读 dataAbility.DataAbilityPredicates 指示筛选条件。当此参数为null时,应定义处理逻辑。
callback 只读 AsyncCallback<number> 回调方法
  • 返回值

    返回已删除的数据记录数。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
    "dataability:///com.example.DataAbility",
    da
)

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

  • 接口说明

    从数据库中删除一个或多个数据记录(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要删除的数据的路径。
valuesBucket 只读 dataAbility.DataAbilityPredicates 指示筛选条件。当此参数为null时,应定义处理逻辑。
  • 返回值

    返回已删除的数据记录数。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
    "dataability:///com.example.DataAbility",
    da
	).then((void) => {
		console.info("==========================>deleteCallback=======================>");
});

DataAbilityHelper.update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback<number>)

  • 接口说明

    更新数据库中的数据记录(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要更新的数据的路径。
valuesBucket 只读 rdb.ValuesBucket 指示要更新的数据。
predicates 只读 dataAbility.DataAbilityPredicates 指示筛选条件。当此参数为null时,应定义处理逻辑。
callback 只读 AsyncCallback<number> 回调方法
  • 返回值

    返回更新的数据记录数。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "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
)

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

  • 接口说明

    更新数据库中的数据记录(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要更新的数据的路径。
valuesBucket 只读 rdb.ValuesBucket 指示要更新的数据。
predicates 只读 dataAbility.DataAbilityPredicates 指示筛选条件。当此参数为null时,应定义处理逻辑。
  • 返回值

    返回更新的数据记录数。

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "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((void) => {
		console.info("==========================>updateCallback=======================>");
});

DataAbilityHelper.query(uri: string, columns: Array<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback<ResultSet>)

  • 接口说明

    查询数据库中的数据(callback形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 只读 string 指示要查询的数据的路径。
columns 只读 rdb.ValuesBucket 指示要查询的列。如果此参数为空,则查询所有列。
predicates 只读 dataAbility.DataAbilityPredicates 指示筛选条件。当此参数为null时,应定义处理逻辑。
callback 只读 AsyncCallback<ResultSet> 回调方法
  • 返回值

    返回查询结果

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "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
)

DataAbilityHelper.query(uri: string, columns: Array<string>, predicates: dataAbility.DataAbilityPredicates)

  • 接口说明

    查询数据库中的数据(Promise形式)

  • 参数描述

名称 读写属性 类型 必填 描述
uri 读写 string 指示要查询的数据的路径。
columns 读写 rdb.ValuesBucket 指示要查询的列。如果此参数为空,则查询所有列。
predicates 读写 dataAbility.DataAbilityPredicates 指示筛选条件。当此参数为null时,应定义处理逻辑。
  • 返回值

    返回查询结果

  • 示例

import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = await featureAbility.getDataAbilityHelper(
    "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((void) => {
		console.info("==========================>queryCallback=======================>");
});