ZenqlQuery
Log in to add to favouritesA ZenqlQuery allows us to provide a ZenQL statement to the entries.search() method in a Delivery API client. The returned object allows us to add additional refinements to the search before the request for content is made, such as specifying a pageIndex or fields to return.
Call signature
new ZenqlQuery(zenql: string): ZenqlQueryParameters
| Name | Type | Description |
|---|---|---|
| zenql | string | A ZenQL statement containing the search criteria for returning entries |
Returns
An instance of ZenqlQuery we can set specific properties and use with entries.search()
Properties
| Name | Type | Description |
|---|---|---|
| zenql | string | A ZenQL statement containing the search criteria for returning entries |
| pageIndex | number | The index of subsequent pages of search results (required if > 0) |
| pageSize | number | The size of each page of search results |
| fieldLinkDepths | { string: number } | Object containing field paths to resolve linked entries for and the link depth to resolve the field to |
| fields | string [ ... ] | A list of entry fields that will be retrieved (if the returned entries contain them) |