Creates a query to retrieve extended resource information.
The queryResourceCatalog()
function builds a query to retrieve a catalog of resources, including resources' related schedules and slugs, and returns a ResourceCatalogQueryBuilder
object.
The returned object contains the query definition, which is typically used to run the query using the find()
function.
The ResourceCatalogQueryBuilder
functions enable you to run, filter, and control
which results a query returns.
Typically, you build a query using the resource catalog query function,
refine the query by chaining ResourceCatalogQueryBuilder
functions, and then execute the
query by chaining the find()
function.
The query runs with the following ResourceCatalogQueryBuilder
defaults that you can override:
The following query builder functions are supported for queryResourceCatalog()
.
Property | Supported Filters |
---|---|
_id | eq() |
slugs.name | eq() , hasSome() |
For a full description of the Resources object, see the object returned for the items
array in ResourceCatalogQueryResult
.
Note: Only users with the Bookings Admin role can query resources.