Creates a group.
The createGroup() function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.
Site admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under Groups Application > General Settings > Group Creation. If set to admin approval required, a site member uses this function to create a group, and the group becomes a createRequest with a status of PENDING until the group is reviewed. The default is set to site members with admin approval.
Group to create.
Optional fields for group creation.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Deletes a group.
The deleteGroup() function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.
ID of the group to delete.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets a group by ID.
The getGroup() function returns a Promise that resolves to a group whose ID matches the given ID.
Note: For SECRET groups, only site admins, group admins, and group members can see a group and its content.
ID of the group to retrieve.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets a group by slug.
The getGroupBySlug() function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is https:/example.com/groups/{my-fitness-group}, the slug is my-fitness-group. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, https:/example.com/groups/{5D3yTX}.
Note: For SECRET groups, only site admins, group admins, and group members can see a group and its content.
Unique part of the group's URL, for example group-1 in https:/example.com/groups/group-1. Pass only the slug. Case-sensitive.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Lists groups.
The listGroups() function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to _createdDate in descending order.
Notes:
SECRET groups, only site admins, group admins, and group members can see a list of group and their content.null as a placeholder for any unspecified parameters. For example, to specify limit only, call listGroups(paging, null).Limit and offset options.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Creates a query to retrieve a list of groups.
Note: For SECRET groups, only site admins, group admins, and group members can query groups and their content.
The queryGroups() function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
title | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
membersCount | ascending(),descending() |
_createdDate | ascending(),descending() |
recentActivityDate | ascending(),descending() |
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Updates a group.
The updateGroup() function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
Notes:
privacyStatus is updated from PRIVATE to PUBLIC, all pending join requests for that group are automatically approved.privacyStatus is updated from PRIVATE to SECRET, all pending join requests for that group are automatically rejected.Group ID.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Adds a sort to a query, sorting by the specified properties in ascending order.
The ascending() function refines a GroupsQueryBuilder to sort by the value of propertyName in ascending order.
You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. ascending() sorts the results in the order the properties are passed.
You can sort the following types:
'abc' comes after 'XYZ'.
If a property contains a number stored as a string (for example, '0'), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Adds a sort to a query, sorting by the specified properties in descending order.
The descending() function refines a GroupsQueryBuilder to sort by the value of propertyName in descending order.
You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. descending() sorts the results in the order the properties are passed.
You can sort the following types:
'abc' comes after 'XYZ'.
If a property contains a number stored as a string (for example, '0'), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to match items where the specified property equals the specified value.
The eq() function refines a GroupsQueryBuilder to match only items where the value of the specified propertyName equals the specified value.
eq() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string.
Matching strings with eq() is case-sensitive, so 'text' isn't equal to 'Text'.
Property whose value is compared with value.
Value to compare against.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to match items where the specified property contains a value.
The exists() function refines a GroupsQueryBuilder to only match items where the value of the specified propertyName doesn't equal null or undefined.
exists() checks for either existence or non-existence based on the boolen parameter. Note that exists() does match items where the value of the specified propertyName is an empty string or an invalid value. exists() is only useful for properties which don't contain default values and therefore their values may be unassigned.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Returns the query results.
The find() function returns a Promise that resolves to the query results and metadata.
The Promise is rejected if find() is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to match items whose specified property contains any of the specified values.
The hasSome() function refines a GroupsQueryBuilder to match only items where the value of the specified propertyName equals any of the specified values.
Matching strings with hasSome() is case-sensitive, so 'text' isn't equal to 'Text'.
If the specified property is an array, hasSome() matches if any of that array's elements equal any of the specified values.
Property whose value is compared with values.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to only match items where the specified property conatins any of the values in the provided array of values.
The in() function refines a GroupsQueryBuilder to match only items where the specified propertyName is equal to any of the values in the provided array.
Matching strings with in() is case-sensitive, so 'text' isn't equal to 'Text'.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Limits the number of items the query returns.
The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.
You can use the next() and prev() functions to navigate the pages of a query result.
Number of items to return, which is also the pageSize of the results object.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to match items where the specified property doesn't equal the specified value.
The ne() function refines a GroupsQueryBuilder to match only items where the value of the specified propertyName doesn't equal the specified value.
ne() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string.
Matching strings with ne() is case-sensitive, so 'text' isn't equal to 'Text'.
Property whose value is compared with value.
Value to compare against.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Sets the number of items to skip before returning query results.
The skip() function defines the number of results to skip before returning new query results.
For example, if you query a collection and 50 items match your query, but you set skip() to 10, the first 10 items that match are ignored, and the 11th through 50th items are returned.
Number of items to skip in the query results before returning the results.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to match items where the specified property starts with the specified value.
The startsWith() function refines a GroupsQueryBuilder to match only items where the value of the specified propertyName starts with the specified string.
Matching with startsWith() is case-sensitive, so 'TEXT' doesn't start with 'text'.
You can only use startsWith() with a property whose value is a string.
Property whose value is compared with string.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.