queryUserMembers( )


Creates a query to retrieve a list of user members.

The queryUserMembers() method builds a query to retrieve a list of user members and returns a UserMembersQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() method.

You can refine the query by chaining UserMembersQueryBuilder methods onto the query. UserMembersQueryBuilder methods enable you to sort, filter, and control the results queryUserMembers() returns.

queryUserMembers() runs with these UserMembersQueryBuilder defaults, which you can override:

PROPERTYSUPPORTED FILTERS & SORTING
memberIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
userIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
siteMembersInstanceIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
metaSiteIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
statuseq(),ne(),exists(),in(),hasSome(),ascending(),descending()
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
SCOPE.DC-MEMBERS.MANAGE-USER-MEMBERS
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?