Setup
To use the Members API, install the @wix/groups
package using npm or Yarn:
1npm install @wix/groups
or
1yarn add @wix/groups
Then import { members }
from @wix/groups
:
1import { members } from '@wix/groups'
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>
Group ID.
IDs of the site members to add to the group.
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.
Note: For SECRET
groups, only site admins, group admins, and group members can see the list of group members.
function listGroupMembers(groupId: string, options: ListGroupMembersOptions): Promise<ListGroupMembersResponse>
Group ID.
Paging options.
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.
Note: Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships.
function listMemberships(memberId: string, options: ListMembershipsOptions): Promise<ListMembershipsResponse>
Site member ID.
Paging options.
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.
Note: For SECRET
groups, only site admins, group admins, and group members can query 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:
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
Group ID.
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.
Note: Site members can only query their own memberships.
Property | Supported Filters & Sorting |
---|---|
status | eq() , ne() |
role | eq() , ne() |
function queryMemberships(memberId: string, options: QueryMembershipsOptions): Promise<QueryMembershipsResponse>
Site member ID.
Removes members from a group.
The removeGroupMembers()
function returns a Promise that resolves when the member is removed from the group.
Note: Only site admins and group admins can remove members from their group.
function removeGroupMembers(groupId: string, memberIds: Array<string>, options: RemoveGroupMembersOptions): Promise<void>
Group ID.
IDs of the site members to remove from the group.