Rejects requests to create a group.
Note: This function is only relevant if admin approval is required for creating a group, or if the function's suppressAuth
option is set to true
.
The rejectCreateRequests()
function returns a Promise that resolves when the site member's request to create a group is rejected.
Only site admins can reject requests to create a group.
Note: If the suppressAuth
option is set to true
, all permissions are overwritten, and all site members can reject requests to create a group.
function rejectCreateRequests(
rejections: Array<RejectCreateRequest>,
options: Options,
): Promise<Array<CreateRequest>>;
Rejection data.
Authorization options.
import { Permissions, webMethod } from "wix-web-module";
import { createRequests } from "wix-groups-backend";
// Sample rejections value:
// [
// {
// createRequestId: '77490611-53bb-4b47-a7cc-ca9a1335133b',
// reason: 'This group is for teachers only'
// }
// ]
//
// Sample options value:
// {
// suppressAuth: true
// }
//
export const myRejectCreateRequestsFunction = webMethod(
Permissions.Anyone,
(rejections, options) => {
return createRequests
.rejectCreateRequests(rejections, options)
.then((rejectedCreateRequests) => {
return rejectedCreateRequests;
})
.catch((error) => {
console.error(error);
});
},
);
/* Promise resolves to:
* [
* {
* "_id": "77490611-53bb-4b47-a7cc-ca9a1335133b",
* "status": "REJECTED"
* "rejectionReason": "This group is for teachers only."
* "group": {
* "_id": "77490611-53bb-4b47-a7cc-ca9a1335133b"
* "name": "My Group Request 5"
* "slug": "my-group-request-5"
* "description": "Welcome to the group! You can connect with other members, get updates and share videos."
* "privacyStatus": "PRIVATE"
* "coverImage": {
* "imageUrl": "wix:image://v1/jb9074e348009011fa9f2dzj0jn~mv2.jpg/nutmeg.jpg#originWidth=800&originHeight=720",
* "position": {
* "x": 66,
* "y": 10
* }
* }
* "memberTitle": "Co-workers"
* "memberCount": 1
* "settings": {
* "groupUpdatePostEnabled": true
* "membersCanApprove": false
* "membersCanInvite": true
* "showMemberList": true
* "welcomeMemberPostEnabled": true
* }
* "lastActivityDate": "Sun Sep 26 2021 08:23:23 GMT+0300"
* "_createdDate": "Sun Sep 26 2021 08:23:23 GMT+0300"
* "_updatedDate": "Sun Sep 26 2021 08:23:23 GMT+0300"
* "owner": "9ne8e9e1-d050-4c86-9684-e7f231600a34"
* }
* }
* ]
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.