From 7a030acfe9c5e3ceff3c0ae280f44b5b5db6b802 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Fri, 14 Jan 2022 09:52:50 +0800 Subject: [PATCH] update readme Signed-off-by: panqiangbiao --- README.en.md | 36 ------------------------------- README.md | 60 ++++++++++++++++++++++++---------------------------- README_zh.md | 40 +++++++++++++++++++++++++++++++++++ 3 files changed, 68 insertions(+), 68 deletions(-) delete mode 100644 README.en.md create mode 100644 README_zh.md diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 1d37300c..00000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# storage_user_file_manger - -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md index 71ca86ba..1d37300c 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,36 @@ -# 公共文件管理 +# storage_user_file_manger -## 简介 +#### Description +{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} -公共文件管理提供了公共文件管理接口。 +#### Software Architecture +Software architecture description -公共文件的管理中File Manager Service服务向下对接底层文件管理服务，如媒体库、外卡管理。File Manager Service服务向上对接应用提供公共文件查询、创建的能力，如图1。 File Manager Service接口能力当前只对系统应用如文件选择器提供。 +#### Installation -支持能力列举如下： -- 查询、创建公共文件路径下媒体文件。媒体文件包括图片、音频、视频。媒体文件通过相册方式呈现。 +1. xxxx +2. xxxx +3. xxxx -- 查询、创建公共文件路径下文档文件。文档文件包括其他文件、外部存储卡内的文件。文件以目录树方式呈现。 +#### Instructions -**图 1** 公共文件管理架构图 -![](figures/user_file_manager.png "公共文件管理架构图") +1. xxxx +2. xxxx +3. xxxx -## 目录 +#### Contribution -仓目录结构如下: -``` -/foundation/storage/user_file_service -├── figures # 插图文件 -├── serivce # 服务实现 -│   ├── etc # 内部接口实现 -│   ├── src # 内部接口实现 -├── interfaces # 接口代码 -│   ├── innerkits # 内部 Native 接口 -│   └── kits # 外部 JS 接口 -├── LICENSE # 证书文件 -├── ohos.build # 编译文件 -└── sa_profile # 服务配置文件 -``` -## 说明 -### 使用说明 -1. 创建文件 - - 提供createFile接口，传入文件名与相册uri进行文件创建。 - - 文件创建成功后，可获得文件uri。应用可通过uri进行文件打开并进行读写操作。 -2. 查询文件 - - 提供listFile接口，传入文件类型、相册uri进行文件查询。 - - 获得相册下文件信息的集合，包括文件名、文件类型、文件大小、文件创建时间等信息。 \ No newline at end of file +1. Fork the repository +2. Create Feat_xxx branch +3. Commit your code +4. Create Pull Request + + +#### Gitee Feature + +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 00000000..71ca86ba --- /dev/null +++ b/README_zh.md @@ -0,0 +1,40 @@ +# 公共文件管理 + +## 简介 + +公共文件管理提供了公共文件管理接口。 + +公共文件的管理中File Manager Service服务向下对接底层文件管理服务，如媒体库、外卡管理。File Manager Service服务向上对接应用提供公共文件查询、创建的能力，如图1。 File Manager Service接口能力当前只对系统应用如文件选择器提供。 + +支持能力列举如下： +- 查询、创建公共文件路径下媒体文件。媒体文件包括图片、音频、视频。媒体文件通过相册方式呈现。 + +- 查询、创建公共文件路径下文档文件。文档文件包括其他文件、外部存储卡内的文件。文件以目录树方式呈现。 + +**图 1** 公共文件管理架构图 +![](figures/user_file_manager.png "公共文件管理架构图") + +## 目录 + +仓目录结构如下: +``` +/foundation/storage/user_file_service +├── figures # 插图文件 +├── serivce # 服务实现 +│   ├── etc # 内部接口实现 +│   ├── src # 内部接口实现 +├── interfaces # 接口代码 +│   ├── innerkits # 内部 Native 接口 +│   └── kits # 外部 JS 接口 +├── LICENSE # 证书文件 +├── ohos.build # 编译文件 +└── sa_profile # 服务配置文件 +``` +## 说明 +### 使用说明 +1. 创建文件 + - 提供createFile接口，传入文件名与相册uri进行文件创建。 + - 文件创建成功后，可获得文件uri。应用可通过uri进行文件打开并进行读写操作。 +2. 查询文件 + - 提供listFile接口，传入文件类型、相册uri进行文件查询。 + - 获得相册下文件信息的集合，包括文件名、文件类型、文件大小、文件创建时间等信息。 \ No newline at end of file