Introduction
Note: This module is universal. Functions in this module can run on both the backend and frontend, unless specified otherwise.
The JoinGroupRequests API provides functionality for managing requests to join a group.
Notes:
- This module is only relevant for private groups.
- When a group's
privacyStatus
is updated fromPRIVATE
toPUBLIC
, all pending join requests for that group are automatically approved. - When a group's
privacyStatus
is updated fromPRIVATE
toSECRET
, all pending join requests for that group are automatically rejected. - A site member can only join a group if they have a public profile.
Settings for a typical use case
- Group members with group admin permissions determine who can join their group by setting their group privacy level.
- If a group's privacy level is set to
PRIVATE
, a site member can request to join the group on your site's Groups List page. - Only site admins or group admins can approve or reject site member requests to join the group, unless the group setting
membersCanApprove
is set totrue
. - Note: If the
wix-auth
elevate()
function is used, all permissions are overridden,, and all site members (including non-group members) can approve or reject site member requests to join a group. - When a site member's request to join the group is approved, the member is added to the group.
- If a group's privacy level is set to
PUBLIC
, a site member can join the group (no request necessary). - If a group's privacy level is set to
SECRET
, only site members added by an existing group member can join the group (no request necessary).
The JoinGroupRequests API provides functionality allowing you to:
Permissions information
Permission requirements for the functions in this API can be overridden using the wix-auth
elevate()
function. This will have the following effects:
approveJoinGroupRequests()
- All site members (including non-group members) can approve site member requests to join a group.listJoinGroupRequests()
- All site members (including non-group members) can see requests to join a group.queryJoinGroupRequests()
- All site members (including non-group members) can query requests to join a group.rejectJoinGroupRequests()
- All site members (including non-group members) can reject site member requests to join a group.
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
To use the JoinGroupRequests API, import JoinGroupRequests
from the wix-groups-v2
module:
javascript | Copy Codeimport { JoinGroupRequests } from "wix-groups-v2";
Was this helpful?