Config2_GroupMembers

Provides APIs for managing members of the current group.

Instances of this class are obtained from:

Methods

MethodReturnsDescription
add() void

Adds the given user to the current group.
remove() void

Removes the given user from the current group.
toArray() Array.<String>

Returns a member list of the current group as an array of strings being the names of the users.

Method Details

add(user)

Description:

  • Adds the given user to the current group.

Parameters:
Name Type Description
user String | Config2_User

Name of the user or Config2_User object.

remove(user)

Description:

  • Removes the given user from the current group.

Parameters:
Name Type Description
user String | Config2_User

Name of the user or Config2_User object.

toArray() → {Array.<String>}

Description:

  • Returns a member list of the current group as an array of strings being the names of the users.

Returns:

Array of member usernames.

Type
Array.<String>