Config1_Folder

Represents a folder in CompleteFTP's virtual file-system. Instances of this class should be obtained using Config1_FolderManager.get.

Properties

PropertyTypeDescription
access Object

Access control for non-Windows users to this folder.
createdTime Date

The date and time that this folder was created.
fullPath String

The absolute path of this folder in the virtual file-system.
hidden Boolean

If this property is set to true, then this folder will not show up in listings.
id String

The ID of this folder.
inbuilt Boolean

Is this an inbuilt folder that's created automatically during installation?

.
isFolderEmpty Boolean

Is this an empty folder? If it is, then that means this folder has no subfolders in the virtual file-system.
mappingPath String

Controls how the folder is mapped to the underlying file-system.
modifiedTime Date

The date and time that this folder was last modified.
name String

The name of this folder.
type String

The type of this folder.

Methods

MethodReturnsDescription
add() Config1_Folder

Adds a subfolder of the given type to this folder.
getParent() Folder

Returns a Folder object representing the parent-folder of this folder.
list() Array.<Folder>

Returns an array of Folder objects representing all first-level subfolders of this folder.
remove() void

Deletes this folder.

Property Details

access :Object

Description:

  • Access control for non-Windows users to this folder.

    Permissions to Windows folders of non-Windows users and Windows users are handled separately. This setting only applies to non-Windows users. Permissions for Windows users are handled by Windows.

Properties:
Name Type Description
owner Object

Specifies the owner as well as its permissions on this folder.

Properties
Name Type Description
userName String

User-name of the owner.
permissions Array.<String>

An array of strings contains the permissions that are given to the owner.

Available permisisons are: 'FileRead', 'FileWrite', 'FileAppend', 'FileRename', 'FileDelete', 'FileExecute', 'DirList', 'DirChange', 'DirCreate', 'DirRename', 'DirDelete', 'IgnoreFilters'.

Set this property to the array, ['All'], to give the owner full permissions.
group Object

Specifies the user group as well as its permissions on this folder.

A folder has a group to which permissions may be assigned. When this is done then any non-Windows user who is a member of that group will be granted the permission that that group has on the folder.

Properties
Name Type Description
groupName String

Name of the group.
permissions Array.<String>

An array of strings contains the permissions that are given to the user group.

Available permisisons are: 'FileRead', 'FileWrite', 'FileAppend', 'FileRename', 'FileDelete', 'FileExecute', 'DirList', 'DirChange', 'DirCreate', 'DirRename', 'DirDelete', 'IgnoreFilters'.

Set this property to the array, ['All'], to give the group full permissions.
allUsers Object

Specifies the permissions of all other users on this folder.

Properties
Name Type Description
permissions Array.<String>

An array of strings contains the permissions that are given to all other users.

Available permisisons are: 'FileRead', 'FileWrite', 'FileAppend', 'FileRename', 'FileDelete', 'FileExecute', 'DirList', 'DirChange', 'DirCreate', 'DirRename', 'DirDelete', 'IgnoreFilters'.

Set this property to the array, ['All'], to give all other users full permissions.
inherits Boolean

Does this folder inherit permissions from its parent folder?

Access control for non-Windows users to this folder.

Permissions to Windows folders of non-Windows users and Windows users are handled separately. This setting only applies to non-Windows users. Permissions for Windows users are handled by Windows.

Type:
  • Object

(readonly) createdTime :Date

Description:

  • The date and time that this folder was created.

The date and time that this folder was created.

Type:
  • Date

(readonly) fullPath :String

Description:

  • The absolute path of this folder in the virtual file-system.

The absolute path of this folder in the virtual file-system.

Type:
  • String

hidden :Boolean

Description:

  • If this property is set to true, then this folder will not show up in listings. This works independently of access permissions. For example, a folder may be shown but not accessible, or it may be hidden but still accessible.

If this property is set to true, then this folder will not show up in listings. This works independently of access permissions. For example, a folder may be shown but not accessible, or it may be hidden but still accessible.

Type:
  • Boolean

(readonly) id :String

Description:

  • The ID of this folder.

The ID of this folder.

Type:
  • String

(readonly) inbuilt :Boolean

Description:

  • Is this an inbuilt folder that's created automatically during installation?

Is this an inbuilt folder that's created automatically during installation?

Type:
  • Boolean

(readonly) isFolderEmpty :Boolean

Description:

  • Is this an empty folder? If it is, then that means this folder has no subfolders in the virtual file-system.

    Note that this does not indicate whether or not there are any subfolders or files in mapped folder in the underlying file-system.

Is this an empty folder? If it is, then that means this folder has no subfolders in the virtual file-system.

Note that this does not indicate whether or not there are any subfolders or files in mapped folder in the underlying file-system.

Type:
  • Boolean

mappingPath :String

Description:

  • Controls how the folder is mapped to the underlying file-system. Notes:

    • This property always returns null for Virtual folders.
    • For Windows folders and Network/Macro folders, mappingPaths are Windows file-system paths. In addition, Network/Macro folders' mappingPaths may include macros (listed below) or an environment variable.
      • %UserName% - User-name (without domain).
      • %DomainName% - Domain name.
      • %HomeBaseFolder% - Windows path of Home folder (i.e. parent of users' home folders).
      • %ExternalHomeFolder% - [Database users only] Path read from user database.
    • For Windows special folders, valid values should be:
      • 'Home' (User's home folder)
      • 'Personal' (User's My Documents folders)
      • 'DesktopDirectory' (User's Desktop folder)
      • 'MyPictures' (User's Pictures folder)
      • 'MyMusic' (User's My Music folder)

Controls how the folder is mapped to the underlying file-system. Notes:

  • This property always returns null for Virtual folders.
  • For Windows folders and Network/Macro folders, mappingPaths are Windows file-system paths. In addition, Network/Macro folders' mappingPaths may include macros (listed below) or an environment variable.
    • %UserName% - User-name (without domain).
    • %DomainName% - Domain name.
    • %HomeBaseFolder% - Windows path of Home folder (i.e. parent of users' home folders).
    • %ExternalHomeFolder% - [Database users only] Path read from user database.
  • For Windows special folders, valid values should be:
    • 'Home' (User's home folder)
    • 'Personal' (User's My Documents folders)
    • 'DesktopDirectory' (User's Desktop folder)
    • 'MyPictures' (User's Pictures folder)
    • 'MyMusic' (User's My Music folder)
Type:
  • String

(readonly) modifiedTime :Date

Description:

  • The date and time that this folder was last modified.

The date and time that this folder was last modified.

Type:
  • Date

name :String

Description:

  • The name of this folder.

The name of this folder.

Type:
  • String

(readonly) type :String

Description:

  • The type of this folder.

    • 'VirtualFolder' - Folders of this type don't exist on the actual file system - they permit a virtual folder structure to be created.
    • 'WindowsFolder' - Standard Windows folders
    • 'WindowsSpecialFolder' - Folders such as My Documents.
    • 'NetworkMacroFolder' - Windows folders whose paths are specified by a URL into which various macros may optionally be substituted.
    • 'GatewayFolder' - A gateway folder is a directory on a different server to the current CompleteFTP server instance. It is basically a remotely mounted directory (analogous to a network share).

The type of this folder.

  • 'VirtualFolder' - Folders of this type don't exist on the actual file system - they permit a virtual folder structure to be created.
  • 'WindowsFolder' - Standard Windows folders
  • 'WindowsSpecialFolder' - Folders such as My Documents.
  • 'NetworkMacroFolder' - Windows folders whose paths are specified by a URL into which various macros may optionally be substituted.
  • 'GatewayFolder' - A gateway folder is a directory on a different server to the current CompleteFTP server instance. It is basically a remotely mounted directory (analogous to a network share).
Type:
  • String

Method Details

add(name, type, mappingPath) → {Config1_Folder}

Description:

  • Adds a subfolder of the given type to this folder. Note that each subfolder of this folder must have a unique name. Subfolders of different folder may have the same name.

Parameters:
Name Type Description
name String

Name of the folder to be created.
type String

Type of the folder. Currently, the following types are supported:

  • 'VirtualFolder'
  • 'WindowsFolder'
  • 'WindowsSpecialFolder'
  • 'NetworkMacroFolder'
mappingPath String

Controls how the folder is mapped to the underlying file-system.
Notes:

  • This parameter is not required for Virtual folders.
  • For Windows folders and Network/Macro folders, mappingPaths are Windows file-system paths. In addition, Network/Macro folders' mappingPaths may include macros (listed below) or an environment variable.
    • %UserName% - User-name (without domain).
    • %DomainName% - Domain name.
    • %HomeBaseFolder% - Windows path of Home folder (i.e. parent of users' home folders).
    • %ExternalHomeFolder% - [Database users only] Path read from user database.
  • For Windows special folders, valid values should be:
    • 'Home' (User's home folder)
    • 'Personal' (User's My Documents folders)
    • 'DesktopDirectory' (User's Desktop folder)
    • 'MyPictures' (User's Pictures folder)
    • 'MyMusic' (User's My Music folder)
Returns:
Type
Config1_Folder

getParent() → {Folder}

Description:

  • Returns a Folder object representing the parent-folder of this folder. Returns null if this folder is at the top level (i.e. root).

Returns:
Type
Folder

list() → {Array.<Folder>}

Description:

  • Returns an array of Folder objects representing all first-level subfolders of this folder.

Returns:
Type
Array.<Folder>

remove(recursiveopt)

Description:

  • Deletes this folder.

Parameters:
Name Type Attributes Default Description
recursive Boolean <optional>
 false

If true, the folder will be deleted recursively.