queryMenuOrderingSettings( )


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 menu ordering settings objects.

The queryMenuOrderingSettings() function builds a query to retrieve a list of menu ordering settings objects and returns an MenuOrderingSettingsQueryBuilder 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 MenuOrderingSettingsQueryBuilder functions onto the query. MenuOrderingSettingsQueryBuilder functions enable you to filter, sort, and control the results that queryMenuOrderingSettings() returns.

queryMenuOrderingSettings() runs with the following MenuOrderingSettingsQueryBuilder defaults, which you can override:

The following MenuOrderingSettingsQueryBuilder functions are supported for queryMenuOrderingSettings(). For a full description of the menu ordering settings object, see the object returned for the items property in MenuOrderingSettingsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
operationIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
menuIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
onlineOrderingEnabledeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
availability.typeeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Was this helpful?
Yes
No