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 participations.
The queryParticipations()
function builds a query to retrieve a list of participations and returns a ParticipationsQueryBuilder
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 ParticipationsQueryBuilder
functions onto the query. ParticipationsQueryBuilder
functions enable you to sort, filter, and control the results that queryParticipations()
returns.
queryParticipations()
runs with the following ParticipationsQueryBuilder
default that you can override:
limit
is 50
.createdDate
in ascending order.The functions that are chained to queryParticipations()
are applied in the order they are called.
The following ParticipationsQueryBuilder
functions are supported for the queryParticipations()
function. For a full description of the participations object, see the object returned for the items property in ParticipationsQueryResult
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
scheduleId | eq() ,in() |
eventId | eq() ,in() |
_id | in() |
externalId | eq() ,in() |
You can only call this method when authenticated as a Wix app or Wix user identity.