dundas.filesystem.FileSystemEntry Class

 

Inheritance Hierarchy

 
Class
   dundas.filesystem.FileSystemEntry
      dundas.filesystem.File
      dundas.filesystem.Folder
 

Constructors

 
  Name Description
init Initializes the dundas.filesystem.FileSystemEntry object.
 
 

Properties

 
  Name Description
allChildren Gets a flat list of all files and folders in this folder and all its subfolders.
allFiles Gets a flat list of all files in the folder and all its subfolders.
allFolders Gets a flat list of all subfolders in the folder and all its subfolders.
childCount Gets or sets the number of direct children contained in this folder or file.
children Gets the files and folders under this entry.
createdBy Gets or sets the account of the user who created the folder or file.
createdTime Gets or sets the time, in coordinated universal time (UTC), that the folder or file was created.
description Gets or sets an optional description associated with the file or folder.
effectiveCallerPrivileges Gets or sets the effective privileges for the current user. See dundas.filesystem.ObjectPrivilegeIds for the available values.
files Gets or sets the files contained in this folder.
folders Gets or sets the subfolders of this folder.
friendlyFullName Gets or sets the friendly full path of the entry.
friendlyLocation Gets or sets the friendly location to the entry.
friendlyLocationElements Gets or sets a list of distinct path elements which compose the FriendlyLocation.
friendlyName Gets or sets the friendly name of the entry.
fullName Gets or sets the full path of the folder or file.
id Gets or sets the unique identifier of the file or folder.
inheritedTags Gets or sets the inherited tags associated with the file or folder.
isProtected Gets or sets a value indicating whether this instance is protected.
isRecycled Gets or sets a value indicating whether the entry is recycled.
isSubentry Gets or sets a value indicating whether this instance is a child entry.
isTemporary Gets or sets a value indicating whether the entry resides under a temporary folder.
lastModifiedTime Gets or sets the time, in coordinated universal time (UTC), that the folder or file was last written to.
location Gets or sets the location to the file or folder.
metadata Gets or sets the meta data assigned to this file system entry
name Gets or sets the name of the folder or file.
objectType Gets or sets the type of the folder or file.
parentId Gets or sets the ID of the folder in which the folder or file resides.
primaryEntryId Gets the ID of the entity which contains this entry.
privilegeInheritanceBehavior Gets or sets the privilege inheritance behavior on this file system entry.
privileges Gets or sets the privileges assigned to this file system entry.
projectId Gets or sets the ID of the project containing this folder or file.
subtype Gets or sets the type-specific sub-type of this instance.
tags Gets or sets the tags associated with the file or folder.
tenantId Gets or sets a value indicating the tenant ID, if applicable.
 
 

Methods

 
  Name Description
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.

Static
getIconFromObjectType Gets the icon for the specified object type.
getTooltipText Gets the tooltip text for this file system entry.
hasEffectiveCallerPrivilege Checks if the file has the specified effective caller privilege or not.
isFile Returns whether this file system entry is a file or not.
isFolder Returns whether this file system entry is a folder or not.
isProject Returns whether this file system entry is a project or not.
isRelationshipsSupported Returns whether this file system entry supports creating relationships to it.
isRootFolder Returns whether this file system entry is a root folder or not.
isRootFolderWithSharedItems Returns whether this file system entry is a root folder that can have shared items or not.
tagsFromString Converts the given comma-separated string into an array and sets it on the tags. This will also trim the whitespace.
tagsToString Gets the tags as comma-separated string.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.