API Docs for: 1.5.0
Show:

ViewCreateStruct Class

Returns a structure used to create a new REST View. See ContentService.createView

Constructor

ViewCreateStruct

(
  • identifier
  • [type="ContentQuery"]
)

Parameters:

  • identifier String

    unique view identifier

  • [type="ContentQuery"] String optional

    the view type to create, the REST API currently supports only "ContentQuery" or "LocationQuery".

Methods

getCriteria

() Object deprecated

Gets the Criteria property

Returns:

Object:

the criteria property.

getFilter

() Object

Gets the Filter property

Returns:

Object:

the Filter property.

getQuery

() Object

Gets the Query property

Returns:

Object:

the query property.

setCriteria

() deprecated

Sets the Criteria property

setFacetBuilders

()

Sets the FacetBuilders property

setFilter

()

Sets the Filter property

setLimitAndOffset

()

Sets the limit and offset properties

setQuery

()

Sets the Query property

setSortClauses

()

Sets the SortClauses property

Properties

_type

String protected

Holds the view type

body

Object

Holds the body of the view create structs

Default: { ViewInput: { identifier: <identifier>, public: false, <type>: { Criteria: {}, SortClauses: {}, FacetBuilders: {}, }, } }

headers

Object

Holds the headers sent when creating a view

Default: { "Accept": "application/vnd.ez.api.View+json; version=1.1", "Content-Type": "application/vnd.ez.api.ViewInput+json; version=1.1" }