Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“36dcea7be3302c200bde4554f93c47a8442c6698”上不存在“zh-cn/application-dev/database/database-storage-overview.md”
未验证 提交 f5ec6e39 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!23080 给documentPicker的option补充新增参数 

Merge pull request !23080 from yxn22/cherry-pick-1693013499
上级 1da6e078 a97019ea
显示空白变更内容
内联 并排
Showing with 38 addition and 31 deletion
zh-cn/application-dev/file-management/save-user-file.md
浏览文件 @ f5ec6e39
...@@ -58,7 +58,7 @@ save接口会将文件保存在文件管理器，而不是图库。 ...@@ -58,7 +58,7 @@ save接口会将文件保存在文件管理器，而不是图库。
save返回的uri权限是读写权限，可以根据结果集里面的uri进行文件读写等操作。注意不能在picker的回调里直接使用此uri进行打开文件操作，需要定义一个全局变量保存uri，使用类似一个按钮去触发打开文件。 save返回的uri权限是读写权限，可以根据结果集里面的uri进行文件读写等操作。注意不能在picker的回调里直接使用此uri进行打开文件操作，需要定义一个全局变量保存uri，使用类似一个按钮去触发打开文件。
```ts ```ts
let uri:string; let uris = null;
async photoViewPickerSave() { async photoViewPickerSave() {
try { try {
const photoSaveOptions = new picker.PhotoSaveOptions(); // 创建文件管理器保存选项实例 const photoSaveOptions = new picker.PhotoSaveOptions(); // 创建文件管理器保存选项实例
...@@ -68,9 +68,8 @@ save接口会将文件保存在文件管理器，而不是图库。 ...@@ -68,9 +68,8 @@ save接口会将文件保存在文件管理器，而不是图库。
try { try {
let photoSaveResult = await photoViewPicker.save(photoSaveOptions); let photoSaveResult = await photoViewPicker.save(photoSaveOptions);
if (photoSaveResult != undefined) { if (photoSaveResult != undefined) {
console.info("[picker] photoViewPickerSave photoSaveResult = " + JSON.stringify(photoSaveResult)); uris = photoSaveResult;
this.uri = photoSaveResult[0]; console.info('photoViewPicker.save to file succeed and uris are:' + uris);
console.info('photoViewPicker.save to file succeed and uri is:' + photoSaveResult[0]);
} }
} catch (err) { } catch (err) {
console.error(`[picker] Invoke photoViewPicker.save failed, code is ${err.code}, message is ${err.message}`); console.error(`[picker] Invoke photoViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
...@@ -112,6 +111,7 @@ save接口会将文件保存在文件管理器，而不是图库。 ...@@ -112,6 +111,7 @@ save接口会将文件保存在文件管理器，而不是图库。
```ts ```ts
const documentSaveOptions = new picker.DocumentSaveOptions(); // 创建文件管理器选项实例 const documentSaveOptions = new picker.DocumentSaveOptions(); // 创建文件管理器选项实例
documentSaveOptions.newFileNames = ["DocumentViewPicker01.txt"]; // 保存文件名（可选） documentSaveOptions.newFileNames = ["DocumentViewPicker01.txt"]; // 保存文件名（可选）
documentSaveOptions.fileSuffixChoices = ['.png', '.txt', '.mp4']; // 保存文件类型（可选）
``` ```
3. 创建文档选择器实例。调用[save()](../reference/apis/js-apis-file-picker.md#save-3)接口拉起FilePicker界面进行文件保存。用户选择目标文件夹，用户选择与文件类型相对应的文件夹，即可完成文件保存操作。保存成功后，返回保存文档的uri。 3. 创建文档选择器实例。调用[save()](../reference/apis/js-apis-file-picker.md#save-3)接口拉起FilePicker界面进行文件保存。用户选择目标文件夹，用户选择与文件类型相对应的文件夹，即可完成文件保存操作。保存成功后，返回保存文档的uri。
...@@ -119,11 +119,11 @@ save接口会将文件保存在文件管理器，而不是图库。 ...@@ -119,11 +119,11 @@ save接口会将文件保存在文件管理器，而不是图库。
</br>save返回的uri权限是读写权限，可以根据结果集中uri进行文件读写等操作。注意不能在picker的回调里直接使用此uri进行打开文件操作，需要定义一个全局变量保存uri，使用类似一个按钮去触发打开文件。 </br>save返回的uri权限是读写权限，可以根据结果集中uri进行文件读写等操作。注意不能在picker的回调里直接使用此uri进行打开文件操作，需要定义一个全局变量保存uri，使用类似一个按钮去触发打开文件。
```ts ```ts
let uri = null; let uris = null;
const documentViewPicker = new picker.DocumentViewPicker(); // 创建文件选择器实例 const documentViewPicker = new picker.DocumentViewPicker(); // 创建文件选择器实例
documentViewPicker.save(documentSaveOptions).then((documentSaveResult) => { documentViewPicker.save(documentSaveOptions).then((documentSaveResult) => {
uri = documentSaveResult[0]; uris = documentSaveResult;
console.info('documentViewPicker.save to file succeed and uri is:' + uri); console.info('documentViewPicker.save to file succeed and uris are:' + uris);
}).catch((err) => { }).catch((err) => {
console.error(`Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
}) })
......
zh-cn/application-dev/file-management/select-user-file.md
浏览文件 @ f5ec6e39
...@@ -38,11 +38,11 @@ ...@@ -38,11 +38,11 @@
</br>select返回的uri权限是只读权限，可以根据结果集中uri进行读取文件数据操作。注意不能在picker的回调里直接使用此uri进行打开文件操作，需要定义一个全局变量保存uri，使用类似一个按钮去触发打开文件。 </br>select返回的uri权限是只读权限，可以根据结果集中uri进行读取文件数据操作。注意不能在picker的回调里直接使用此uri进行打开文件操作，需要定义一个全局变量保存uri，使用类似一个按钮去触发打开文件。
```ts ```ts
let uri = null; let uris = null;
const photoViewPicker = new picker.PhotoViewPicker(); const photoViewPicker = new picker.PhotoViewPicker();
photoViewPicker.select(photoSelectOptions).then((photoSelectResult) => { photoViewPicker.select(photoSelectOptions).then((photoSelectResult) => {
uri = photoSelectResult.photoUris[0]; uris = photoSelectResult.photoUris;
console.info('photoViewPicker.select to file succeed and uri is:' + uri); console.info('photoViewPicker.select to file succeed and uris are:' + uris);
}).catch((err) => { }).catch((err) => {
console.error(`Invoke photoViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke photoViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
}) })
...@@ -77,6 +77,9 @@ ...@@ -77,6 +77,9 @@
```ts ```ts
const documentSelectOptions = new picker.DocumentSelectOptions(); const documentSelectOptions = new picker.DocumentSelectOptions();
documentSelectOptions.maxSelectNumber = 5; // 选择文档的最大数目（可选）
documentSelectOptions.defaultFilePathUri = "file://docs/storage/Users/currentUser/test"; // 指定选择的文件或者目录路径（可选）
documentSelectOptions.fileSuffixFilters = ['.png', '.txt', '.mp4']; // 选择文件的后缀类型（可选）
``` ```
3. 创建文档选择器实例。调用[select()](../reference/apis/js-apis-file-picker.md#select-3)接口拉起FilePicker界面进行文件选择。文件选择成功后，返回被选中文档的uri结果集。 3. 创建文档选择器实例。调用[select()](../reference/apis/js-apis-file-picker.md#select-3)接口拉起FilePicker界面进行文件选择。文件选择成功后，返回被选中文档的uri结果集。
...@@ -85,16 +88,12 @@ ...@@ -85,16 +88,12 @@
</br>例如通过[文件管理接口](../reference/apis/js-apis-file-fs.md)根据uri获取部分文件属性信息，比如文件大小、访问时间、修改时间等。如有获取文件名称需求，请暂时使用[startAbilityForResult](../../application-dev/application-models/uiability-intra-device-interaction.md)获取。 </br>例如通过[文件管理接口](../reference/apis/js-apis-file-fs.md)根据uri获取部分文件属性信息，比如文件大小、访问时间、修改时间等。如有获取文件名称需求，请暂时使用[startAbilityForResult](../../application-dev/application-models/uiability-intra-device-interaction.md)获取。
> **说明：**
>
> 目前DocumentSelectOptions不支持参数配置，默认可以选择所有类型的用户文件。
```ts ```ts
let uri = null; let uris = null;
const documentViewPicker = new picker.DocumentViewPicker(); // 创建文件选择器实例 const documentViewPicker = new picker.DocumentViewPicker(); // 创建文件选择器实例
documentViewPicker.select(documentSelectOptions).then((documentSelectResult) => { documentViewPicker.select(documentSelectOptions).then((documentSelectResult) => {
uri = documentSelectResult[0]; uris = documentSelectResult;
console.info('documentViewPicker.select to file succeed and uri is:' + uri); console.info('documentViewPicker.select to file succeed and uris are:' + uris);
}).catch((err) => { }).catch((err) => {
console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
}) })
...@@ -172,7 +171,7 @@ ...@@ -172,7 +171,7 @@
let uri = null; let uri = null;
const audioViewPicker = new picker.AudioViewPicker(); const audioViewPicker = new picker.AudioViewPicker();
audioViewPicker.select(audioSelectOptions).then(audioSelectResult => { audioViewPicker.select(audioSelectOptions).then(audioSelectResult => {
uri = audioSelectOptions[0]; uri = audioSelectResult[0];
console.info('audioViewPicker.select to file succeed and uri is:' + uri); console.info('audioViewPicker.select to file succeed and uri is:' + uri);
}).catch((err) => { }).catch((err) => {
console.error(`Invoke audioViewPicker.select failed, code is ${err.code}, message is ${err.message}`); console.error(`Invoke audioViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
......
zh-cn/application-dev/reference/apis/js-apis-file-picker.md
浏览文件 @ f5ec6e39
...@@ -244,7 +244,7 @@ async function example() { ...@@ -244,7 +244,7 @@ async function example() {
## DocumentViewPicker ## DocumentViewPicker
文件选择器对象，用来支撑选择和保存非媒体文件等用户场景，比如各种格式文档。在使用前，需要先创建DocumentViewPicker实例。 文件选择器对象，用来支撑选择和保存各种格式文档。在使用前，需要先创建DocumentViewPicker实例。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
...@@ -699,7 +699,7 @@ async function example() { ...@@ -699,7 +699,7 @@ async function example() {
枚举，可选择的媒体文件类型。 枚举，可选择的媒体文件类型。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----- | ---- | ---- | | ----- | ---- | ---- |
...@@ -711,18 +711,18 @@ async function example() { ...@@ -711,18 +711,18 @@ async function example() {
图库选择选项。 图库选择选项。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------------- | ------------------- | ---- | -------------------------------- | | ----------------------- | ------------------- | ---- | -------------------------------- |
| MIMEType? | [PhotoViewMIMETypes](#photoviewmimetypes) | 否 | 可选择的媒体文件类型，若无此参数，则默认为图片和视频类型 | | MIMEType | [PhotoViewMIMETypes](#photoviewmimetypes) | 否 | 可选择的媒体文件类型，若无此参数，则默认为图片和视频类型 |
| maxSelectNumber? | number | 否 | 选择媒体文件数量的最大值(默认值为50，最大值为500) | | maxSelectNumber | number | 否 | 选择媒体文件数量的最大值(默认值为50，最大值为500) |
## PhotoSelectResult ## PhotoSelectResult
返回图库选择后的结果集。 返回图库选择后的结果集。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ------------------- | ---- | ---- | ------------------------------ | | ----------------------- | ------------------- | ---- | ---- | ------------------------------ |
...@@ -733,27 +733,35 @@ async function example() { ...@@ -733,27 +733,35 @@ async function example() {
图片或视频的保存选项。 图片或视频的保存选项。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------------- | ------------------- | ---- | ---------------------------- | | ----------------------- | ------------------- | ---- | ---------------------------- |
| newFileNames? | Array&lt;string&gt; | 否 | 拉起photoPicker进行保存图片或视频资源的文件名，若无此参数，则默认需要用户自行输入 | | newFileNames | Array&lt;string&gt; | 否 | 拉起photoPicker进行保存图片或视频资源的文件名，若无此参数，则默认需要用户自行输入 |
## DocumentSelectOptions ## DocumentSelectOptions
文档选择选项，目前不支持参数配置。 文档选择选项。
**系统能力：** SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 类型 | 必填 | 说明 |
| ----------------------- | ------------------- | ---- | -------------------------------- |
| maxSelectNumber | number | 否 | 选择文件/目录最大个数，上限500，有效值范围1-500 |
| defaultFilePathUri | string | 否 | 指定选择的文件或者目录路径 |
| fileSuffixFilters | Array&lt;string&gt; | 否 | 选择文件的后缀类型 |
## DocumentSaveOptions ## DocumentSaveOptions
文档保存选项。 文档保存选项。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------------- | ------------------- | ---- | ---------------------------- | | ----------------------- | ------------------- | ---- | ---------------------------- |
| newFileNames? | Array&lt;string&gt; | 否 | 拉起documentPicker进行保存的文件名，若无此参数，则默认需要用户自行输入 | | newFileNames | Array&lt;string&gt; | 否 | 拉起documentPicker进行保存的文件名，若无此参数，则默认需要用户自行输入 |
| defaultFilePathUri | string | 否 | 指定保存的文件或者目录路径 |
| fileSuffixChoices | Array&lt;string&gt; | 否 | 保存文件的后缀类型 |
## AudioSelectOptions ## AudioSelectOptions
...@@ -765,8 +773,8 @@ async function example() { ...@@ -765,8 +773,8 @@ async function example() {
音频的保存选项。 音频的保存选项。
**系统能力：** 以下各项对应的系统能力均为 SystemCapability.FileManagement.UserFileService **系统能力：** SystemCapability.FileManagement.UserFileService
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------------- | ------------------- | ---- | ---------------------------- | | ----------------------- | ------------------- | ---- | ---------------------------- |
| newFileNames? | Array&lt;string&gt; | 否 | 拉起audioPicker进行保存音频资源的文件名，若无此参数，则默认需要用户自行输入 | | newFileNames | Array&lt;string&gt; | 否 | 拉起audioPicker进行保存音频资源的文件名，若无此参数，则默认需要用户自行输入 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或