zipscene-api-client
Version:
Zipscene API Client
853 lines (581 loc) • 25.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>ZipsceneDataClient - zipscene-api-client</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="zipscene-api-client" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 4.0.6</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/ZipsceneDataClient.html">ZipsceneDataClient</a></li>
<li><a href="../classes/ZipsceneRPCClient.html">ZipsceneRPCClient</a></li>
</ul>
<ul id="api-modules" class="apis modules">
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>ZipsceneDataClient Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_zipscene-data-client.js.html#l8"><code>lib/zipscene-data-client.js:8</code></a>
</div>
</div>
<div class="box intro">
<p>Client for accessing Zipscene DMP profile group data.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_ZipsceneDataClient" class="method item">
<h3 class="name"><code>ZipsceneDataClient</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>rpcClient</code>
</li>
<li class="arg">
<code>profileType</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
<li class="arg">
<code>fileServiceClient</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-data-client.js.html#l8"><code>lib/zipscene-data-client.js:8</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">rpcClient</code>
<span class="type"><a href="../classes/ZipsceneRPCClient.html" class="crosslink">ZipsceneRPCClient</a></span>
<div class="param-description">
<ul>
<li>The DMP RPC client to use</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">profileType</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>Profile type as it appears in method names (ie, "person")</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">fileServiceClient</code>
<span class="type"><a href="../classes/ZipsceneRPCClient.html" class="crosslink">ZipsceneRPCClient</a></span>
<div class="param-description">
<ul>
<li>RPC client for the file service</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_aggregate">aggregate</a>
</li>
<li class="index-item method">
<a href="#method_count">count</a>
</li>
<li class="index-item method">
<a href="#method_export">export</a>
</li>
<li class="index-item method">
<a href="#method_get">get</a>
</li>
<li class="index-item method">
<a href="#method_query">query</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_aggregate" class="method item">
<h3 class="name"><code>aggregate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>query</code>
</li>
<li class="arg">
<code>agg</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Mixed</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-data-client.js.html#l192"><code>lib/zipscene-data-client.js:192</code></a>
</p>
</div>
<div class="description">
<p>Executes one or more aggregates.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">query</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">agg</code>
<span class="type">Object | Object</span>
<div class="param-description">
<ul>
<li>Aggregate spec, or array of aggregate specs</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">sort</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">limit</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">scanLimit</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">timeout</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Mixed</span>:
<ul>
<li>Aggregate results, or array of aggregate results if 'agg' is an array</li>
</ul>
</div>
</div>
</div>
<div id="method_count" class="method item">
<h3 class="name"><code>count</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>query</code>
</li>
<li class="arg">
<code>[options}</code>
</li>
<li class="arg">
<code>options.timeout</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Number</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-data-client.js.html#l176"><code>lib/zipscene-data-client.js:176</code></a>
</p>
</div>
<div class="description">
<p>Executes a count.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">query</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">[options}</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">options.timeout</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Number</span>:
</div>
</div>
</div>
<div id="method_export" class="method item">
<h3 class="name"><code>export</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>query</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Readable</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-data-client.js.html#l64"><code>lib/zipscene-data-client.js:64</code></a>
</p>
</div>
<div class="description">
<p>Exports a DMP data stream.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">query</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">fields</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">sort</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">limit</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">timeout</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">strategy</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>Export strategy, either 'file' to download via file service or 'stream' to stream directly from DMP</li>
</ul>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Readable</span>:
<ul>
<li>A readable object stream</li>
</ul>
</div>
</div>
</div>
<div id="method_get" class="method item">
<h3 class="name"><code>get</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-data-client.js.html#l26"><code>lib/zipscene-data-client.js:26</code></a>
</p>
</div>
<div class="description">
<p>Gets a single object by id.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">fields</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">timeout</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<ul>
<li>The request object</li>
</ul>
</div>
</div>
</div>
<div id="method_query" class="method item">
<h3 class="name"><code>query</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>query</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-data-client.js.html#l43"><code>lib/zipscene-data-client.js:43</code></a>
</p>
</div>
<div class="description">
<p>Executes a query.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">query</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">fields</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">sort</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">skip</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">limit</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">timeout</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
<ul>
<li>Array of results</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>