queryServices( )

Creates a query to retrieve a list of service objects.

The queryServices() function builds a query to retrieve a list of service objects and returns a ServicesQueryBuilder 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 ServicesQueryBuilder functions onto the query. ServicesQueryBuilder functions enable you to sort, filter, and control the results that queryServices() returns.

queryServices() runs with the following ServicesQueryBuilder defaults that you can override:

• limit is 100.
• Sorted by createdDate in ascending order.

The functions that are chained to queryServices() are applied in the order they are called. For example, if you apply ascending("category.name") and then ascending("name"), the results are sorted first by category.name, and then, if there are multiple results with the same category.name, the items are sorted by name.

The following ServicesQueryBuilder functions are supported for the queryServices() function. For a full description of the service object, see the object returned for the items property in ServicesQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),exists(),in(),hasSome(),startsWith()
type	eq(),ne(),exists(),in(),hasSome()
name	eq(),ne(),exists(),in(),hasSome(),startsWith()
description	eq(),ne(),exists(),in(),hasSome(),startsWith()
tagLine	eq(),ne(),exists(),in(),hasSome(),startsWith()
hidden	eq(),ne(),exists(),in(),hasSome()
category.id	eq(),ne(),exists(),in(),hasSome(),startsWith()
category.name	eq(),ne(),exists(),in(),hasSome(),startsWith()
form.id	eq(),ne(),exists(),in(),hasSome(),startsWith()
payment.options.online	eq(),ne(),exists(),in(),hasSome()
payment.options.inPerson	eq(),ne(),exists(),in(),hasSome()
payment.options.pricingPlan	eq(),ne(),exists(),in(),hasSome()
onlineBooking.enabled	eq(),ne(),exists(),in(),hasSome()
locations.business.id	eq(),ne(),exists(),in(),hasSome(),startsWith()
schedule.firstSessionStart	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge()
schedule.lastSessionEnd	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge()
staffMemberIds	eq(),ne(),exists(),in(),hasSome(),hasAll()
supportedSlugs.name	eq(),ne(),exists(),in(),hasSome(),startsWith()
mainSlug.name	eq(),ne(),exists(),in(),hasSome(),startsWith()