io.prismic

SearchForm

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

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:

  1. 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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SearchForm
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val api: Api

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. val form: Form

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. 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

  19. def page(p: Int): SearchForm

  20. def pageSize(p: Int): SearchForm

  21. 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

  22. def query(query: String): SearchForm

  23. def ref(r: String): SearchForm

  24. def ref(r: Ref): SearchForm

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

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

  27. def submit(): Future[Response]

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

    Definition Classes
    AnyRef

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped