queryMessages( )


Deprecated

This method is deprecated.

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.

Supported Filters and Sorting

FieldSupported FiltersSortable
idAll operators.Sortable
createdDateAll operators.Sortable
PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),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
Innovation Lab Administrator
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?