queryMenus( )

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 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.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in()
_createdDateeq(),ne(),gt(),ge(),lt(),le()
_updatedDateeq(),ne(),gt(),ge(),lt(),le()
nameeq(),ne(),in(),startsWith()
descriptioneq(),ne(),in(),startsWith()
urlQueryParameq(),ne(),in(),startsWith()
Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:MenusQueryBuilder
Was this helpful?
Yes
No