diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-dataShare.md b/zh-cn/application-dev/reference/apis/js-apis-data-dataShare.md index e0923836312ca90fb0a0127a9b681145219c46e6..d2f13efafe3d547c56e6177d0fc52a507accd789 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-dataShare.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-dataShare.md @@ -91,85 +91,12 @@ dataShare.createDataShareHelper(this.context, uri).then((data) => { DataShare管理工具实例，可使用此实例访问或管理服务端的数据。在调用DataShareHelper提供的方法前，需要先通过[createDataShareHelper](#datasharecreatedatasharehelper)构建一个实例。 -此接口仅可在Stage模型下使用。 - -### openFile - -openFile(uri: string, mode: string, callback: AsyncCallback<number>): void - -打开指定路径的文件。使用callback异步回调。 - -此接口仅可在Stage模型下使用。 - -**系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------- | --------------------- | ---- | ---------------------------------- | -| uri | string | 是 | 指示要打开的文件的路径。 | -| mode | string | 是 | 指示文件打开模式，如“r”表示只读访问，“w”表示只写访问（擦除文件中当前的任何数据），“wa”表示附加到任何现有数据的写访问，“rw”表示对任何现有数据的读写访问。 | -| callback | AsyncCallback<number> | 是 | 回调函数。当打开指定路径的文件成功，err为undefined，data为获取到的文件描述符；否则为错误对象。 | - -**示例：** - -```ts -import Ability from '@ohos.application.Ability' -let uri = ("datashare:///com.samples.datasharetest.DataShare"); -dataShareHelper.openFile(uri, "rwt", (err, data) => { - if (err != undefined) { - console.info("openFile failed, error message : " + err); - }else { - console.info("openFile succeed, data : " + data); - let fd = data; - } -}); -``` - -### openFile - -openFile(uri: string, mode: string): Promise<number> - -打开指定路径的文件。使用Promise异步回调。 - -此接口仅可在Stage模型下使用。 - -**系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | ------------------------------------------------------------ | -| uri | string | 是 | 指示要打开的文件的路径 | -| mode | string | 是 | 指示文件打开模式，如“r”表示只读访问，“w”表示只写访问（擦除文件中当前的任何数据），“wa”表示附加到任何现有数据的写访问，“rw”表示对任何现有数据的读写访问。 | - -**返回值：** - -| 类型 | 说明 | -| --------------- | ---------------- | -| Promise<number> | Promise对象。返回文件描述符。 | - -**示例：** - -```ts -import Ability from '@ohos.application.Ability' -let uri = ("datashare:///com.samples.datasharetest.DataShare"); -dataShareHelper.openFile(uri, "rwt").then((data) => { - console.info("openFile succeed, data : " + data); - let fd = data; -}).catch((err) => { - console.info("openFile failed, error message : " + err); -}) -``` - ### on('dataChange') on(type: 'dataChange', uri: string, callback: AsyncCallback<void>): void 订阅指定URI对应数据的数据变更事件。若用户（订阅者）已注册了观察者，当有其他用户触发了变更通知时（调用了下文中的notifyChange方法），订阅者将会接收到callback通知。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -197,8 +124,6 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>): void 取消订阅指定URI对应的数据资源的变更通知。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -226,8 +151,6 @@ insert(uri: string, value: ValuesBucket, callback: AsyncCallback<number>): 将单条数据插入数据库。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -263,8 +186,6 @@ insert(uri: string, value: ValuesBucket): Promise<number> 将单条数据插入数据库。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -303,8 +224,6 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac 从数据库中删除一条或多条数据记录。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -339,8 +258,6 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promis 从数据库中删除一条或多条数据记录。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -378,8 +295,6 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: 查询数据库中的数据。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -416,8 +331,6 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: 查询数据库中的数据。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -457,8 +370,6 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: 更新数据库中的数据记录。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -500,8 +411,6 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: 更新数据库中的数据记录。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -546,8 +455,6 @@ batchInsert(uri: string, values: Array<ValuesBucket>, callback: AsyncCallb 将批量数据插入数据库。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -581,8 +488,6 @@ batchInsert(uri: string, values: Array<ValuesBucket>): Promise<number&g 将批量数据插入数据库。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -613,149 +518,12 @@ dataShareHelper.batchInsert(uri, vbs).then((data) => { }); ``` -### getType - -getType(uri: string, callback: AsyncCallback<string>): void - -获取URI所指定的数据的MIME类型。使用callback异步回调。 - -此接口仅可在Stage模型下使用。 - -**系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------- | ---------------------- | ---- | --------------------------------------------- | -| uri | string | 是 | 表示指定的数据路径。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取URI所指定的数据的MIME类型成功，err为undefined，data为获取到的与URI指定的数据匹配的MIME类型；否则为错误对象。 | - -**示例：** - -```ts -import Ability from '@ohos.application.Ability' -let uri = ("datashare:///com.samples.datasharetest.DataShare"); -dataShareHelper.getType(uri, (err, data)=>{ - if (err != undefined) { - console.log("getType failed, error message : " + err); - }else{ - console.log("getType succeed, data : " + data); - let result = data; - } -}); -``` - -### getType - -getType(uri: string): Promise<string> - -获取URI所指定数据的MIME类型。使用Promise异步回调。 - -此接口仅可在Stage模型下使用。 - -**系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ------ | ---- | -------------------- | -| uri | string | 是 | 表示指定的数据路径。 | - -**返回值：** - -| 类型 | 说明 | -| ---------------- | ----------------------------------- | -| Promise<string> | Promise对象。返回与URI指定的数据匹配的MIME类型。 | - -**示例：** - -```ts -import Ability from '@ohos.application.Ability' -let uri = ("datashare:///com.samples.datasharetest.DataShare"); -dataShareHelper.getType(uri).then((data) => { - console.log("getType succeed, data : " + data); -}).catch((err) => { - console.log("getType failed, error message : " + err); -}); -``` - -### getFileTypes - -getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>): void - -获取支持的文件的MIME类型。使用callback异步回调。 - -此接口仅可在Stage模型下使用。 - -**系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| uri | string | 是 | 指示要获取的文件的路径。 | -| mimeTypeFilter | string | 是 | 指示要筛选的MIME类型。例如：
“\*/\*”：获取支持的所有类型。
“image/\*”：获取主类型image，子类型为任何类型的MIME。
”\*/jpg”：获取子类型为jpg，主类型为任何类型的MIME。 | -| callback | AsyncCallback> | 是 | 回调函数。当获取支持的文件的MIME类型成功，err为undefined，data为获取到的匹配的MIME类型数组；否则为错误对象。 | - -**示例：** - -```ts -import Ability from '@ohos.application.Ability' -let uri = ("datashare:///com.samples.datasharetest.DataShare"); -let mimeTypeFilter = "image/*"; -dataShareHelper.getFileTypes(uri, mimeTypeFilter, (err,data) => { - if (err != undefined) { - console.log("getFileTypes failed, error message : " + err); - }else{ - console.log("getFileTypes succeed, data : " + data); - } -}); -``` - -### getFileTypes - -getFileTypes(uri: string, mimeTypeFilter: string): Promise<Array<string>> - -获取支持的文件的MIME类型。使用Promise异步回调。 - -此接口仅可在Stage模型下使用。 - -**系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer - -**参数：** - -| 名称 | 类型 | 必填 | 描述 | -| -------------- | ------ | ---- | ------------------------------------------------------------ | -| uri | string | 是 | 指示要获取的文件的路径。 | -| mimeTypeFilter | string | 是 | 指示要筛选的MIME类型。例如：
“\*/\*”：获取支持的所有类型。
“image/\*”：获取主类型image，子类型为任何类型的MIME。
”\*/jpg”：获取子类型为jpg，主类型为任何类型的MIME。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------------ | ------------------------ | -| Promise<Array<string>> | Promise对象。返回匹配的MIME类型数组。 | - -**示例：** - -```ts -import Ability from '@ohos.application.Ability' -let uri = ("datashare:///com.samples.datasharetest.DataShare"); -let mimeTypeFilter = "image/*"; -dataShareHelper.getFileTypes(uri, mimeTypeFilter).then((data) => { - console.log("getFileTypes succeed, data : " + data); -}).catch((err) => { - console.log("getFileTypes failed, error message : " + err); -}); -``` - ### normalizeUri normalizeUri(uri: string, callback: AsyncCallback<string>): void 将给定的DataShare URI转换为规范化URI，规范化URI可供跨设备使用，DataShare URI仅供本地环境中使用。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -785,8 +553,6 @@ normalizeUri(uri: string): Promise<string> 将给定的DataShare URI转换为规范化URI，规范化URI可供跨设备使用，DataShare URI仅供本地环境中使用。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -819,8 +585,6 @@ denormalizeUri(uri: string, callback: AsyncCallback<string>): void 将指定的URI转换为非规范化URI。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -850,8 +614,6 @@ denormalizeUri(uri: string): Promise<string> 将指定的URI转换为非规范化URI。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -884,8 +646,6 @@ notifyChange(uri: string, callback: AsyncCallback<void>): void 通知已注册的观察者指定URI对应的数据资源已发生变更。使用callback异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：** @@ -911,8 +671,6 @@ notifyChange(uri: string): Promise<void> 通知已注册的观察者指定URI对应的数据资源已发生变更。使用Promise异步回调。 -此接口仅可在Stage模型下使用。 - **系统能力：** SystemCapability.DistributedDataManager.DataShare.Consumer **参数：**