High-level entry point for communications with prismic.
Error thrown when communicating with prismic.
Error thrown when communicating with prismic.io API
Error thrown when the auth token is omitted, but required
Default HTTP cache implementation, relying on apache in-memory LRUMap (recommended)
Cache prismic.
Cache prismic.io HTTP responses
A prismic.
A prismic.io document
Builds URL specific to an application, based on a generic prismic.
Builds URL specific to an application, based on a generic prismic.io document link.
Experiment exposed by prismic API
Experiment exposed by prismic API
prismic experiment ID
Google experiment ID, empty if experiment is a draft
user set name
list of variations for this experiment
All experiments exposed by prismic API
All experiments exposed by prismic API
experiments in draft stage, i.e. not running, for preview purpose
experiments in running stage, that will be presented to users
A prismic.
A prismic.io document field metadata
Error thrown when the auth token is provided, but invalid
A Prismic predicate.
A Prismic predicate. Examples: Query.at("document.type", "article") Query.dateBefore("document.created", new DateTime().minusMonth(1))
See the helpers in the companion object.
A proxy.
Represent a prismic.
Represent a prismic.io reference, a fixed point in time.
The references must be provided when accessing to any prismic.io resource (except /api) and allow to assert that the URL you use will always returns the same results.
Paginated response to a Prismic.
Paginated response to a Prismic.io query. Note that you may not get all documents in the first page, and may need to retrieve more pages or increase the page size.
A SearchForm represent a Form returned by the prismic.
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.
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
Error that should never happen
Experiment variation exposed by prismic API
Experiment variation exposed by prismic API
technical prismic ID
queryable ref of the variation (similar to release ref)
user set label
Instanciate an Api instance from a prismic.
Instanciate an Api instance from a prismic.io API URL
DocumentLinkResolver builders
Do NOT cache prismic.
Do NOT cache prismic.io HTTP responses
High-level entry point for communications with prismic.io API