prismic.io
Version:
JavaScript development kit for prismic.io
1,270 lines (277 loc) • 14.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Doc</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Doc</h1>
<section>
<header>
<h2>Doc</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Doc"><span class="type-signature"></span>new Doc<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Embodies a document as returned by the API.
Most useful fields: id, type, tags, slug, slugs
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line511">line 511</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="alternateLanguages"><span class="type-signature"></span>alternateLanguages<span class="type-signature"></span></h4>
<div class="description">
The alternate language versions of the document
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line571">line 571</a>
</li></ul></dd>
</dl>
<h4 class="name" id="data"><span class="type-signature"></span>data<span class="type-signature"></span></h4>
<div class="description">
same as fragments
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line550">line 550</a>
</li></ul></dd>
</dl>
<h4 class="name" id="firstPublicationDate"><span class="type-signature"></span>firstPublicationDate<span class="type-signature"></span></h4>
<div class="description">
The first publication date of the document
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line559">line 559</a>
</li></ul></dd>
</dl>
<h4 class="name" id="fragments"><span class="type-signature"></span>fragments<span class="type-signature"></span></h4>
<div class="description">
Fragments, converted to business objects
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line575">line 575</a>
</li></ul></dd>
</dl>
<h4 class="name" id="href"><span class="type-signature"></span>href<span class="type-signature"> :string</span></h4>
<div class="description">
The URL of the document in the API
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line531">line 531</a>
</li></ul></dd>
</dl>
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :string</span></h4>
<div class="description">
The ID of the document
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line516">line 516</a>
</li></ul></dd>
</dl>
<h4 class="name" id="lang"><span class="type-signature"></span>lang<span class="type-signature"></span></h4>
<div class="description">
The language code of the document
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line567">line 567</a>
</li></ul></dd>
</dl>
<h4 class="name" id="lastPublicationDate"><span class="type-signature"></span>lastPublicationDate<span class="type-signature"></span></h4>
<div class="description">
The last publication date of the document
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line563">line 563</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rawJSON"><span class="type-signature"></span>rawJSON<span class="type-signature"></span></h4>
<div class="description">
raw JSON from the API
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line555">line 555</a>
</li></ul></dd>
</dl>
<h4 class="name" id="slug"><span class="type-signature"></span>slug<span class="type-signature"> :string</span></h4>
<div class="description">
The current slug of the document, "-" if none was provided
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line541">line 541</a>
</li></ul></dd>
</dl>
<h4 class="name" id="slugs"><span class="type-signature"></span>slugs<span class="type-signature"> :array</span></h4>
<div class="description">
All the slugs that were ever used by this document (including the current one, at the head)
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line546">line 546</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tags"><span class="type-signature"></span>tags<span class="type-signature"> :array</span></h4>
<div class="description">
The tags of the document
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line536">line 536</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
<div class="description">
The type of the document, corresponds to a document mask defined in the repository
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line526">line 526</a>
</li></ul></dd>
</dl>
<h4 class="name" id="uid"><span class="type-signature"></span>uid<span class="type-signature"> :string|null</span></h4>
<div class="description">
The User ID of the document, a human readable id
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line521">line 521</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getSliceZone"><span class="type-signature"></span>getSliceZone<span class="signature">(name)</span><span class="type-signature"> → {Group}</span></h4>
<div class="description">
Gets the SliceZone fragment in the current Document object, for further manipulation.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The name of the fragment to get, with its type; for instance, "product.gallery"</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="documents.js.html">documents.js</a>, <a href="documents.js.html#line588">line 588</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The SliceZone fragment to manipulate.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Group</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>document.getSliceZone('product.gallery').asHtml(linkResolver).</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Api.html">Api</a></li><li><a href="Doc.html">Doc</a></li><li><a href="Experiments.html">Experiments</a></li><li><a href="Fragments_Color.html">Fragments:Color</a></li><li><a href="Fragments_CompositeSlice.html">Fragments:CompositeSlice</a></li><li><a href="Fragments_Date.html">Fragments:Date</a></li><li><a href="Fragments_DocumentLink.html">Fragments:DocumentLink</a></li><li><a href="Fragments_Embed.html">Fragments:Embed</a></li><li><a href="Fragments_FileLink.html">Fragments:FileLink</a></li><li><a href="Fragments_GeoPoint.html">Fragments:GeoPoint</a></li><li><a href="Fragments_Group.html">Fragments:Group</a></li><li><a href="Fragments_ImageEl.html">Fragments:ImageEl</a></li><li><a href="Fragments_ImageLink.html">Fragments:ImageLink</a></li><li><a href="Fragments_ImageView.html">Fragments:ImageView</a></li><li><a href="Fragments_Num.html">Fragments:Num</a></li><li><a href="Fragments_Select.html">Fragments:Select</a></li><li><a href="Fragments_Separator.html">Fragments:Separator</a></li><li><a href="Fragments_SimpleSlice.html">Fragments:SimpleSlice</a></li><li><a href="Fragments_SliceZone.html">Fragments:SliceZone</a></li><li><a href="Fragments_StructuredText.html">Fragments:StructuredText</a></li><li><a href="Fragments_Text.html">Fragments:Text</a></li><li><a href="Fragments_Timestamp.html">Fragments:Timestamp</a></li><li><a href="Fragments_WebLink.html">Fragments:WebLink</a></li><li><a href="Ref.html">Ref</a></li><li><a href="Response.html">Response</a></li><li><a href="SearchForm.html">SearchForm</a></li><li><a href="WithFragments.html">WithFragments</a></li></ul><h3>Namespaces</h3><ul><li><a href="Predicates.html">Predicates</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ApiCache">ApiCache</a></li><li><a href="global.html#data">data</a></li><li><a href="global.html#fragments">fragments</a></li><li><a href="global.html#insertSpans">insertSpans</a></li><li><a href="global.html#LRUCache">LRUCache</a></li><li><a href="global.html#parseDoc">parseDoc</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Apr 28 2017 17:29:54 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>