Setup

Adds site members to a group.

The addGroupMembers() function returns a Promise that resolves to the newly-added group member after the member has successfully been added.

For SECRET groups, site admins, group admins, and group members can add additional members to their group.

For PUBLIC and PRIVATE groups, only site admins and group admins can add additional members to their group. They can also choose to allow all group members to add a new member to the group. This setting can be found in your site's Dashboard under Groups Application > Your Group > Admin Tools > Member Permissions.

function addGroupMembers(groupId: string, memberIds: Array<string>, options: AddGroupMembersOptions): Promise<AddGroupMembersResponse>

Lists all members of a group.

The listGroupMembers() function returns a Promise that resolves to a list of up to 100 group members. Sorts by default to joinedDate in descending order.

function listGroupMembers(groupId: string, options: ListGroupMembersOptions): Promise<ListGroupMembersResponse>

Lists all group memberships of a site member.

The listMemberships() function returns a Promise that resolves to a list of up to 100 group memberships. Sorts by default to groupId in descending order.

function listMemberships(memberId: string, options: ListMembershipsOptions): Promise<ListMembershipsResponse>

Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.

Creates a query to retrieve a list of group members.

The queryGroupMembers() function builds a query to retrieve a list of all group members, and returns a GroupMembersQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function.

You can refine the query by chaining GroupMembersQueryBuilder functions onto the query. GroupMembersQueryBuilder functions enable you to sort, filter, and control the results that queryMembers() returns.

queryGroupMembers() runs with these GroupMembersQueryBuilder defaults, which you can override:

• limit(100)
• descending("joinedDate")

The following GroupMembersQueryBuilder functions are supported for queryGroupMembers(). For a full description of the Members object, see the object returned for the items property in GroupMembersQueryResult.

Property	Supported Filters & Sorting
role	eq(), ne()
joinedDate	ascending(), descending()

PROPERTY	SUPPORTED FILTERS & SORTING
role	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
joinedDate	ascending(),descending()

function queryGroupMembers(groupId: string): MembersQueryBuilder

Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.

The queryMemberships function returns a Promise that resolves to a list of memberships.

Property	Supported Filters & Sorting
status	eq(), ne()
role	eq(), ne()

function queryMemberships(memberId: string, options: QueryMembershipsOptions): Promise<QueryMembershipsResponse>

Removes members from a group.

The removeGroupMembers() function returns a Promise that resolves when the member is removed from the group.

function removeGroupMembers(groupId: string, memberIds: Array<string>, options: RemoveGroupMembersOptions): Promise<void>