目录

管理侧边栏文件夹(C/C++)

从26.0.1开始,新增支持将云盘同步文件夹添加到文件管理器侧边栏进行管理。

场景介绍

云盘应用将同步文件夹添加到文件管理器侧边栏后,用户可在文件管理器中直接访问该文件夹,无需打开云盘应用。典型场景包括:

接口说明

接口名 描述
HMS_FileManagerService_AddToSidebar(HMS_FileManagerService_SupportFolderType folderType, const HMS_FileManagerService_SidebarFolder *sidebarFolder) 将文件夹添加到侧边栏。
HMS_FileManagerService_RemoveFromSidebar(HMS_FileManagerService_SupportFolderType folderType, const char *uri) 从侧边栏删除文件夹。
HMS_FileManagerService_SetFolderIcon(HMS_FileManagerService_SupportFolderType folderType, const char *uri, const char *iconResId) 设置文件夹图标。
HMS_FileManagerService_UnSetFolderIcon(HMS_FileManagerService_SupportFolderType folderType, const char *uri) 取消设置文件夹图标。

开发步骤

  1. 在CMake脚本中链接相关动态库。

    find_library(filemanager-service-lib libfilemanager_service_ndk.z.so)
    target_link_libraries(entry PUBLIC ${filemanager-service-lib})
  2. 引入头文件。

    #include <filemanager_service.h>
  3. 申请权限。使用本接口前,需要在module.json5中声明所需的权限:ohos.permission.SYNC_ROOT_MANAGER。具体指导可见声明权限。

  4. 当需要将同步文件夹展示到文件管理器侧边栏时,构造侧边栏文件夹信息,调用HMS_FileManagerService_AddToSidebar将文件夹添加到侧边栏。

    HMS_FileManagerService_SidebarFolder folder = {0};
    folder.uri = "file://docs/storage/Users/currentUser/Documents/cloudFolder";
    folder.iconResId = "icon_cloud_folder";
    folder.displayNameResId = "str_cloud_folder_name";
    folder.alias = "cloudFolder";
    
    HMS_FileManagerService_AddToSidebar(HMS_FILEMANAGERSERVICE_FOLDER_TYPE_CLOUD, &folder);
  5. 当需要为侧边栏文件夹设置自定义图标时,调用HMS_FileManagerService_SetFolderIcon设置文件夹图标。

    HMS_FileManagerService_SetFolderIcon(
        HMS_FILEMANAGERSERVICE_FOLDER_TYPE_CLOUD,
        "file://docs/storage/Users/currentUser/Documents/cloudFolder",
        "icon_custom");
  6. 当不再需要自定义图标时,调用HMS_FileManagerService_UnSetFolderIcon取消设置文件夹图标。

    HMS_FileManagerService_UnSetFolderIcon(
        HMS_FILEMANAGERSERVICE_FOLDER_TYPE_CLOUD,
        "file://docs/storage/Users/currentUser/Documents/cloudFolder");
  7. 当文件夹不再需要展示在侧边栏时,调用HMS_FileManagerService_RemoveFromSidebar从侧边栏删除文件夹。

    HMS_FileManagerService_RemoveFromSidebar(
        HMS_FILEMANAGERSERVICE_FOLDER_TYPE_CLOUD,
        "file://docs/storage/Users/currentUser/Documents/cloudFolder");