Creates a query to retrieve a list of schedule items.
The queryScheduleItems( )
method builds a query to retrieve a list of schedule items and returns a ItemsQueryBuilder
object.
The returned object contains the query definition, which is typically used to run the query using the find()
method.
You can refine the query by chaining ItemsQueryBuilder
methods onto the query. ItemsQueryBuilder
methods enable you to sort, filter, and control the results queryScheduleItems( )
returns.
queryScheduleItems( )
runs with these ItemsQueryBuilder
defaults, which you can override:
The methods that are chained to queryScheduleItems( )
are applied in the order they're called. For example, if you apply ascending('name')
and then descending('stageName')
, the results are sorted first by the name
, and then, if there are multiple results with the same name
, the items are sorted by stageName
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
name | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
description | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
stageName | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_createdDate | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_updatedDate | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
eventId | eq() ,ne() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.