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 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() |
You can only call this method when authenticated as a Wix app or Wix user identity.
Language options.
There are 6 errors with this status code:
See the entire list and learn more about Wix errors.