Class SearchForm

Hierarchy

SearchForm

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SearchForm(form: Form, httpClient: HttpClient): SearchForm

- Defined in form.ts:124
Parameters
- form: Form
- httpClient: HttpClient
Returns SearchForm

Properties

data

data: any

form

form: Form

httpClient

httpClient: HttpClient

Methods

after

after(documentId: string): SearchForm

- Defined in form.ts:227
Remove all the documents except for those after the specified document in the list. This is an optional method.

Parameters
- documentId: string
Returns SearchForm

fetch

fetch(fields: string | string[]): SearchForm

- Defined in form.ts:188
Restrict the results document to the specified fields

Parameters
- fields: string | string[]
Returns SearchForm

fetchLinks

fetchLinks(fields: string | string[]): SearchForm

- Defined in form.ts:197
Include the requested fields in the DocumentLink instances in the result

Parameters
- fields: string | string[]
Returns SearchForm

graphQuery

graphQuery(query: string): SearchForm

- Defined in form.ts:206
Sets the graphquery to query for this SearchForm. This is an optional method.

Parameters
- query: string
Returns SearchForm

lang

lang(langCode: string): SearchForm

- Defined in form.ts:213
Sets the language to query for this SearchForm. This is an optional method.

Parameters
- langCode: string
Returns SearchForm

orderings

orderings(orderings?: string[]): SearchForm

- Defined in form.ts:234
Sets the orderings to query for this SearchForm. This is an optional method.

Parameters
- Optional orderings: string[]
Returns SearchForm

page

page(p: number): SearchForm

- Defined in form.ts:220
Sets the page number to query for this SearchForm. This is an optional method.

Parameters
- p: number
Returns SearchForm

pageSize

pageSize(size: number): SearchForm

- Defined in form.ts:181
Sets a page size to query for this SearchForm. This is an optional method.

Parameters
- size: number
  
  The page size
Returns SearchForm
- The SearchForm itself

query

query(query: string | string[]): SearchForm

- Defined in form.ts:165
Sets a predicate-based query for this SearchForm. This is where you paste what you compose in your prismic.io API browser.

Parameters
- query: string | string[]
Returns SearchForm

ref

ref(ref: string): SearchForm

- Defined in form.ts:157
Sets a ref to query on for this SearchForm. This is a mandatory method to call before calling submit(), and api.form('everything').submit() will not work.

Parameters
- ref: string
Returns SearchForm

set

set(field: string, value: any): SearchForm

- Defined in form.ts:138
Parameters
- field: string
- value: any
Returns SearchForm

submit

submit(cb: RequestCallback<ApiSearchResponse>): Promise<ApiSearchResponse>

- Defined in form.ts:267
Submits the query, and calls the callback function.

Parameters
- cb: RequestCallback<ApiSearchResponse>
Returns Promise<ApiSearchResponse>

url

url(): string

- Defined in form.ts:245
Build the URL to query

Returns string

Generated using TypeDoc