FolderObject Class

Namespace: bcpDevKit.Entities.Vault
Assembly: bcpDevKit.dll

Syntax

public class FolderObject

Properties

Type	Name	Description
FolderObject	ParentFolder	Gives direct access to the parent folder of the current folder.
string	StandardFolderCategory	Gets or sets the standard folder category.
string	Name	Gets or sets the name of the current folder.
string	Category	Gets or sets the category of the current folder.
string	Id	Gets or sets the id of the current folder.
string	IsLibraryStr	Gets or sets whether the current folder is a library or not. (boolean value as string)
CreatedObject	Created	Gets or sets information about the creation of the current folder like the user or the date.
StateObject	State	Gets or sets information about the state of the current folder.
List<UDPObject>	UDP	Gets a list of properties about the children folders of the current folder.
List<FolderObject>	FolderObjects	Gets a list of all children folders of the current folder.
List<FileObject>	FileObjects	Gets a list of all files in the current folder.
List<LinkObject>	Link	Gets a list of all links of the current folder.

Methods

Type	Name	Description
FolderObject	AddFolder(string folderName)	Takes a folder name to create and add a new child folder to the current folder (if it is not already a child).
FolderObject	AddFolder(FolderObject folder)	Takes a folder and add it to the children of the current folder, or do nothing if its already added.
FolderObject	GetFolder(string folderName)	Takes a folder name and return a the specified child folder.
FileObject	AddFileWithIteration(string targetFileName, string sourceFileName)	Takes a target file name and a source file name, create a file and add it to the current folder. This file will already contain a default iteration.
FileObject	AddFileWithIterationRef(string targetFileName, long checksum, DateTime createDate)	Takes a target file name, a source file name and a creation date and add it to the current folder. This file will already contain a default iteration ref.
FileObject	GetFile(string fileName)	Takes a file name and return the specified file if it is located inside the current folder.
UDPObject	AddProperty(string name, string value)	Takes a name and a value and add it to the properties of the current folder.
void	Setstate(string definition, string name)	Takes a definition and a name and sets the state of the current folder.
LinkObject	AddLink(string id)	Takes an id, create a link and adds it to the current folder.
void	SetLibrary(bool library)	Takes a boolean value and determine, whether the current folder is a library or not.
bool	IsLibrary()	Returns whether the current folder is a library.
FileObject	AddFile(FileObject file)	Takes a file and add it to the child files of the current folder.