Interface IFolderManager


public interface IFolderManager
Since:
3.8.3
  • Field Details

  • Method Details

    • getFolder

      @NotNull IFolder getFolder(@Nullable String projectId, @NotNull String name)
      Returns IFolder for the given name from the project given by projectId. Use null as the projectId for the global context.
    • getFolders

      @NotNull List<IFolder> getFolders(@Nullable String projectId)
      Returns a list of all IFolder sorted in ascending order by IFolder.getTitleOrName() from the given project. Use null as the projectId for the global context.
    • getRootFolders

      @NotNull List<IFolder> getRootFolders(@Nullable String projectId)
      Returns a list of the root IFolder sorted in ascending order by IFolder.getTitleOrName() from the given project. Use null as the projectId for the global context.
      Since:
      3.18.1
    • existFolder

      boolean existFolder(@Nullable String projectId, @NotNull String name)
      Check if the folder with the given name and project exists.
      Since:
      3.18.1
    • createFolder

      @NotNull IFolder createFolder(@Nullable String projectId, @NotNull String name, @Nullable String title)
      Creates a new root IFolder under the "Documents & Pages" root Topic. Use null as the projectId for the global context.
      Parameters:
      name - (ID) must be unique for the whole folder hierarchy.
      Returns:
      Just created IFolder.
      Since:
      3.18.1