DataAbilityHelper模塊(JS端SDK接口)

說明：

本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。
本模塊接口僅可在FA模型下使用。

使用說明

使用前根據(jù)具體情況引入如下模塊

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

開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

DataAbilityHelper.openFile

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

在指定的遠(yuǎn)程路徑中打開文件（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

在指定的遠(yuǎn)程路徑中打開文件（promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

注冊(cè)觀察者以觀察給定uri指定的數(shù)據(jù)callback通知。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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指定的數(shù)據(jù)callback通知。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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指定數(shù)據(jù)的MIME類型（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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指定數(shù)據(jù)的MIME類型（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

將引用數(shù)據(jù)功能的給定uri轉(zhuǎn)換為規(guī)范化uri（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

將引用數(shù)據(jù)功能的給定uri轉(zhuǎn)換為規(guī)范化uri（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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）生成的給定規(guī)范化uri轉(zhuǎn)換為非規(guī)范化uri（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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）生成的給定規(guī)范化uri轉(zhuǎn)換為非規(guī)范化uri（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

通知已注冊(cè)的觀察者uri指定的數(shù)據(jù)資源的更改（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

通知已注冊(cè)的觀察者uri指定的數(shù)據(jù)資源的更改（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

將單個(gè)數(shù)據(jù)記錄插入數(shù)據(jù)庫（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

將單個(gè)數(shù)據(jù)記錄插入數(shù)據(jù)庫（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

插入數(shù)據(jù)庫（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

將多個(gè)數(shù)據(jù)記錄插入數(shù)據(jù)庫（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

從數(shù)據(jù)庫中刪除一個(gè)或多個(gè)數(shù)據(jù)記錄（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

從數(shù)據(jù)庫中刪除一個(gè)或多個(gè)數(shù)據(jù)記錄（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

更新數(shù)據(jù)庫中的數(shù)據(jù)記錄（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

更新數(shù)據(jù)庫中的數(shù)據(jù)記錄（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

查詢數(shù)據(jù)庫中的數(shù)據(jù)（callback形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

查詢數(shù)據(jù)庫中的數(shù)據(jù)（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

調(diào)用DataAbility的擴(kuò)展接口，使用Promise方式作為異步方法。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

返回值：

示例：

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

調(diào)用DataAbility的擴(kuò)展接口，使用callback方式作為異步方法。

系統(tǒng)能力 ：SystemCapability.Ability.AbilityRuntime.FAModel

參數(shù)：

示例：

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

審核編輯 黃宇