提交 44970dcb 编写于 作者: S songruirui

修改

Signed-off-by: Nsongruirui <songruirui1@huawei.com>
上级 f80fcd9f
......@@ -4,9 +4,9 @@
>**说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。仅限系统应用。
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
>以下接口全部为系统接口,三方应用不支持调用。
>本模块接口均为系统接口,三方应用不支持调用。
## 导入模块
......@@ -28,7 +28,7 @@ DataShare客户端连接DataShareExtensionAbility服务端时,服务端回调
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| want | [Want](js-apis-application-Want.md#want) | 是 | Want类型信息,包括ability名称、bundle名称等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。无返回值。 |
**示例:**
......@@ -71,8 +71,8 @@ insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;numbe
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri |string | 是 | 指示要插入的数据的路径。 |
| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据记录。 |
| callback |AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。 |
| callback |AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入数据记录的索引。 |
**示例:**
......@@ -110,7 +110,7 @@ update?(uri: string, predicates: DataSharePredicates, valueBucket: ValuesBucket,
| uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回更新的数据记录数。 |
**示例:**
......@@ -135,7 +135,7 @@ update(uri, predicates, value, callback) {
query?(uri: string, predicates: DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;Object&gt;): void
在查询数据库时服务端回调此接口,该方法可以选择性重写。
在查询数据库时服务端回调此接口该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
......@@ -146,7 +146,7 @@ query?(uri: string, predicates: DataSharePredicates, columns: Array&lt;string&gt
| uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback&lt;Object&gt; | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;Object&gt; | 是 | 回调函数。返回查询到的结果集。 |
**示例:**
......@@ -174,17 +174,17 @@ query(uri, predicates, columns, callback) {
delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
在删除数据库记录时服务端回调此接口,该方法可以选择性重写。
在删除数据库记录时服务端回调此接口该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
**参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
| 名称 | 参数类型 | 必填 | 说明 |
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回已删除的数据记录数。 |
**示例:**
......@@ -209,17 +209,17 @@ delete(uri, predicates, callback) {
BatchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
在数据库批量插入时服务端回调此接口,该方法可以选择性重写。
在数据库批量插入时服务端回调此接口该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
**参数:**
| 名称 | 参数类型 | 必填 | 说明 |
| ------------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要批量插入的数据记录。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
| 名称 | 参数类型 | 必填 | 说明 |
| ------------ | ------------------------------------------------------------ | ---- | -------------------------------- |
| uri | string | 是 | 指示要批量插入的数据的路径。 |
| valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要批量插入的数据 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入的数据记录数。 |
**示例:**
......@@ -248,7 +248,7 @@ batchInsert(uri: string, valueBuckets, callback) {
getType?(uri: string, callback: AsyncCallback&lt;string&gt;): void
获取给定uri对应的MIME类型时服务端回调此接口,该方法可以选择性重写。
获取给定URI对应的MIME类型时服务端回调此接口,该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
......@@ -257,7 +257,7 @@ getType?(uri: string, callback: AsyncCallback&lt;string&gt;): void
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要获取MIME类型的数据的路径。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。返回与URI指定的数据匹配的MIME类型。 |
**示例:**
......@@ -273,17 +273,17 @@ getType(uri: string, callback) {
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取支持文件的MIME类型时服务端回调此接口,该方法可以选择性重写。
获取支持文件的MIME类型时服务端回调此接口该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------- | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 表示被指定的回调方法。 |
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调函数。返回匹配的MIME类型数组。 |
**示例:**
......@@ -299,7 +299,7 @@ getFileTypes(uri: string, mimeTypeFilter: string,callback) {
normalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
用户给定的uri转换为服务端使用的uri时回调此接口,该方法可以选择性重写。
用户给定的URI转换为服务端使用的URI时回调此接口,该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
......@@ -307,8 +307,8 @@ normalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ----------------------- |
| uri | string | 是 | 指示用户传入的uri。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
| uri | string | 是 | 指示用户传入的URI。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。如果支持URI规范化,则返回规范化URI,否则返回空。 |
**示例:**
......@@ -324,7 +324,7 @@ normalizeUri(uri: string, callback) {
denormalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
服务端使用的uri转换为用户传入的初始uri时服务端回调此接口,该方法可以选择性重写。
服务端使用的URI转换为用户传入的初始URI时服务端回调此接口,该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
......@@ -333,7 +333,7 @@ denormalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ----------------------- |
| uri | string | 是 | 指示服务端使用的uri。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。如果反规范化成功,则返回反规范化的URI;如果无需进行反规范化,则返回原始URI;若不支持则返回空。 |
**示例:**
......@@ -349,7 +349,7 @@ denormalizeUri(uri: string, callback) {
openFile?(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
在打开文件时服务端回调此接口,该方法可以选择性重写。
在打开文件时服务端回调此接口该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider。
......@@ -357,9 +357,9 @@ openFile?(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): voi
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式,包括只读模式,读写模式。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回文件描述符。 |
**示例:**
......
......@@ -723,7 +723,7 @@ dataSharePredicates.groupBy(["AGE", "NAME"])
indexedBy(field: string): DataSharePredicates
该接口用于配置谓词以指定索引列。目前仅RDB支持该谓词。
该接口用于配置谓词按指定索引列查询结果。目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......
......@@ -142,15 +142,15 @@ console.info('resultSet.goToPreviousRow: ' + isGoToPreviousRow);
goTo(offset:number): boolean
向前或向后转至结果集的指定行,相对于其当前位置偏移
相对于当前位置向前或向后移动指定行数
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
**参数:**
| **参数名** | **类型** | **必填** | 说明 |
| ---------- | -------- | -------- | ---------------------------- |
| offset | number | 是 | 表示相对于当前位置的偏移量。 |
| **参数名** | **类型** | **必填** | 说明 |
| ---------- | -------- | -------- | ------------------------------------------------------------ |
| offset | number | 是 | 表示相对于当前位置的偏移量。offset为负值表示向前偏移,正值则表示向后偏移。 |
**返回值:**
......
# ValuesBucket
**数据集(ValuesBucket)**是开发者向数据库插入的数据集合,数据集以键-值对的形式进行传输。
**数据集(ValuesBucket)** 是开发者向数据库插入的数据集合,数据集以键-值对的形式进行传输。
>**说明:**
>
......
......@@ -84,7 +84,7 @@ dataShare.createDataShareHelper(this.context, dseUri).then((data) => {
## DataShareHelper
DataShare管理工具实例,可使用此实例访问或管理服务端的数据。在调用DataShareHelper提供的方法前,需要先通过[createDataShareHelper](#dataShare.createDataShareHelper)构建一个实例。
DataShare管理工具实例,可使用此实例访问或管理服务端的数据。在调用DataShareHelper提供的方法前,需要先通过[createDataShareHelper](#datashare.createdatasharehelper)构建一个实例。
### openFile
......@@ -368,7 +368,7 @@ dataShareHelper.getFileTypes(uri, mimeTypeFilter, (err,data) => {
getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt;&gt;
获取支持的文件的MIME类型。使用callback异步回调。
获取支持的文件的MIME类型。使用Promise异步回调。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Consumer
......@@ -472,7 +472,7 @@ denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要反规范化的URI。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。如果反规范化成功,则返回反规范化的URI;如果无需执行任何操作,则返回原始URI;若不支持则返回空。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。如果反规范化成功,则返回反规范化的URI;如果无需进行反规范化,则返回原始URI;若不支持则返回空。 |
**示例:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册