Namespace

DuFolder

DuFolder

Folder related methods

View Source DuAEF_DuGR_api.jsxinc, line 714

Members

Folder

# static userData

The default user data folder.
Replaces the Folder.userData provided by ESTK which does not work properly with mac network sessions.
In windows, the value of %APPDATA% ("C:\Documents and Settings\username\Application Data")
In Mac OS, "~/Library/Application Support"

View Source DuAEF_DuGR_api.jsxinc, line 834

Methods

# static canRead(folder) → {bool}

Tests if a folder can be read
Parameters:
Name Type Description
folder Folder | string The folder

View Source DuAEF_DuGR_api.jsxinc, line 769

bool

# static canWrite(folder) → {bool}

Tests if a folder can be written
Parameters:
Name Type Description
folder Folder | string The folder

View Source DuAEF_DuGR_api.jsxinc, line 796

bool

# static getFiles(folder, filteropt) → {Array}

Recursively gets all files in a folder using a name filter Returns an array of File objects.
Parameters:
Name Type Attributes Default Description
folder Folder The Folder
filter string | function <optional>
"*" A search mask for file names, specified as a string or a function. A mask string can contain question mark (?) and asterisk (*) wild cards. Default is "*", which matches all file names. Can also be the name of a function that takes a File or Folder object as its argument. It is called for each file or folder found in the search; if it returns true, the object is added to the return array.

View Source DuAEF_DuGR_api.jsxinc, line 745

The files found.
Array

# static wipeFolder(folder)

Recursively remove all content from folder and the folder itself. Warning, this does not move files to the recycle bin and can not be undone.
Parameters:
Name Type Description
folder string | Folder the path or Folder object to wipe.

View Source DuAEF_DuGR_api.jsxinc, line 720