Folder Class - Author-it On-Premises - Author-it

Author-it Development Documentation

Provides access to Author-it folders.

Namespace: Authorit.API.Services

Constructors

Name

Description

Method

Folder()

Initializes a new instance of the Folder class.

Properties

Class contains no properties.

Methods

Name

Description

Method

Get(int)

Gets the specified folder by ID.

Method

GetByName(string)

Gets all folders matching specified name.

Method

GetByParentAndName(int, string)

Get folder with specified parent folder ID and name.

Method

GetByGuid(System.Guid)

Get a folder by GUID.

Method

GetIdForGuid(System.Guid)

Get folder ID for a supplied folder GUID.

Method

GetGuidForId(int)

Get folder GUID for supplied folder ID.

Method

GetChildren(int)

Get child folders of supplied parent folder.

Method

GetPathToFolder(int)

Gets list of parent folders to navigate to get to a specific folder.

Method

EnsureExists(int, string)

Create a folder if it doesn't already exist.

Method

Create(int, string)

Create a new folder in library.

Method

Rename(int, string)

Rename a folder.

Method

Move(int, int)

Move a folder to a new parent folder.

Method

Delete(int)

Delete a folder.

Method

IsValidFolderId(int, bool)

Checks if the supplied integer is a valid folder ID.

Method

CheckSubfolderExists(int, string)

Checks if a folder contains a subfolder with the supplied name.