Config2_GroupManager

Provides the APIs for managing user groups in CompleteFTP.

Instances of this class are obtained from:

Methods

MethodReturnsDescription
add() Config2_Group

Adds a group with the given name.

get() Config2_Group

Returns a Config2_Group object for the given group name.

remove() void

Deletes the given group.

toArray() Array.<Config2_Group>

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

Method Details

add(groupName) → {Config2_Group}

Description:
  • Adds a group with the given name.

Parameters:
Name Type Description
groupName String

Name of the group to create.

Returns:

A Config2_Group object for the added group.

Type
Config2_Group

get(groupName) → {Config2_Group|null}

Description:
Parameters:
Name Type Description
groupName String

Name of the group.

Returns:

Group object or null if not found.

Type
Config2_Group | null

remove(groupName)

Description:
  • Deletes the given group.

Parameters:
Name Type Description
groupName String

Name of the group to be deleted.

toArray() → {Array.<Config2_Group>}

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

Returns:

Array of all group objects.

Type
Array.<Config2_Group>