Api

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

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

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def bookmarks: Map[String, String]

   

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

9. def experiment: Option[Experiment]

   

   Shortcut to the current running experiment, if any

10. def experiments: Experiments

    

    Experiments exposed by prismic.

    Experiments exposed by prismic.io API

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. def findBy(field: String, value: String, form: String = "everything", ref: Ref = master, page: Int = 1, pageSize: Int = 20): Future[Seq[Document]]

    

    Do an "at" query

    Do an "at" query

    field

    the field to query, for example "my.post.title"

    value

    the value to match

    returns

13. def findById(value: String, form: String = "everything", ref: Ref = master, page: Int = 1, pageSize: Int = 20): Future[Option[Document]]

    

    Retrieve the document with the corresponding id

    Retrieve the document with the corresponding id

    value

    returns

14. def findByIds(values: Seq[String], form: String = "everything", ref: Ref = master, page: Int = 1, pageSize: Int = 20): Future[Seq[Document]]

    

    Search documents from a list of ids

    Search documents from a list of ids

    values

    returns

15. def findByUid(value: String, customType: String, form: String = "everything", ref: Ref = master, page: Int = 1, pageSize: Int = 20): Future[Option[Document]]

    

    Retrieve the document with the corresponding uid

    Retrieve the document with the corresponding uid

    value

    returns

16. def forms: Map[String, SearchForm]

    

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

    

    Definition Classes

    AnyRef → Any

18. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

19. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

20. def master: Ref

    

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

    

    Definition Classes

    AnyRef

22. final def notify(): Unit

    

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

24. def oauthInitiateEndpoint: String

    

25. def oauthTokenEndpoint: String

    

26. def previewSession(token: String, linkResolver: DocumentLinkResolver, defaultUrl: String): Future[String]

    

    Return the URL to display a given preview

    Return the URL to display a given preview

    token

    as received from Prismic server to identify the content to preview

    linkResolver

    the link resolver to build URL for your site

    defaultUrl

    the URL to default to return if the preview doesn't correspond to a document (usually the home page of your site)

    returns

    a Future corresponding to the URL you should redirect the user to preview the requested change

27. def proxy: Option[ProxyServer]

    

28. def refs: Map[String, Ref]

    

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

    

    Definition Classes

    AnyRef

30. def toString(): String

    

    Definition Classes

    AnyRef → Any

31. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )