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 menus.
The queryMenus()
function builds a query to retrieve a list of menus and returns a MenusQueryBuilder
object.
The returned object contains the query definition, which is used to run the query using the find()
function.
You can refine the query by chaining MenusQueryBuilder
functions onto the query. MenusQueryBuilder
functions enable you to filter, sort, and control the results that queryMenus()
returns.
queryMenus()
runs with the following MenusQueryBuilder
defaults, which you can override:
The following MenusQueryBuilder
functions are supported for queryMenus()
. For a full description of the menu object, see the object returned for the items
property in MenusQueryResult
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,in() |
_createdDate | eq() ,ne() ,gt() ,ge() ,lt() ,le() |
_updatedDate | eq() ,ne() ,gt() ,ge() ,lt() ,le() |
name | eq() ,ne() ,in() ,startsWith() |
description | eq() ,ne() ,in() ,startsWith() |
urlQueryParam | eq() ,ne() ,in() ,startsWith() |