queryBadgeAssignments( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of badge assignments.

The queryBadgeAssignments() method builds a query to retrieve a list of badge assignments and returns a BadgeAssignmentsQueryBuilder 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 BadgeAssignmentsQueryBuilder methods onto the query. BadgeAssignmentsQueryBuilder methods enable you to sort, filter, and control the results queryBadgeAssignments() returns.

queryBadgeAssignments() runs with these BadgeAssignmentsQueryBuilder defaults, which you can override:

  • limit(50)
  • descending("_createdDate")

The methods that are chained to queryBadgeAssignments() are applied in the order they're called.

PROPERTYSUPPORTED FILTERS & SORTING
badgeIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending()
memberIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending()
Permissions
Read Badges
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?