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 messages.
The queryMessages()
function builds a query to retrieve a list of messages and returns a MessagesQueryBuilder
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 MessagesQueryBuilder
functions onto the query. MessagesQueryBuilder
functions enable you to sort, filter, and control the results queryMessages()
returns.
queryMessages()
runs with these MessagesQueryBuilder
defaults, which you can override:
*skip(0)
limit(50)
ascending("createdDate")
The functions that are chained to queryMessages()
are applied in the order they are called. For example, if you apply ascending('createdDate')
and then descending('id')
, the results are sorted first by the created date, and then, if there are multiple results with the same created date, the messages are sorted by ID.
Field | Supported Filters | Sortable |
---|---|---|
id | All operators. | Sortable |
createdDate | All operators. | Sortable |
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
_createdDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
You can only call this method when authenticated as a Wix app or Wix user identity.