docs/Response.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Response</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: Response</h1>
<section>
<header>
<h2>Response</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Response"><span class="type-signature"></span>new Response<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Embodies the response of a SearchForm query as returned by the API.
It includes all the fields that are useful for pagination (page, total_pages, total_results_size, ...),
as well as the field "results", which is an array of Document objects, the documents themselves.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">api.js</a>, <a href="api.js.html#line785">line 785</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="next_page"><span class="type-signature"></span>next_page<span class="type-signature"> :string</span></h4>
<div class="description">
The URL of the next page 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="api.js.html">api.js</a>, <a href="api.js.html#line815">line 815</a>
</li></ul></dd>
</dl>
<h4 class="name" id="page"><span class="type-signature"></span>page<span class="type-signature"> :number</span></h4>
<div class="description">
The current page
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">api.js</a>, <a href="api.js.html#line790">line 790</a>
</li></ul></dd>
</dl>
<h4 class="name" id="prev_page"><span class="type-signature"></span>prev_page<span class="type-signature"> :string</span></h4>
<div class="description">
The URL of the previous page 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="api.js.html">api.js</a>, <a href="api.js.html#line820">line 820</a>
</li></ul></dd>
</dl>
<h4 class="name" id="results"><span class="type-signature"></span>results<span class="type-signature"> :Array</span></h4>
<div class="description">
Array of Document for the current page
</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="api.js.html">api.js</a>, <a href="api.js.html#line825">line 825</a>
</li></ul></dd>
</dl>
<h4 class="name" id="results_per_page"><span class="type-signature"></span>results_per_page<span class="type-signature"> :number</span></h4>
<div class="description">
The number of results per page
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">api.js</a>, <a href="api.js.html#line795">line 795</a>
</li></ul></dd>
</dl>
<h4 class="name" id="results_size"><span class="type-signature"></span>results_size<span class="type-signature"> :number</span></h4>
<div class="description">
The size of the current page
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">api.js</a>, <a href="api.js.html#line800">line 800</a>
</li></ul></dd>
</dl>
<h4 class="name" id="total_pages"><span class="type-signature"></span>total_pages<span class="type-signature"> :number</span></h4>
<div class="description">
The total number of pages
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">api.js</a>, <a href="api.js.html#line810">line 810</a>
</li></ul></dd>
</dl>
<h4 class="name" id="total_results_size"><span class="type-signature"></span>total_results_size<span class="type-signature"> :number</span></h4>
<div class="description">
The total size of results across all pages
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api.js.html">api.js</a>, <a href="api.js.html#line805">line 805</a>
</li></ul></dd>
</dl>
</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 Mon Oct 02 2017 12:18:09 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>