Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

isdir

True: This is a folder node

False: This is a file node

nameName of file or folder
folderInternal identifier of the parent node. Folder IDs are required when manipulating files.
existsBoolean. Tells if the file or folder actually exists. If this node is a deliverable, it will be prepopulated with all information (such as the expected name of deliverable) but the deliverable may not yet exist on the server.
readonly

Boolean. Tells if the file is readonly or not. The original file will be readonly. Currently, the API does not allow to set this flag, so basically it is of not much use today.

dateFile/folder date. Null if not exists.
sizeFile/folder date. 0 if file/folder not exists.
  
 File nodes only
canPreview

Boolean. If true then the file can potentially be previewed in the browser. Use these methods for previewing:

  • resources/files/details : Get exact information on how to preview this file. This will tell if preview is "really" possible and which parameters such as encoding information needs to be supplied to the preview method below.
  • resources/files/preview : Obtain a URL to preview file online
  
 Folder nodes only
scannedTells if the sub folders have been loaded. Ths is related to the populateDepth parameter.
filesOnly exists if isdir is true. Array of file nodes contained in the present folder node.
foldersOnly exists if isdir is true. Array of folder nodes contained in the present folder node.
  

 

EXAMPLES

See this example:

...