queryCreateRequests( )


Creates a query to retrieve a list of create requests.

Notes:

  • 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.
  • For SECRET groups, only site admins can query requests to create a group. However, if the suppressAuth option is set to true, all permissions are overwritten, and all site members can query requests to create secret groups.

The queryCreateRequests() function builds a query to retrieve a list of all requests to create a group, and returns a CreateRequestsQueryBuilder 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 CreateRequestsQueryBuilder functions onto the query. CreateRequestsQueryBuilder functions enable you to sort, filter, and control the results that queryCreateRequests() returns.

queryCreateRequests() runs with these CreateRequestsQueryBuilder defaults, which you can override:

The following CreateRequestsQueryBuilder functions are supported for queryCreateRequests(). For a full description of the CreateRequests object, see the object returned for the items property in CreateRequestsQueryResult.

PropertySupported Filters & Sorting
statuseq(), ne(), hasSome(), or()
_createdDateascending(), descending()
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Was this helpful?
Yes
No