Class Folder

Namespace

Oqtane.Models

Assembly

Oqtane.Shared.dll

Describes a Folder in Oqtane

public class Folder : ModelBase, IAuditable

Inheritance

object

ModelBase

Folder

Implements

IAuditable

Inherited Members

ModelBase.CreatedBy

ModelBase.CreatedOn

ModelBase.ModifiedBy

ModelBase.ModifiedOn

Extension Methods

Utilities.IsPathValid(Folder)

Properties

Capacity

Maximum folder capacity (in bytes)

public int Capacity { get; set; }

Property Value

int

FolderId

ID to identify the folder

public int FolderId { get; set; }

Property Value

int

HasChildren

Information if this folder has sub-items like more Folder or File objects

[NotMapped]
public bool HasChildren { get; set; }

Property Value

bool

ImageSizes

List of image sizes which can be generated dynamically from uploaded images (ie. 200x200,x200,200x)

public string ImageSizes { get; set; }

Property Value

string

IsDeleted

Deprecated - not used

public bool? IsDeleted { get; set; }

Property Value

bool?

IsSystem

Folder is a dependency of the framework and cannot be modified or removed

public bool IsSystem { get; set; }

Property Value

bool

Level

Folder Depth TODO: todoc Where does this start, so Depth 0 or 1 is where in the file system?

[NotMapped]
public int Level { get; set; }

Property Value

int

Name

Folder name

public string Name { get; set; }

Property Value

string

Order

Sorting order of the folder

public int Order { get; set; }

Property Value

int

ParentId

Reference to the parent Folder, if it has a parent folder.

public int? ParentId { get; set; }

Property Value

int?

Path

Path to the folder TODO: document from where the path starts

public string Path { get; set; }

Property Value

string

PermissionList

TODO: todoc what would this contain?

[NotMapped]
public List<Permission> PermissionList { get; set; }

Property Value

List<Permission>

Permissions

[Obsolete("The Permissions property is deprecated. Use PermissionList instead", false)]
[NotMapped]
[JsonIgnore]
public string Permissions { get; set; }

Property Value

string

SiteId

Reference to the Site.

public int SiteId { get; set; }

Property Value

int

Type

Folder type - based on FolderTypes

public string Type { get; set; }

Property Value

string