MembersQuery

MembersQuery

# new MembersQuery(groupId)

Creates a MembersQuery.
Parameters:
Name Type Description
groupId string Group ID

Methods

# (static) ofGroup(groupId) → {MembersQuery}

Create a query to get members of a group.
Parameters:
Name Type Description
groupId string Group ID.
Returns:
New query.
Type
MembersQuery

# withName(searchTerm) → {MembersQuery}

Filters memebrs by username or display name.
Parameters:
Name Type Description
searchTerm string Beginning of username or display name.
Returns:
Same query.
Type
MembersQuery

# withRole(role) → {MembersQuery}

Filters members by role.
Parameters:
Name Type Description
role number Member role.
Returns:
Same instance.
Type
MembersQuery

# withStatus(status) → {MembersQuery}

Filters members by status.
Parameters:
Name Type Description
status number Member status.
Returns:
Same instance.
Type
MembersQuery