GroupManager

GroupManager

Provides the APIs for managing user groups in CompleteFTP. Instances of this class should be obtained using Config.groups.

Methods

add(groupName) → {Group}

Description:
  • Adds a group with the given name.

Source:
Parameters:
Name Type Description
groupName String

Name of the group to create.

Returns:

A Group object for the added group.

Type
Group

get(groupName) → {Group}

Description:
  • Returns a Group object for the given group name.

Source:
Parameters:
Name Type Description
groupName String

Name of the group.

Returns:
Type
Group

remove(groupName)

Description:
  • Deletes the given group.

Source:
Parameters:
Name Type Description
groupName String

Name of the group to be deleted.

toArray() → {Array.<Group>}

Description:
  • Returns an array of Group objects representing all groups in CompleteFTP including inbuilt ones.

Source:
Returns:
Type
Array.<Group>