Creates a query to retrieve a list of labels.
The queryLabels()
method 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 call the query using the find()
method.
You can refine the query by chaining LabelsQueryBuilder
methods onto the query. LabelsQueryBuilder
methods enable you to filter, sort, and control the response that queryLabels()
returns.
queryLabels()
is called with the following LabelsQueryBuilder
defaults, which you can override:
skip(0)
limit(50)
descending('_createdDate')
The following LabelsQueryBuilder
methods are supported for queryLabels()
. For a full description of the Labels
object, see the object returned for the items
field 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() |
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Language options.
There are 6 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.