Interface IFolderService

Namespace

Oqtane.Services

Assembly

Oqtane.Client.dll

Service to get / create / modify Folder objects.

public interface IFolderService

Methods

AddFolderAsync(Folder)

Create one Folder using a Folder object.

Task<Folder> AddFolderAsync(Folder folder)

Parameters

folder Folder

Returns

Task<Folder>

DeleteFolderAsync(int)

Delete a Folder

Task DeleteFolderAsync(int folderId)

Parameters

folderId int

Reference to a Folder

Returns

Task

GetFolderAsync(int)

Retrieve the information of one Folder

Task<Folder> GetFolderAsync(int folderId)

Parameters

folderId int

Returns

Task<Folder>

GetFolderAsync(int, string)

Get a Folder of a Site based on the path.

Task<Folder> GetFolderAsync(int siteId, string folderPath)

Parameters

siteId int

Reference to the Site

folderPath string

Path of the folder TODO: todoc verify exactly from where the folder path must start

Returns

Task<Folder>

GetFoldersAsync(int)

Retrieve root folders of a Site

Task<List<Folder>> GetFoldersAsync(int siteId)

Parameters

siteId int

Returns

Task<List<Folder>>

UpdateFolderAsync(Folder)

Update the information about a Folder Use this to rename the folder etc.

Task<Folder> UpdateFolderAsync(Folder folder)

Parameters

folder Folder

Returns

Task<Folder>

UpdateFolderOrderAsync(int, int, int?)

Update the internal Folder-Order within the list of Folders.

Task UpdateFolderOrderAsync(int siteId, int folderId, int? parentId)

Parameters

siteId int

Reference to the Site

folderId int

Reference to a Folder for the security check

parentId int?

Reference to the Parent Folder or null - this Folders children will be re-sorted.

Returns

Task