queryCollections( )


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

The queryCollections() method builds a query to retrieve a list of collections and returns a CollectionsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() method.

You can refine the query by chaining CollectionsQueryBuilder methods onto the query. CollectionsQueryBuilder methods enable you to filter, sort, and control the results that queryCollections() returns.

queryCollections() runs with the following CollectionsQueryBuilder defaults which you can override:

The following CollectionsQueryBuilder methods are supported for queryCollections(). For a full description of the operations object, see the object returned for the items property in CollectionsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
titleeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
descriptioneq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
slugeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
hiddeneq(),ne(),exists(),in(),hasSome()
sortOrdereq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
Permissions
Manage Portfolio
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryCollectionsOptions
Returns
Did this help?