SearchForm

A SearchForm represent a Form returned by the prismic.io API.

These forms depend on the prismic.io repository, and can be filled and sent as regular HTML forms.

You may get a SearchForm instance through the io.prismic.Api.forms method.

The SearchForm instance contains helper methods for each predefined form's fields.

Example:

val form = api.forms('everything') .page(3) // specify the field 'page' .pageSize(20) // specify the 'page_size' field val results = form.submit() // submit the search form

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new SearchForm(api: Api, form: Form, data: Map[String, Seq[String]])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val api: Api
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val data: Map[String, Seq[String]]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def fetch(fields: Iterable[String]): SearchForm

Restrict the fragments to be return to the set of fields in parameter
Restrict the fragments to be return to the set of fields in parameter
fields
returns
def fetchLinks(fields: Iterable[String]): SearchForm

Add the requested fields to the DocumentLink objects within the results
Add the requested fields to the DocumentLink objects within the results
fields
returns
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val form: Form
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lang(lang: String): SearchForm

lang
the language to query for
returns
the SearchForm instance for chaining
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def orderings(o: String*): SearchForm

o
one or more string, containing the name of a field optionally followed by a space and "desc"
returns
the SearchForm instance for chaining
def page(p: Int): SearchForm
def pageSize(p: Int): SearchForm
def query(predicates: Predicate*): SearchForm

Build an "AND" query with all the predicates passed in parameter
Build an "AND" query with all the predicates passed in parameter
predicates
one or more Predicate
returns
the SearchForm instance for chaining
def query(query: String): SearchForm
def ref(r: String): SearchForm
def ref(r: Ref): SearchForm
def set(field: String, value: Int): SearchForm
def set(field: String, value: String): SearchForm
def submit(): Future[Response]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

case class SearchForm(api: Api, form: Form, data: Map[String, Seq[String]]) extends Product with Serializable

Instance Constructors

new SearchForm(api: Api, form: Form, data: Map[String, Seq[String]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val api: Api

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val data: Map[String, Seq[String]]

final def eq(arg0: AnyRef): Boolean

def fetch(fields: Iterable[String]): SearchForm

def fetchLinks(fields: Iterable[String]): SearchForm

def finalize(): Unit

val form: Form

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

def lang(lang: String): SearchForm

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def orderings(o: String*): SearchForm

def page(p: Int): SearchForm

def pageSize(p: Int): SearchForm

def query(predicates: Predicate*): SearchForm

def query(query: String): SearchForm

def ref(r: String): SearchForm

def ref(r: Ref): SearchForm

def set(field: String, value: Int): SearchForm

def set(field: String, value: String): SearchForm

def submit(): Future[Response]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped