Config1_GroupManager

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

Methods

MethodReturnsDescription
add() Config1_Group

Adds a group with the given name.

get() Config1_Group

Returns a Config1_Group object for the given group name.

remove() void

Deletes the given group.

toArray() Array.<Config1_Group>

Returns an array of Config1_Group objects representing all groups in CompleteFTP including inbuilt ones.

Method Details

add(groupName) → {Config1_Group}

Description:
  • Adds a group with the given name.

Parameters:
Name Type Description
groupName String

Name of the group to create.

Returns:

A Config1_Group object for the added group.

Type
Config1_Group

get(groupName) → {Config1_Group}

Description:
Parameters:
Name Type Description
groupName String

Name of the group.

Returns:
Type
Config1_Group

remove(groupName)

Description:
  • Deletes the given group.

Parameters:
Name Type Description
groupName String

Name of the group to be deleted.

toArray() → {Array.<Config1_Group>}

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

Returns:
Type
Array.<Config1_Group>