queryLabels( )

Creates a query to retrieve a list of labels.

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

queryLabels() runs with the following LabelsQueryBuilder defaults, which you can override:

• skip(0)
• limit(50)
• descending('_createdDate')

The following LabelsQueryBuilder functions are supported for queryLabels(). For a full description of the Labels object, see the object returned for the items property in LabelsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
namespace	eq(),ne()
key	eq(),ne(),in()
displayName	eq(),ne(),in(),startsWith(),ascending(),descending()
labelType	eq()
_createdDate	eq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()
_updatedDate	eq(),ne(),gt(),lt(),ge(),le(),ascending(),descending()