zipscene-api-client
Version:
Zipscene API Client
917 lines (638 loc) • 26.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>ZipsceneRPCClient - 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>ZipsceneRPCClient Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_zipscene-rpc-client.js.html#l24"><code>lib/zipscene-rpc-client.js:24</code></a>
</div>
<p>Available since v0.0.1</p>
</div>
<div class="box intro">
<p>This class passes jsonrpc requests to a server. It will authenticate
with a username and password. It will refresh an accessToken
when it expires.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_ZipsceneRPCClient" class="method item">
<h3 class="name"><code>ZipsceneRPCClient</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>settings</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-rpc-client.js.html#l24"><code>lib/zipscene-rpc-client.js:24</code></a>
</p>
<p>Available since v0.0.1</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">settings</code>
<span class="type">Object</span>
<div class="param-description">
<ul>
<li>settings object for authentication and sever set up</li>
</ul>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">server</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the server location to make requests</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">authServer</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the server to authenticate with when different from
the server to make requests on.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">email</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>The email address to authenticate with.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">username</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>Alias for 'email'</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">password</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the password to authenticate with</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">userNamespaceId</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>The user namespace the authenticated user belongs to.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">accessToken</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the accessToken to use to make requests</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">routeVersion</code>
<span class="type">Number</span>
<div class="param-description">
<ul>
<li>Version of RPC endpoint to use</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">logRequests</code>
<span class="type">Boolean</span>
<div class="param-description">
<ul>
<li>If true, log requests and responses to stderr</li>
</ul>
</div>
</li>
</ul>
</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_authenticate">authenticate</a>
</li>
<li class="index-item method">
<a href="#method_createBearerHeader">createBearerHeader</a>
</li>
<li class="index-item method">
<a href="#method_getUrl">getUrl</a>
</li>
<li class="index-item method">
<a href="#method_request">request</a>
</li>
<li class="index-item method">
<a href="#method_requestRaw">requestRaw</a>
</li>
<li class="index-item method">
<a href="#method_requestStream">requestStream</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_authenticate" class="method item">
<h3 class="name"><code>authenticate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>expired</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-rpc-client.js.html#l90"><code>lib/zipscene-rpc-client.js:90</code></a>
</p>
<p>Available since v0.0.1</p>
</div>
<div class="description">
<p>This function tries to set the access token before making requests.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">expired</code>
<span class="type">Boolean</span>
<div class="param-description">
<ul>
<li>If this is called because of an expired access token, set this flag.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method_createBearerHeader" class="method item">
<h3 class="name"><code>createBearerHeader</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>accessToken</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-rpc-client.js.html#l207"><code>lib/zipscene-rpc-client.js:207</code></a>
</p>
<p>Available since v0.0.1</p>
</div>
<div class="description">
<p>This takes the current accessToken and turns it in to the Bearer Authorization token</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">accessToken</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the access token</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getUrl" class="method item">
<h3 class="name"><code>getUrl</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[options={}]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-rpc-client.js.html#l187"><code>lib/zipscene-rpc-client.js:187</code></a>
</p>
<p>Available since v0.0.1</p>
</div>
<div class="description">
<p>Construct the URL to which JSONRPC requests will be placed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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 optional">[auth=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>Returns the auth server URL instead of the main server.</li>
</ul>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method_request" class="method item">
<h3 class="name"><code>request</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>method</code>
</li>
<li class="arg">
<code>params</code>
</li>
<li class="arg">
<code class="optional">[opts]</code>
</li>
<li class="arg">
<code class="optional">[id=requestCounter++]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Promise</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-rpc-client.js.html#l219"><code>lib/zipscene-rpc-client.js:219</code></a>
</p>
<p>Available since v0.0.1</p>
</div>
<div class="description">
<p>Makes a request to the json-rpc service, handling authentication if necessary</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">method</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the api method to call, in dot notation</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">params</code>
<span class="type">Object</span>
<div class="param-description">
<ul>
<li>the params for this api method</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</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 optional">[exHeaders]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>Object containing additional headers to use for the request.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name optional">[maxRetries]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>Number of times to retry the req</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name optional">[noReauth]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>Throw token_expired errors instead of reauthenticating.</li>
</ul>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name optional">[id=requestCounter++]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>the id to use for the request</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Promise</span>:
<ul>
<li>resolves with the response that contains an object { error, result, id }</li>
</ul>
</div>
</div>
</div>
<div id="method_requestRaw" class="method item">
<h3 class="name"><code>requestRaw</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>method</code>
</li>
<li class="arg">
<code>params</code>
</li>
<li class="arg">
<code>opts</code>
</li>
<li class="arg">
<code class="optional">[id=requestCounter++]</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-rpc-client.js.html#l428"><code>lib/zipscene-rpc-client.js:428</code></a>
</p>
</div>
<div class="description">
<p>Make a request to an endpoint that returns streaming data rather than the standard JSONRPC format. Data will
be returned as a plain data stream.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">method</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the api method to call</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">params</code>
<span class="type">Object</span>
<div class="param-description">
<ul>
<li>the params for this api method</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">opts</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[id=requestCounter++]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>the id to use for the request</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Readable</span>:
</div>
</div>
</div>
<div id="method_requestStream" class="method item">
<h3 class="name"><code>requestStream</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>method</code>
</li>
<li class="arg">
<code>params</code>
</li>
<li class="arg">
<code>opts</code>
</li>
<li class="arg">
<code class="optional">[id=requestCounter++]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">zstreams.PassThrough</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_zipscene-rpc-client.js.html#l304"><code>lib/zipscene-rpc-client.js:304</code></a>
</p>
<p>Available since v0.0.1</p>
</div>
<div class="description">
<p>Make a request to an endpoint that returns streaming data rather than the standard JSONRPC format. Data will
be returned as a readable zstream of parsed objects.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">method</code>
<span class="type">String</span>
<div class="param-description">
<ul>
<li>the api method to call</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">params</code>
<span class="type">Object</span>
<div class="param-description">
<ul>
<li>the params for this api method</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">opts</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[id=requestCounter++]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<ul>
<li>the id to use for the request</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">zstreams.PassThrough</span>:
<ul>
<li>returns a passthrough stream that will recieve data
when the request comes back.</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>